We welcome contributions to the project. Please follow the guidelines below.
We use uv to manage the development environment.
Setup a virtual environment (once):
uv syncUse pytest to run the unit checks:
uv run pytest .and
uv run --resolution lowest-direct pytest .to test against the lower bounds of dependencies.
We use ruff to lint the code. Run the following command to check the code:
uv run ruff check . --fix --show-fixesWe use ty to statically type check the code.
uv run ty check src/ tests/ examples/Recommended before creating a commit: to run all checks against all files,
run the following command with prek:
uv run prek -a .To build the documentation, run the following command:
uv run sphinx-build -M html ./docs ./docs/_build -W --keep-goingfor s in examples/*.py; do uv run $s; done