README.md

Minimal Python Boilerplate

This boilerplate project contains the following setup ready for you to go.

• package/environment management
  • rye
• linting & formatting
  • ruff (triggered by rye)
• testing framework
  • pytest (triggered by rye)
  • see tests directory
• type checking
  • mypy
• pre-commit hooks
• GitHub Actions workflow in .github/workflows

This boilerplate prefers a src layout over a flat layout.

Setup

1. Clone this repo
2. Make sure to install Rye
3. In your project directory run
   1. rye sync
   2. pre-commit install
   3. Optionally run pre-commit run --all-files (this will be triggered automatically on each commit)
4. On each git commit the code validation packages will be run before the actual commit.
5. GitHub Action workflows will be triggered on push and pull_request events.
6. Explore the setup in the folder structure of this package.
7. Profit.