Environment Setup

With VSCode Devcontainers

To help aid in environment setup, we’ve created a VS Code devcontainer for quick, isolated, and standardized environment creation.

Prerequisites

Setup

  1. Ensure docker engine is running
  2. Open VSCode in cloned project directory
  3. Install VSCode Dev Containers extension
  4. Open the current folder in dev container

Without Devcontainers

Prerequisites

Setup

  1. Open repository in ide of choice
  2. Run uv sync --all-groups --frozen from command line
  3. Activate the virtual environment via source .venv/bin/activate
  4. Run pre-commit install to install pre-commit hooks

Project & Package Dependency Management

We use uv for dependency & project management. See uv docs for details.

Back to top