QUICKSTART.md

Quickstart

Clean up this directory

• Environment bootstrapping now lives in bin/setup-env.sh.
• Poetry is configured to create the virtual environment in .venv/.
• Python runtime selection is pinned in .python-version.

Prerequisites

• python3
• network access for Python package downloads

Set up the development environment

Run:

./bin/setup-env.sh

The script will:

1. install uv and poetry into ~/.local/bin if needed
2. install Python 3.9
3. create a project-local Poetry environment in .venv
4. install the project dependencies

Use the environment

Activate the environment:

source .venv/bin/activate

Run tests:

.venv/bin/pytest tests/

Build docs:

poetry run make docs

Notes

• The original dependency URLs for formasaurus and rethinkdb are no longer usable, so the project now installs from public package sources.
• The project currently installs and runs against Python 3.9 for reproducible setup on current machines.