Development¶

This guide provides instructions for setting up your development environment to contribute to Graphinate.

Install dependencies¶

Use UV to install all dependencies, including those for testing and documentation.

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

To update the locked dependencies to their latest versions:

uv lock --upgrade
uv sync --all-extras --all-groups

We use Ruff for linting and formatting.

1	`ruff check src`

ruff check src --fix

We use pytest for testing.

python -m pytest tests --cov=src --cov-branch --doctest-modules --cov-report=xml --junitxml=junit.xml

python -m pytest tests --cov=src --cov-branch --doctest-modules --cov-report=html --junitxml=junit.xml

This is the recommended command for local development, as it provides the fastest feedback.

python -m pytest tests --cov=src --cov-branch --doctest-modules --cov-report=term --junitxml=junit.xml

The documentation is built using MkDocs with the Material for MkDocs theme.

To serve the documentation locally for testing:

python -m mkdocs serve

To build the static documentation site:

python -m mkdocs build