Analytics Explorer¶
uptimely.explorer generates documentation and visualizations of spec.
These outputs describe an analytics project, not this Python API reference.
explorer¶
uptimely.explorer.explorer provides the website renderer.
Explorer.create_html generates the complete static website with spec, feature
graph, and execution plan pages. Individual HTML report exports are not
supported.
This is a low-level renderer: it does not create or validate the managed
_generated/build/ bundle. Use uptimely project build for the project
workflow consumed by the Engine, Explorer server, feature-graph CLI, and MCP.
Pass an existing ExecutionPlan to Explorer(spec_definition, plan=plan) to
render that plan without recompilation. The plan is required. Use the optional
features argument to identify selected output features, or omit it for an
all-features plan. Spec pages always describe the complete model; plan and
execution pages describe only the supplied plan. Supply a plan built from the
same spec document; the Explorer does not verify their correspondence.
Spec-definition and portable-plan JSON exports remain available through their respective spec and compiler APIs; the explorer writes HTML only.
Build an analytics explorer website.
Generate a linked spec, plan, and data-lineage website.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
spec_definition
|
Spec
|
Spec document for model and feature pages. |
required |
plan
|
ExecutionPlan
|
Existing plan for plan and lineage pages. Supply a plan built from the same spec document. |
required |
features
|
list[str] | None
|
Selected output features in the plan, or |
None
|
create_html(output_path: str | Path | None = None, include_generated_at: bool = False) -> pathlib.Path
Export the complete static website with navigation between its pages.
The supplied plan is rendered without recompilation. Individual HTML report and subset-graph exports are not supported.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
output_path
|
str | Path | None
|
Index file; defaults to |
None
|
include_generated_at
|
bool
|
Include a timestamp on the spec page. |
False
|
Returns:
| Type | Description |
|---|---|
Path
|
The path to the website index. |
graph_render¶
uptimely.explorer.graph_render defines the visual style of rendered graphs.
For dependency analysis, see feature graphs.
Render feature dependency graphs for the explorer website.
dataclass
¶
Visual appearance settings for the dependency graph.
class-attribute
instance-attribute
¶
function_colors: dict[str, str] = dataclasses.field(default_factory=lambda: {'read': '#4c78a8', 'escape': '#a78bfa', 'vectorize': '#f58518', 'collapse': '#e45756', 'conform': '#72b7b2', 'expand': '#b279a2', 'write': '#ff9da6'})