Python API reference¶
Browse the API by its location under src/uptimely/. Each package page groups
classes and functions by their defining module, with signatures, parameters,
and return values generated from the Python source.
Package map¶
| Package or module | Reference | Purpose |
|---|---|---|
uptimely.project |
Projects | Load project specs and build or read active build bundles. |
uptimely.spec |
Spec | Load, validate, prepare, and serialize spec definitions. |
uptimely.spec.python |
Python authoring | Declare spec using Python classes and helpers. |
uptimely.spec.feature_graph |
Feature graphs | Inspect dependencies and select feature subgraphs. |
uptimely.spec.validation |
Spec validation | Validate document relationships and handle structured errors. |
uptimely.compiler |
Compiler and plans | Compile spec and read or write portable plans. |
uptimely.engine |
Execution engine | Execute plans with configurable runtime adapters. |
uptimely.explorer |
Analytics Explorer | Generate an analytics website. |
uptimely.row_context |
Row context | Describe row windows passed to analytical functions. |
uptimely.entrypoint |
Python entrypoints | Load Python callables and inspect their signatures. |
uptimely.storage |
Storage | Read local files and S3 objects through a shared interface. |
uptimely.contracts |
Function contracts | Inspect operation types, return kinds, and reference syntax. |
Finding the right interface¶
- Author a spec definition: start with Python authoring or the spec format reference.
- Load or prepare a definition: use the spec operations.
- Compile and run it: use the compiler, then the engine.
- Inspect or publish it: use feature graphs and Explorer.
The pages follow the source layout rather than repeating package-level
re-exports. Public convenience imports such as uptimely.spec.Spec
and uptimely.engine.Engine remain available.
This reference covers public Python interfaces, including exported types, constants, and validation functions. Internal resolution, runtime-state, and rendering helpers are not included. CLI command handlers and MCP server internals are also outside its scope.
For a runnable workflow, see the repository examples. The architecture overview explains how the packages fit together.