Bailo Python Client Documentation
Bailo Python Client documentation. Full Python client documentation: Bailo Python Docs.
Table of Contents
Building Locally
Note
Requires: Python (version in .python-version, installed automatically by uv), uv, Docker or Pandoc
The following steps are only required for users who wish to extend or develop the documentation package locally.
Docker
The docs are built and served as part of the backend docker image.
Manual
Python Setup
From within the backend/docs directory:
uv sync --group dev
uv pip install ../../lib/python
This creates a .venv and installs the pinned dependencies from uv.lock. Prefix commands with
uv run to use it, or activate it with source .venv/bin/activate.
pyproject.toml declares minimum versions only (>=, no upper caps) and uv.lock pins the exact versions. Dependabot
only raises PRs for security advisories. Routine upgrades are manual with uv lock --upgrade-package <name>.
Building
Run either uv run make html (Linux & Mac) or make.bat (Windows). This will build the docs in the backend directory by default.
Notebook Formatting
Notebook files are automatically normalised on commit via a pre-commit hook using ruff. This ensures source fields use the canonical array-of-lines format, as well as maintaining consistent styling with lib/python.