Set up a development environment¶

This guide sets up SimDB for local development.

Clone and check out¶

git clone https://github.com/iterorganization/SimDB.git
cd SimDB
git checkout develop

develop is the main development branch; open pull requests against it.

Create a virtual environment and install¶

Install SimDB with the dev dependency group, which pulls in everything needed for testing, linting, type checking, and running the server:

python3 -m venv venv --prompt SimDB
source venv/bin/activate
pip install -e . --group dev

Alternatively, use uv to install all dependencies:

uv sync

Verify¶

simdb --version
pytest

Next steps¶

• Run tests, linting, and type checks.

• Run database migrations.

• Build the documentation.