Development workflow

This page covers a minimal local workflow for developing srvar-toolkit.

Install (editable + dev tools)

From the repository root:

python -m pip install -e ".[dev,cli,fred,docs,plot]"

Run tests

pytest

Lint and format

Check lint:

ruff check srvar tests scripts

Auto-fix import sorting + simple issues:

ruff check --fix srvar tests scripts

Format code:

black srvar tests

The docs pick up the package release from srvar.__version__, so version bumps should update both package metadata and the documentation surfaces that mention the current release.

Type checking (optional)

mypy srvar

Build docs locally

sphinx-build -b html docs docs/_build/html