Skip to main content

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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hotdata_framework-0.12.0.tar.gz (121.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hotdata_framework-0.12.0-py3-none-any.whl (22.2 kB view details)

Uploaded Python 3

File details

Details for the file hotdata_framework-0.12.0.tar.gz.

File metadata

  • Download URL: hotdata_framework-0.12.0.tar.gz
  • Upload date:
  • Size: 121.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for hotdata_framework-0.12.0.tar.gz
Algorithm Hash digest
SHA256 c6a099b6b897434423fc2eef5f8f26f428c17b67243083c71c57045e554445a7
MD5 1f907cf0c966f715d88dc77c03be852d
BLAKE2b-256 5a9412eadbb2a9b946aad21896cc0c1cebd1185c046b58b7e528575853fbef4d

See more details on using hashes here.

Provenance

The following attestation bundles were made for hotdata_framework-0.12.0.tar.gz:

Publisher: publish.yml on hotdata-dev/sdk-python-framework

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file hotdata_framework-0.12.0-py3-none-any.whl.

File metadata

File hashes

Hashes for hotdata_framework-0.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d7ffaf68dc58a3843068c5e2901415b1b18eeb1ed4662de6b8bc5fe373a93226
MD5 66fb3951175ca396ad5bfb1b4d0931ea
BLAKE2b-256 ac81ee5fe860a9fbac322a7d57867b386ab8afc15e66c3675127ebcd02589e6f

See more details on using hashes here.

Provenance

The following attestation bundles were made for hotdata_framework-0.12.0-py3-none-any.whl:

Publisher: publish.yml on hotdata-dev/sdk-python-framework

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page