Skip to content

Development Setup

Requires pyenv and uv.

First-Time Setup

# Install Python 3.12 (.python-version pins this)
pyenv install 3.12.12

# Create virtual environment using pyenv's Python
uv venv
source .venv/bin/activate

# Install with dev dependencies
uv pip install -e ".[dev]"

# Optional: required for live ONNX export + classifier smoke tests
uv pip install -e ".[guardian]"

Running Tests

pytest

Coverage is configured automatically via pyproject.toml (--cov=taskrunner --cov=guardian --cov=bridge --cov-report=term-missing).

Building Documentation

# Install docs dependencies
uv pip install -e ".[docs]"

# Serve locally with hot reload
mkdocs serve

# Build static site
mkdocs build

The documentation site will be available at http://localhost:8000 when using mkdocs serve.