Contributing

Setup

The project uses uv, but feel free to install or setup the required packages using plain pip or whatever you prefer.

Install the dependencies using

uv sync

and run the tests using

uv run pytest

The project also uses ruff as a linter and formatter, so you may use

uv run ruff check

to run automated checks and

uv run ruff format

to automatically format your code. Both of these steps will run automatically in GitHub actions on every PR.