hotdata 0.0.1__tar.gz → 0.2.0__tar.gz

hotdata-0.2.0/PKG-INFO

@@ -0,0 +1,119 @@
+Metadata-Version: 2.4
+Name: hotdata
+Version: 0.2.0
+Summary: Hotdata API
+Author-email: Hotdata <developers@hotdata.dev>
+License: MIT
+Project-URL: Homepage, https://www.hotdata.dev
+Project-URL: Repository, https://github.com/hotdata-dev/sdk-python
+Keywords: hotdata,api-client,data-platform
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: urllib3<3.0.0,>=2.1.0
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: pydantic>=2
+Requires-Dist: typing-extensions>=4.7.1
+Provides-Extra: arrow
+Requires-Dist: pyarrow>=14; extra == "arrow"
+
+# hotdata
+
+Official Python client for the [Hotdata](https://www.hotdata.dev) HTTP API: workspaces, connections, datasets, SQL queries, results, secrets, uploads, indexes, jobs, embedding providers, and workspace context.
+
+## Requirements
+
+Python 3.9+
+
+## Install
+
+```sh
+pip install hotdata
+```
+
+For an unreleased revision:
+
+```sh
+pip install "git+https://github.com/hotdata-dev/sdk-python.git"
+```
+
+From a local checkout (editable):
+
+```sh
+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.
+
+```python
+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
+
+```python
+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.
+
+## Arrow results
+
+Query results can be fetched as an [Apache Arrow](https://arrow.apache.org/) IPC stream instead of JSON, which is faster and far more memory-efficient for large result sets. Install the optional extra:
+
+```sh
+pip install 'hotdata[arrow]'
+```
+
+Use `hotdata.arrow.ResultsApi` (a drop-in subclass of `ResultsApi` that adds Arrow methods):
+
+```python
+from hotdata import ApiClient, Configuration
+from hotdata.arrow import ResultsApi
+
+with ApiClient(Configuration(api_key="...", workspace_id="...")) as client:
+    results = ResultsApi(client)
+
+    # Buffered: returns a pyarrow.Table.
+    table = results.get_result_arrow(result_id)
+
+    # Streaming: yields a pyarrow.RecordBatchStreamReader without
+    # materializing the full table in memory.
+    with results.stream_result_arrow(result_id) as reader:
+        for batch in reader:
+            ...
+```
+
+Both methods accept `offset` and `limit` for pagination. They raise `hotdata.arrow.ResultNotReadyError` if the result is still pending or processing — poll `results.get_result(result_id)` until `status == "ready"` first.
+
+## API reference
+
+Generated Markdown for every operation and model is in [`docs/`](https://github.com/hotdata-dev/sdk-python/tree/main/docs):
+
+- Resource APIs: `docs/*Api.md` (for example [`QueryApi.md`](https://github.com/hotdata-dev/sdk-python/blob/main/docs/QueryApi.md))
+- Request and response models: `docs/<ModelName>.md`
+
+## Support
+
+Questions and issues: [github.com/hotdata-dev/sdk-python](https://github.com/hotdata-dev/sdk-python).

hotdata-0.2.0/README.md

@@ -0,0 +1,101 @@
+# hotdata
+
+Official Python client for the [Hotdata](https://www.hotdata.dev) HTTP API: workspaces, connections, datasets, SQL queries, results, secrets, uploads, indexes, jobs, embedding providers, and workspace context.
+
+## Requirements
+
+Python 3.9+
+
+## Install
+
+```sh
+pip install hotdata
+```
+
+For an unreleased revision:
+
+```sh
+pip install "git+https://github.com/hotdata-dev/sdk-python.git"
+```
+
+From a local checkout (editable):
+
+```sh
+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.
+
+```python
+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
+
+```python
+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.
+
+## Arrow results
+
+Query results can be fetched as an [Apache Arrow](https://arrow.apache.org/) IPC stream instead of JSON, which is faster and far more memory-efficient for large result sets. Install the optional extra:
+
+```sh
+pip install 'hotdata[arrow]'
+```
+
+Use `hotdata.arrow.ResultsApi` (a drop-in subclass of `ResultsApi` that adds Arrow methods):
+
+```python
+from hotdata import ApiClient, Configuration
+from hotdata.arrow import ResultsApi
+
+with ApiClient(Configuration(api_key="...", workspace_id="...")) as client:
+    results = ResultsApi(client)
+
+    # Buffered: returns a pyarrow.Table.
+    table = results.get_result_arrow(result_id)
+
+    # Streaming: yields a pyarrow.RecordBatchStreamReader without
+    # materializing the full table in memory.
+    with results.stream_result_arrow(result_id) as reader:
+        for batch in reader:
+            ...
+```
+
+Both methods accept `offset` and `limit` for pagination. They raise `hotdata.arrow.ResultNotReadyError` if the result is still pending or processing — poll `results.get_result(result_id)` until `status == "ready"` first.
+
+## API reference
+
+Generated Markdown for every operation and model is in [`docs/`](https://github.com/hotdata-dev/sdk-python/tree/main/docs):
+
+- Resource APIs: `docs/*Api.md` (for example [`QueryApi.md`](https://github.com/hotdata-dev/sdk-python/blob/main/docs/QueryApi.md))
+- Request and response models: `docs/<ModelName>.md`
+
+## Support
+
+Questions and issues: [github.com/hotdata-dev/sdk-python](https://github.com/hotdata-dev/sdk-python).

{hotdata-0.0.1 → hotdata-0.2.0}/hotdata/__init__.py

@@ -35,6 +35,7 @@ __all__ = [
     "QueryRunsApi",
     "RefreshApi",
     "ResultsApi",
+    "SandboxesApi",
     "SavedQueriesApi",
     "SecretsApi",
     "UploadsApi",
@@ -77,14 +78,21 @@ __all__ = [
     "CreateEmbeddingProviderRequest",
     "CreateEmbeddingProviderResponse",
     "CreateIndexRequest",
+    "CreateSandboxRequest",
     "CreateSavedQueryRequest",
     "CreateSecretRequest",
     "CreateSecretResponse",
     "CreateWorkspaceRequest",
     "CreateWorkspaceResponse",
     "DatasetSource",
+    "DatasetSourceOneOf",
+    "DatasetSourceOneOf1",
+    "DatasetSourceOneOf2",
+    "DatasetSourceOneOf3",
+    "DatasetSourceOneOf4",
     "DatasetSummary",
     "DatasetVersionSummary",
+    "DeleteSandboxResponse",
     "DiscoveryStatus",
     "EmbeddingProviderResponse",
     "Error",
@@ -112,12 +120,15 @@ __all__ = [
     "ListJobsResponse",
     "ListQueryRunsResponse",
     "ListResultsResponse",
+    "ListSandboxesResponse",
     "ListSavedQueriesResponse",
     "ListSavedQueryVersionsResponse",
     "ListSecretsResponse",
     "ListUploadsResponse",
     "ListWorkspaceContextsResponse",
     "ListWorkspacesResponse",
+    "LoadManagedTableRequest",
+    "LoadManagedTableResponse",
     "NumericProfileDetail",
     "QueryRequest",
     "QueryResponse",
@@ -127,6 +138,9 @@ __all__ = [
     "RefreshResponse",
     "RefreshWarning",
     "ResultInfo",
+    "ResultsFormatQuery",
+    "Sandbox",
+    "SandboxResponse",
     "SavedQueryDatasetSource",
     "SavedQueryDetail",
     "SavedQuerySummary",
@@ -145,6 +159,7 @@ __all__ = [
     "UpdateDatasetResponse",
     "UpdateEmbeddingProviderRequest",
     "UpdateEmbeddingProviderResponse",
+    "UpdateSandboxRequest",
     "UpdateSavedQueryRequest",
     "UpdateSecretRequest",
     "UpdateSecretResponse",
@@ -171,6 +186,7 @@ from hotdata.api.query_api import QueryApi as QueryApi
 from hotdata.api.query_runs_api import QueryRunsApi as QueryRunsApi
 from hotdata.api.refresh_api import RefreshApi as RefreshApi
 from hotdata.api.results_api import ResultsApi as ResultsApi
+from hotdata.api.sandboxes_api import SandboxesApi as SandboxesApi
 from hotdata.api.saved_queries_api import SavedQueriesApi as SavedQueriesApi
 from hotdata.api.secrets_api import SecretsApi as SecretsApi
 from hotdata.api.uploads_api import UploadsApi as UploadsApi
@@ -217,14 +233,21 @@ from hotdata.models.create_dataset_response import CreateDatasetResponse as Crea
 from hotdata.models.create_embedding_provider_request import CreateEmbeddingProviderRequest as CreateEmbeddingProviderRequest
 from hotdata.models.create_embedding_provider_response import CreateEmbeddingProviderResponse as CreateEmbeddingProviderResponse
 from hotdata.models.create_index_request import CreateIndexRequest as CreateIndexRequest
+from hotdata.models.create_sandbox_request import CreateSandboxRequest as CreateSandboxRequest
 from hotdata.models.create_saved_query_request import CreateSavedQueryRequest as CreateSavedQueryRequest
 from hotdata.models.create_secret_request import CreateSecretRequest as CreateSecretRequest
 from hotdata.models.create_secret_response import CreateSecretResponse as CreateSecretResponse
 from hotdata.models.create_workspace_request import CreateWorkspaceRequest as CreateWorkspaceRequest
 from hotdata.models.create_workspace_response import CreateWorkspaceResponse as CreateWorkspaceResponse
 from hotdata.models.dataset_source import DatasetSource as DatasetSource
+from hotdata.models.dataset_source_one_of import DatasetSourceOneOf as DatasetSourceOneOf
+from hotdata.models.dataset_source_one_of1 import DatasetSourceOneOf1 as DatasetSourceOneOf1
+from hotdata.models.dataset_source_one_of2 import DatasetSourceOneOf2 as DatasetSourceOneOf2
+from hotdata.models.dataset_source_one_of3 import DatasetSourceOneOf3 as DatasetSourceOneOf3
+from hotdata.models.dataset_source_one_of4 import DatasetSourceOneOf4 as DatasetSourceOneOf4
 from hotdata.models.dataset_summary import DatasetSummary as DatasetSummary
 from hotdata.models.dataset_version_summary import DatasetVersionSummary as DatasetVersionSummary
+from hotdata.models.delete_sandbox_response import DeleteSandboxResponse as DeleteSandboxResponse
 from hotdata.models.discovery_status import DiscoveryStatus as DiscoveryStatus
 from hotdata.models.embedding_provider_response import EmbeddingProviderResponse as EmbeddingProviderResponse
 from hotdata.models.error import Error as Error
@@ -252,12 +275,15 @@ from hotdata.models.list_indexes_response import ListIndexesResponse as ListInde
 from hotdata.models.list_jobs_response import ListJobsResponse as ListJobsResponse
 from hotdata.models.list_query_runs_response import ListQueryRunsResponse as ListQueryRunsResponse
 from hotdata.models.list_results_response import ListResultsResponse as ListResultsResponse
+from hotdata.models.list_sandboxes_response import ListSandboxesResponse as ListSandboxesResponse
 from hotdata.models.list_saved_queries_response import ListSavedQueriesResponse as ListSavedQueriesResponse
 from hotdata.models.list_saved_query_versions_response import ListSavedQueryVersionsResponse as ListSavedQueryVersionsResponse
 from hotdata.models.list_secrets_response import ListSecretsResponse as ListSecretsResponse
 from hotdata.models.list_uploads_response import ListUploadsResponse as ListUploadsResponse
 from hotdata.models.list_workspace_contexts_response import ListWorkspaceContextsResponse as ListWorkspaceContextsResponse
 from hotdata.models.list_workspaces_response import ListWorkspacesResponse as ListWorkspacesResponse
+from hotdata.models.load_managed_table_request import LoadManagedTableRequest as LoadManagedTableRequest
+from hotdata.models.load_managed_table_response import LoadManagedTableResponse as LoadManagedTableResponse
 from hotdata.models.numeric_profile_detail import NumericProfileDetail as NumericProfileDetail
 from hotdata.models.query_request import QueryRequest as QueryRequest
 from hotdata.models.query_response import QueryResponse as QueryResponse
@@ -267,6 +293,9 @@ from hotdata.models.refresh_request import RefreshRequest as RefreshRequest
 from hotdata.models.refresh_response import RefreshResponse as RefreshResponse
 from hotdata.models.refresh_warning import RefreshWarning as RefreshWarning
 from hotdata.models.result_info import ResultInfo as ResultInfo
+from hotdata.models.results_format_query import ResultsFormatQuery as ResultsFormatQuery
+from hotdata.models.sandbox import Sandbox as Sandbox
+from hotdata.models.sandbox_response import SandboxResponse as SandboxResponse
 from hotdata.models.saved_query_dataset_source import SavedQueryDatasetSource as SavedQueryDatasetSource
 from hotdata.models.saved_query_detail import SavedQueryDetail as SavedQueryDetail
 from hotdata.models.saved_query_summary import SavedQuerySummary as SavedQuerySummary
@@ -285,6 +314,7 @@ from hotdata.models.update_dataset_request import UpdateDatasetRequest as Update
 from hotdata.models.update_dataset_response import UpdateDatasetResponse as UpdateDatasetResponse
 from hotdata.models.update_embedding_provider_request import UpdateEmbeddingProviderRequest as UpdateEmbeddingProviderRequest
 from hotdata.models.update_embedding_provider_response import UpdateEmbeddingProviderResponse as UpdateEmbeddingProviderResponse
+from hotdata.models.update_sandbox_request import UpdateSandboxRequest as UpdateSandboxRequest
 from hotdata.models.update_saved_query_request import UpdateSavedQueryRequest as UpdateSavedQueryRequest
 from hotdata.models.update_secret_request import UpdateSecretRequest as UpdateSecretRequest
 from hotdata.models.update_secret_response import UpdateSecretResponse as UpdateSecretResponse

{hotdata-0.0.1 → hotdata-0.2.0}/hotdata/api/__init__.py

@@ -12,6 +12,7 @@ from hotdata.api.query_api import QueryApi
 from hotdata.api.query_runs_api import QueryRunsApi
 from hotdata.api.refresh_api import RefreshApi
 from hotdata.api.results_api import ResultsApi
+from hotdata.api.sandboxes_api import SandboxesApi
 from hotdata.api.saved_queries_api import SavedQueriesApi
 from hotdata.api.secrets_api import SecretsApi
 from hotdata.api.uploads_api import UploadsApi

{hotdata-0.0.1 → hotdata-0.2.0}/hotdata/api/connection_types_api.py

@@ -282,6 +282,7 @@ class ConnectionTypesApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'WorkspaceId', 
             'BearerAuth'
         ]
 
@@ -528,6 +529,7 @@ class ConnectionTypesApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'WorkspaceId', 
             'BearerAuth'
         ]