Skip to main content

hotdata-framework

A Python framework for building Hotdata integrations.

Shared runtime primitives for Hotdata integrations: workspace/session 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, HOTDATA_WORKSPACE, and HOTDATA_SANDBOX.
  • Workspace resolution — choose an explicit workspace from env, otherwise discover workspaces and select the active workspace or first available workspace.
  • Sandbox/session propagation — pass sandbox session context through the SDK via X-Session-Id.
  • HTTP resilience — configure SDK retries for transient connection failures and retry SQL execution on stale pooled sockets.
  • 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.10.0.tar.gz (111.7 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.10.0-py3-none-any.whl (20.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hotdata_framework-0.10.0.tar.gz
  • Upload date:
  • Size: 111.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for hotdata_framework-0.10.0.tar.gz
Algorithm Hash digest
SHA256 1163118b1479e9c598b9082705b52e4f52af37938767388b0aed2bde9b0fc853
MD5 6780b205571a9c1fdc5036c7f29ae77c
BLAKE2b-256 a9dd65d3aa0e44115e16d13354a54b784764b928c108368dcaf5b8870ff6034a

See more details on using hashes here.

Provenance

The following attestation bundles were made for hotdata_framework-0.10.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.10.0-py3-none-any.whl.

File metadata

File hashes

Hashes for hotdata_framework-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 24f85d671c379977512822a9bfab86dc35d37af5275f9c9a3294fc2aa4af0978
MD5 8bdbc477951c2eda67e72811800cf25f
BLAKE2b-256 ea842050989a595278e945fbc63cf408f2a47ec0803e5072b056f76817533251

See more details on using hashes here.

Provenance

The following attestation bundles were made for hotdata_framework-0.10.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