Skip to content

Installation

With uv

uv add thunderdots

With pip

pip install thunderdots

Local development with uv

From the repository root:

uv sync --extra dev --extra docs

Or through the Makefile:

make dev.sync

This creates or updates the local .venv managed by uv and installs the project with the development and documentation dependencies.

Editable installation

make dev.install

Equivalent command:

uv pip install -e ".[dev,docs]"

Documentation dependencies

Documentation dependencies are defined in pyproject.toml under the docs optional dependency group:

[project.optional-dependencies]
docs = [
    "mkdocs>=1.6.1",
    "mkdocs-material>=9.5",
    "mkdocs-jupyter>=0.25",
    "jupyter",
    "ipykernel",
]