Installation#
CaptureGraph is a monorepo and is not published to PyPI. It is a uv workspace: one uv sync from a clone creates the environment and installs every Python package editable.
Requirements#
- uv (manages Python 3.12.4+ for you)
- git
Clone and Sync#
This installs every workspace package into .venv:
| Package | What it's for |
|---|---|
capturegraph-lib |
The authoring and analysis surface under one import, capturegraph as cg: the schema types, the procedure recorder, cg.load for reading captured data back, and the scratch that caches analysis. |
capturegraph-ui |
Pages built from components, capturegraph_ui as cgui (Pages) |
capturegraph-recipes |
Reconstruction and scheduling recipes, capturegraph_recipes as cgr (Recipes) |
capturegraph-server |
Hosting shared targets for multi-user capture (Running a Server) |
capturegraph-sync |
Downloading captured data from a server (Syncing Data) |
Only the library is required for the single-user workflow in this section — captured data comes off the phone as plain files.
Verify the install:
Optional: Graphviz rendering
procedure_to_graphviz renders a procedure DAG as a diagram. It needs the optional graphviz extra (plus the Graphviz system package for rendering). The extra is declared by capturegraph-lib, not the workspace root, so it installs through the all-packages form:
Contributing#
Running a package's tests or building these docs needs the contributor
install, uv sync --all-packages, which the repository README's
Development section covers.
Next#
Continue to The iOS App to build the capture app.