README.md

python-project-template

Quick starting point for a respectable Python project.

Roadmap

• Package management
• Directory structure
• Code formatting
• Code linting
• Commit hooks
• Settings management
• Testing
• Structured logging
• Minimal asyncio entrypoint

Quick start

Setup

1. Use pyenv to install and activate the latest Python 3.10.
2. Install poetry: pipx install poetry (for other options consult the documentation).
3. In the repository root execute poetry env use 3.10 && poetry install

Run the app

./run.sh

Run the tests

./test.sh

Run the linters

./lint.sh

What's inside?

• Package management using either poetry or pipenv.
• Settings management using dynaconf.
• Structured logging using structlog.
• Code formatting using Black.
• Code linting using Flake8.
• Testing using pytest.