diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ae8554d --- /dev/null +++ b/.gitignore @@ -0,0 +1,10 @@ +# python generated files +__pycache__/ +*.py[oc] +build/ +dist/ +wheels/ +*.egg-info + +# venv +.venv diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..acc6ced --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,15 @@ +fail_fast: true + +repos: + - repo: https://github.com/ambv/black + rev: 22.10.0 + hooks: + - id: black + - repo: https://gitlab.com/pycqa/flake8 + rev: 3.9.2 + hooks: + - id: flake8 + - repo: https://github.com/timothycrosley/isort + rev: 5.10.1 + hooks: + - id: isort diff --git a/.python-version b/.python-version new file mode 100644 index 0000000..09dcc78 --- /dev/null +++ b/.python-version @@ -0,0 +1 @@ +3.10.11 diff --git a/README.md b/README.md new file mode 100644 index 0000000..5efed88 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# Project Name + +Short project description + +## Table of Contents + +- [Introduction](#introduction) +- [Features](#features) +- [Installation](#installation) +- [Usage](#usage) +- [Contributing](#contributing) +- [License](#license) + +## Introduction + +Provide an introduction to your project here. Explain what it does and why it's useful. + +## Features + +List the main features and functionalities of your project. + +## Installation + +Provide instructions on how to install and set up your project. Include any dependencies and installation steps required. + +## Usage + +Provide examples and explanations on how to use your project. Include code snippets or detailed instructions to help users get started. + diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..1d8b2d1 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,32 @@ +[project] +name = "exectime" +version = "0.1.0" +description = "Add a short description here" +authors = [ + { name = "hglong16", email = "intihad.vuong@gmail.com" } +] +dependencies = [] +readme = "README.md" +requires-python = ">= 3.8" + +[build-system] +requires = ["hatchling"] +build-backend = "hatchling.build" + +[tool.rye] +managed = true +dev-dependencies = ["pytest~=7.3.1", "black~=23.3.0", "isort~=5.12.0"] +[tool.hatch.metadata] +allow-direct-references = true + +[tool.flake8] +max-line-length = 75 +extend-ignore = ["D203", "E203", "E251", "E266", "E302", "E305", "E401", "E402", "E501", "F401", "F403", "W503"] +exclude = [".git", "__pycache__", "dist"] +max-complexity = 10 + +[tool.isort] +atomic = true +profile = "black" +line_length = 75 +skip_gitignore = true diff --git a/requirements-dev.lock b/requirements-dev.lock new file mode 100644 index 0000000..19065bc --- /dev/null +++ b/requirements-dev.lock @@ -0,0 +1,21 @@ +# generated by rye +# use `rye lock` or `rye sync` to update this lockfile +# +# last locked with the following flags: +# pre: false +# features: [] +# all-features: false + +-e file:. +black==23.3.0 +click==8.1.3 +exceptiongroup==1.1.1 +iniconfig==2.0.0 +isort==5.12.0 +mypy-extensions==1.0.0 +packaging==23.1 +pathspec==0.11.1 +platformdirs==3.5.1 +pluggy==1.0.0 +pytest==7.3.1 +tomli==2.0.1 diff --git a/requirements.lock b/requirements.lock new file mode 100644 index 0000000..aa6be96 --- /dev/null +++ b/requirements.lock @@ -0,0 +1,9 @@ +# generated by rye +# use `rye lock` or `rye sync` to update this lockfile +# +# last locked with the following flags: +# pre: false +# features: [] +# all-features: false + +-e file:. diff --git a/src/exectime/__init__.py b/src/exectime/__init__.py new file mode 100644 index 0000000..43a9d76 --- /dev/null +++ b/src/exectime/__init__.py @@ -0,0 +1,2 @@ +def hello(): + return "Hello from exectime!"