Reference¶
Lookup material, generated from the code wherever possible. To learn by doing, start with the tutorial; to understand why, start with What a module is.
| Reference | Contents |
|---|---|
Python API (sandloom.sdk) |
every public module and name with its exact signature, beginner names first (generated) |
Driver kit (sandloom.driverkit) |
the API for driver packages; modules never import it |
| Error catalogue | every SANDLOOM-* code: what happened, the fix, its status (generated; also sandloom explain <code>) |
| Testing | the sandloom.sdk.testing kit, the fixtures and the harness rules (copy-paste) |
| CLI | every sandloom command |
| Operator reference | incident tools, flags, dry runs and production confirmation |
| Configuration | every environment variable, generated from the settings model |
| Configuration tiers | which settings change a guarantee, per profile (generated) |
| Routes | every platform route and its resolved policy (generated) |
| Event contracts | channel naming, the schema registry, validation, evolution |
| Security model | authentication, tenant isolation, idempotency, audit, secrets, the production profile |
| Guarantees & capabilities | the ledger: every guarantee with the tests that enforce it, and the recorded gaps (generated) |
| Execution planner | declared read operations and the planner |
| SLOs | SLIs from the shipped metrics, example SLOs and an error-budget template |
| Dependency stack | the libraries Sandloom builds on |
| Standard modules | identity, tenancy and billing: routes, events, contracts |
Regenerate the committed generated pages (sdk/ and the error catalogue)
with uv run python tools/docs/docs_reference.py; the docs
build fails while they are stale.