python-project-template

This project serves as a basic Poetry based Python 3.11 project.

Included:

• tox configuration
  • pytest with pytest-cov
  • mypy
  • ruff
  • isort
  • black
  • Using tox-poetry to install dependencies via Poetry
• Linter configuration
  • Line length set to 100 characters
  • flake8 config just to be sure (setup.cfg)
  • isort profile set to "black"
• Sample app/ folder with tests/
• pre-commit config
• EditorConfig
• Coverage config
• .gitignore for common Python related clutter

How to start working on a project

• Install Poetry: pip3 install --user poetry
• (Optional) install pre-commit: pip3 install --user pre-commit
• Jump in the project folder
• Enter Poetry shell: poetry shell
• Install dependencies: poetry install
• Run tox: tox (or tox -p for parallel)
• Install pre-commit hooks: pre-commit install