Python template

Summary

A template Python repo with docker, linting & CI.

To copy this simply press the "Use this template" green button near the top of the repo.

Changes required copying

• Pin the dependencies in pyproject.toml to a specific version
• Update the tool.poetry section of in pyproject.toml to be relevant to your project
• Run make lock to lock poetry dependencies and export to a requirements.txt file
• Rename _.github/ to .github so that CI runs

Changes to consider after copying

• Update the LICENSE file
• Update the schedule of the dependabot config
• Add a static type checker, such as mypy or Pyright
• Delete .dockerignore](.dockerignore), [docker-compose.yml` and the build step of CI if you do not plan to use docker.

Contributing

Run make from the project root to both install this project's dependencies & install the pre-commit hooks.

• This requires both make & poetry to be installed.

Other make targets

• make lint will run the pre-commit linting against all files in the repository
• make lock wil relock project dependencies and update the requirements.txt file with production dependencies