Development & Documentation

Requirements

• Python 3.8+
• Poetry
• MkDocs (for documentation)

Setup

# Install dependencies
poetry install

# (Optional) Activate the poetry shell
poetry shell

Running Tests

poetry run pytest

Building & Serving Documentation

# Serve docs locally with MkDocs
poetry run mkdocs serve
# Then open http://127.0.0.1:8000 in your browser