This repository provides a minimal yet opinionated starting point for Python projects. It bundles common development tools and a GitHub Actions workflow so you can focus on writing code rather than configuring your environment.
- Poetry for dependency management
- Ruff for formatting and linting
- Pyright for static type checking
- Pytest for unit tests
- Wily for complexity metrics
- GitHub Actions for CI (lint, tests and complexity analysis)
- Makefile with handy developer commands
-
Initialize the project by running the helper script which replaces placeholder names with your project name:
./scripts/init_repo.sh
The script infers the project name from the repository directory and updates files such as
pyproject.toml, the package directory and tests accordingly. -
Install dependencies:
poetry install
-
Run code checks (formatting, linting and type checking):
make check
-
Execute tests:
make test
- Format code:
make format - Run linter:
make lint - Auto-fix lint issues:
make lint-fix - Type check:
make typecheck - Watch tests:
make watch - Show all commands:
make help
The included GitHub Actions workflow runs linting, type checks, unit tests and complexity analysis for every push and pull request.