Skip to main content

Official Python client for the Hotdata API

Project description

hotdata

Official Python client for the Hotdata HTTP API: workspaces, connections, datasets, SQL queries, results, secrets, uploads, indexes, jobs, embedding providers, and workspace context.

Requirements

Python 3.9+

Install

pip install hotdata

For an unreleased revision:

pip install "git+https://github.com/hotdata-dev/sdk-python.git"

From a local checkout (editable):

pip install -e .

Authentication

The API uses an API key sent as Authorization: Bearer <key>, plus an X-Workspace-Id header on requests scoped to a workspace.

import hotdata

configuration = hotdata.Configuration(
    api_key="YOUR_API_KEY",
    workspace_id="YOUR_WORKSPACE_ID",
)

host defaults to https://api.hotdata.dev. Override it if you target another environment.

Usage

import hotdata
from hotdata.rest import ApiException

configuration = hotdata.Configuration(
    api_key="YOUR_API_KEY",
    workspace_id="YOUR_WORKSPACE_ID",
)

with hotdata.ApiClient(configuration) as api_client:
    workspaces = hotdata.WorkspacesApi(api_client)
    try:
        response = workspaces.list_workspaces()
    except ApiException as e:
        print(f"API error: {e.status} {e.reason}\n{e.body}")

Each Api class groups endpoints by resource. Construct the client, then call the typed methods you need.

API reference

Generated Markdown for every operation and model is in docs/:

  • Resource APIs: docs/*Api.md (for example QueryApi.md)
  • Request and response models: docs/<ModelName>.md

Support

Questions and issues: github.com/hotdata-dev/sdk-python.

Project details


Download files

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

Source Distribution

hotdata-0.1.0.tar.gz (97.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-0.1.0-py3-none-any.whl (242.4 kB view details)

Uploaded Python 3

File details

Details for the file hotdata-0.1.0.tar.gz.

File metadata

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

File hashes

Hashes for hotdata-0.1.0.tar.gz
Algorithm Hash digest
SHA256 6795ff7381fb8f2f258ee3f0c31f9b1ba2f5908728c51fa399840fdf603acc46
MD5 d1c3df28c3f4927b85faba1d96dc8665
BLAKE2b-256 63a27e997581dc23fca35330c355cd433135c4d18cc5506fb77fb35fd0180e97

See more details on using hashes here.

Provenance

The following attestation bundles were made for hotdata-0.1.0.tar.gz:

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

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-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: hotdata-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 242.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for hotdata-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 304f46d7c7ed5b586a9102684ef42e45972955dfb66a492c5e0b016e8bc545fa
MD5 b69d78bc6d67c59d2eb338057250380a
BLAKE2b-256 3f21e04ca377e7e3db50215bf207867ef02a56af11f61022390b7689e6ff2db3

See more details on using hashes here.

Provenance

The following attestation bundles were made for hotdata-0.1.0-py3-none-any.whl:

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

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 Pingdom Monitoring Sentry Error logging StatusPage Status page