Skip to content

README.md

Latest commit

 

History

History
41 lines (29 loc) · 2.11 KB

README.md

File metadata and controls

41 lines (29 loc) · 2.11 KB
Raw

hotdata-framework

A Python framework for building Hotdata integrations.

Shared runtime primitives for Hotdata integrations: workspace semantics, execution context, query state, run history, and replayable result handles. Framework packages (Marimo, Jupyter, Streamlit, LangGraph) depend on this package.

Runtime boundary and guarantees are defined in CONTRACT.md.

Features

  • Environment-driven client setup — create clients from HOTDATA_API_KEY, optional HOTDATA_API_URL, and HOTDATA_WORKSPACE.
  • Workspace resolution — choose an explicit workspace from env, otherwise discover workspaces and select the active workspace or first available workspace.
  • HTTP resilience — retry SQL execution on stale pooled sockets. Transport-level retries are the SDK's own default, which this package leaves in place so a non-idempotent request is never replayed on a response status.
  • SQL execution helper — run SQL through POST /v1/query, poll async query runs when needed, and return a QueryResult.
  • Result utilities — convert query results to records, pandas DataFrames, or metadata dictionaries for adapter display layers.
  • History helpers — list recent results and query run history with normalized dataclasses.
  • Managed databases — create Hotdata-owned catalogs, declare tables, upload parquet, and load managed tables (mirrors hotdata databases in the CLI).
  • Indexes — build BM25, vector, or sorted indexes on managed tables, mirroring hotdata indexes create (managed databases only). Waits on the background build job and surfaces its failure, instead of reporting the phantom success the submit call returns.
  • Health helpers — build compact API/workspace health summaries for UI integrations.

Install:

uv pip install hotdata-framework
# or: pip install hotdata-framework

Example:

python examples/basic_usage.py

Development (uses uv; creates .venv/ in this repo):

uv sync --locked
uv run pytest

uv.lock is checked in so CI can run uv sync --locked. The default dev group (pytest) is enabled via [tool.uv] default-groups.