Contributing

Formatting and linting

The easiest way to run the formatting and linting is to use the pre-commit tool. Install it, then run:

pre-commit run --all

This will run formatting and linting on all files in the repository (principally using ruff).

To install as a pre-commit hook:

pre-commit install

The pyproject.toml follows the PEP621 standard. To install all dependencies for local development you may use uv:

uv sync --all-groups --all-extras

A Makefile exits to execute common tasks:

make docs-html
make docs-linkcheck
make format
make lint
make test
make test-matrix

The test matrix is executed using nox and runs all tests in all supported Python versions. The Python versions must be pre-installed on your system.