Contributing

Setup

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

Install the dependencies using

rye sync

and run the tests using

pytest

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

ruff check

to run automated checks and

ruff format

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