KiLJ4EdeN / python-template

python project template using pyproject toml

python-template

python project template

install

for pylance to work with poetry

poetry config virtualenvs.in-project true

make install

dist

make build

bump

# or major or minor or patch
make bump-prerelease

flake8

make lint-flake8

black

make lint-black

mypy

make lint-mypy

pre-commit

make pre-commit

documentation

make create-doc

code cov

make create-cov

pytest

make test

run app

make start

refer to:

localhost:5000

localhost:5000/cov/ for code coverage report

localhost:5000/docs/ for documentation

docker

make docker-build
make docker-up
make docker-down

structure

├── python_template
│   ├── app.py
│   └── __init__.py
├── tests
│   ├── __init__.py
│   ├── test_app.py
│   └── test_version.py
├── LICENSE
├── Makefile
├── MANIFEST.in
├── mkdocs.yml
├── poetry.lock
├── pyproject.toml
├── README.md
├── requirements.txt
└── docs
    ├── explanation.md
    ├── how-to-guides.md
    ├── index.md
    ├── reference.md
    └── tutorials.md