data-connect-hub 0.1.0__tar.gz

data_connect_hub-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data_connect_hub-0.1.0/MANIFEST.in

@@ -0,0 +1,7 @@
+# Controls sdist (.tar.gz) contents only; the wheel is unaffected.
+#
+# setuptools-scm installs a file-finder that replaces setuptools' default sdist
+# file set with "everything git tracks under sdk/python". That silently pulled
+# examples/ (including quickstart.ipynb) into the sdist, which was never shipped
+# before the setuptools-scm migration. They are documentation, not runtime code.
+prune examples

data_connect_hub-0.1.0/PKG-INFO

@@ -0,0 +1,316 @@
+Metadata-Version: 2.4
+Name: data-connect-hub
+Version: 0.1.0
+Summary: Python SDK for the Data Connect Hub service
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/opendatahub-io/data-connect-hub
+Project-URL: Repository, https://github.com/opendatahub-io/data-connect-hub
+Project-URL: Documentation, https://opendatahub-io.github.io/data-connect-hub/
+Project-URL: Issues, https://github.com/opendatahub-io/data-connect-hub/issues
+Keywords: data,data-connect-hub,data-connectivity,flight-sql,opendatahub
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx<1,>=0.27
+Requires-Dist: pydantic<3,>=2.0
+Provides-Extra: flight
+Requires-Dist: adbc-driver-flightsql>=1.0.0; extra == "flight"
+Requires-Dist: pyarrow>=14.0; extra == "flight"
+Requires-Dist: pandas>=2.0; extra == "flight"
+Requires-Dist: protobuf>=6.33.5; extra == "flight"
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: numpy<2.5; extra == "dev"
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-cov>=5.0; extra == "dev"
+Requires-Dist: ruff>=0.5; extra == "dev"
+Requires-Dist: twine>=5.0; extra == "dev"
+Requires-Dist: mypy>=1.10; extra == "dev"
+Dynamic: license-file
+
+# Data Connect Hub Python SDK
+
+Python client library for the [Data Connect Hub](https://github.com/opendatahub-io/data-connect-hub) service.
+
+## Installation
+
+```bash
+# REST only (default)
+pip install data-connect-hub
+
+# REST + Flight SQL
+pip install "data-connect-hub[flight]"
+```
+
+To install from a source checkout, use `pip install sdk/python` or
+`pip install "sdk/python[flight]"`.
+
+TestPyPI builds are PEP 440 development releases, so `--pre` is required. Install
+the SDK without dependencies from TestPyPI, then install its dependencies from
+PyPI only:
+
+```bash
+pip install --pre --no-deps \
+  --index-url https://test.pypi.org/simple/ \
+  data-connect-hub
+pip install --index-url https://pypi.org/simple/ \
+  "httpx>=0.27,<1" "pydantic>=2,<3"
+```
+
+Installing from a GitHub source archive (`.../archive/main.tar.gz`) fails: archives
+carry no `.git` directory, so `setuptools-scm` cannot derive a version. This is
+deliberate — a silent fallback version would sort unpredictably against published
+releases. Install from Git instead:
+
+```bash
+pip install "git+https://github.com/opendatahub-io/data-connect-hub.git#subdirectory=sdk/python"
+```
+
+## Quick Start
+
+The client takes a single gateway `endpoint` — a host or `host:port`, no scheme required — and derives both the REST (`https://`) and Flight SQL (`grpc+tls://`) URLs from it. Only TLS endpoints are supported; use `insecure=True` or `ca_cert=` to control certificate verification.
+
+```python
+from data_connect_hub import CredentialsRef, DataConnectClient
+
+client = DataConnectClient(
+    endpoint="dch.example.com:8443",
+    token="<your-token>",  # or use token_provider= for auto-refresh
+    tenant_id="my-tenant",
+)
+
+# Or use a token provider for automatic refresh on 401:
+client = DataConnectClient(
+    endpoint="dch.example.com:8443",
+    token_provider=lambda: get_fresh_token(),  # your function; called once, cached, refreshed on 401
+    tenant_id="my-tenant",
+)
+
+# List connections (REST)
+connections = client.list_connections()
+
+# Get a specific connection
+conn = client.get_connection("conn-id")
+
+# Create a connection
+conn = client.create_connection(
+    name="my-db",
+    connection_type_id="dct-a1b2c3d4",
+    data_format="tabular",  # DataFormat: "tabular" | "binary"
+    credentials_ref=CredentialsRef(secret="secret/my-db"),
+)
+
+# Query data via Flight SQL
+table = client.read("SELECT * FROM prompts", connection_id="conn-uuid")
+df = table.to_pandas()
+```
+
+## API Reference
+
+The REST API is the source of truth for every model below. See the [REST API reference](https://opendatahub-io.github.io/data-connect-hub/) for the full request/response schemas.
+
+### Connection Types (REST)
+
+Connection types describe a category of data source (e.g. PostgreSQL). They define the provider backend and the credential fields required to connect.
+
+```python
+client.list_connection_types() -> list[ConnectionType]
+client.get_connection_type(type_id) -> ConnectionType
+client.create_connection_type(name=..., provider=..., description=..., credentials_fields=...) -> ConnectionType
+client.update_connection_type(type_id, name=..., provider=..., description=..., credentials_fields=...) -> ConnectionType
+client.delete_connection_type(type_id) -> None
+```
+
+#### `ConnectionType`
+
+| Field | Type | Description |
+|---|---|---|
+| `id` | `str` | Unique identifier |
+| `name` | `str` | Display name |
+| `provider` | `str` | Backend driver (e.g. `"postgres"`) |
+| `description` | `str \| None` | Optional description |
+| `tenant_id` | `str` | Owning namespace |
+| `created_at` | `datetime \| None` | Creation timestamp |
+| `updated_at` | `datetime \| None` | Last update timestamp |
+| `credentials_fields` | `list[CredentialField]` | Credential fields required to connect |
+| `status` | `ConnectionTypeStatus` | Transports the provider supports |
+
+Pass `id` as the `type_id` argument to `get_connection_type`, `update_connection_type`, and `delete_connection_type` — and as `connection_type_id` to `create_connection`.
+
+`status.capabilities` reports which transports the provider supports (`flight` and `rest`, both `bool`), so you can check before issuing a Flight SQL query:
+
+```python
+ct = client.get_connection_type("dct-a1b2c3d4")
+if ct.status.capabilities.flight:
+    table = client.read("SELECT * FROM prompts", connection_id=conn.id)
+```
+
+#### `CredentialField`
+
+Describes a single input field in the connection credential form.
+
+| Field | Type | Description |
+|---|---|---|
+| `name` | `str` | Field key (used as the secret key) |
+| `label` | `str` | Human-readable label |
+| `description` | `str \| None` | Optional help text |
+| `required` | `bool` | Whether the field must be provided |
+| `type` | `str` | Rendering hint for the form (see below) |
+| `enum_values` | `list[EnumValue] \| None` | Allowed values when `type` is `"enum"` |
+| `default_value` | `str \| None` | Optional default value |
+
+`EnumValue` has two fields: `value` (the stored string) and `label` (the display string).
+
+**`type` values:**
+
+| Value | Meaning |
+|---|---|
+| `"string"` | Free-text single-line input |
+| `"enum"` | One of `enum_values` |
+
+`type` is a free-form string that only tells a client how to render the input — the server neither validates nor interprets it. Its one credential check is that every field with `required=True` is present in the submitted secret. Every connection type shipped in [`config/connection-types/`](../../config/connection-types/) uses `"string"`; your own may use any other value (e.g. `"password"` to hint that input should be masked), and clients that do not recognize it should treat it as `"string"`. The authoritative definition is the `Field` schema in the [REST API reference](https://opendatahub-io.github.io/data-connect-hub/).
+
+### Connection Management (REST)
+
+A connection pairs a connection type with the actual credentials (stored in a Kubernetes secret) and tracks the live status of the data source.
+
+```python
+client.list_connections() -> list[DataConnection]
+client.get_connection(connection_id) -> DataConnection
+client.create_connection(name=..., connection_type_id=..., data_format=..., credentials_ref=..., properties=...) -> DataConnection
+client.update_connection(connection_id, name=..., connection_type_id=..., data_format=..., credentials_ref=...) -> DataConnection
+client.delete_connection(connection_id) -> None
+```
+
+#### `DataConnection`
+
+| Field | Type | Description |
+|---|---|---|
+| `id` | `str` | Unique identifier |
+| `name` | `str` | Display name |
+| `data_connection_type_id` | `str` | `id` of the associated `ConnectionType` |
+| `format` | `"tabular" \| "binary"` | Data format of the source (see below) |
+| `tenant_id` | `str` | Owning namespace |
+| `created_at` | `datetime` | Creation timestamp |
+| `updated_at` | `datetime` | Last update timestamp |
+| `credentials_ref` | `CredentialsRef` | Credential secret reference |
+| `properties` | `dict[str, str]` | Driver-specific properties (values masked in repr) |
+| `status` | `DataConnectionStatus` | Live connection health |
+
+Pass `id` as the `connection_id` argument to `get_connection`, `update_connection`, `delete_connection`, and the Flight SQL methods.
+
+**`format` values:**
+
+| Value | Meaning | Providers |
+|---|---|---|
+| `"tabular"` | Queried with SQL, returns rows | `postgres`, `sqlite`, `elasticsearch`, `milvus`, `neo4j`, `uri`, `s3` |
+| `"binary"` | Opaque objects addressed by path | `s3`, `uri` |
+
+Tabular connections are read with the [Flight SQL methods](#tabular-data-queries-flight-sql). Binary connections are managed through the same REST methods as tabular ones, but reading their contents uses a separate Flight download path that **this SDK does not wrap yet** — there is no `client.download(...)`. Until it is added, use `pyarrow.flight` directly; see [`hack/py-tools/samples/binary_download.py`](../../hack/py-tools/samples/binary_download.py).
+
+You normally set `format` once, at `create_connection`, but it is not immutable: `update_connection(connection_id, data_format=...)` changes it, and the server accepts the new value without checking it against the provider or re-evaluating `status`. So switching a `postgres` connection to `binary` succeeds, leaves `status` reporting `ready`, and fails only when you try to read.
+
+`credentials_ref` is a reference to a Kubernetes secret containing the connection credentials. Use `CredentialsRef(secret="secret-name")` where `secret-name` is the **name** of an existing secret in the tenant namespace (the namespace named by the connection's `tenant_id` that you passed to `DataConnectClient`). This is a bare secret name, not a `namespace/name` pair; cross-namespace references are not supported. If the secret is missing or unreadable, `status.state` becomes `"not_ready"`. The secret's keys must cover every `CredentialField` on the connection type that has `required=True`.
+
+**`DataConnectionStatus`:**
+
+| Field | Type | Description |
+|---|---|---|
+| `state` | `"ready" \| "ingestion_not_ready" \| "not_ready"` | Connection health (see below) |
+| `message` | `str \| None` | Status detail message |
+| `updated_at` | `datetime \| None` | When the status was last evaluated |
+
+**`state` values:**
+
+| Value | Meaning |
+|---|---|
+| `"ready"` | Credentials are valid and the source is queryable |
+| `"ingestion_not_ready"` | Credentials are valid, but the source cannot be queried |
+| `"not_ready"` | The referenced secret is missing or invalid |
+
+### Tabular Data Queries (Flight SQL)
+
+```python
+client.read(sql, connection_id) -> pyarrow.Table          # full result as Arrow Table
+client.read_pandas(sql, connection_id) -> pd.DataFrame    # full result as pandas DataFrame
+client.read_batches(sql, connection_id) -> Generator[RecordBatch]  # stream of Arrow RecordBatches
+client.get_tables(connection_id) -> pyarrow.Table         # table metadata
+client.server_info() -> dict                              # server metadata
+```
+
+`read_batches` returns a generator that streams results instead of buffering the full result set in memory. The underlying cursor and connection are closed automatically when the generator is exhausted or garbage-collected:
+
+```python
+for batch in client.read_batches("SELECT * FROM prompts", "conn-uuid"):
+    process(batch)
+```
+
+A server-side failure surfaced mid-stream raises `DCHQueryError`. Automatic token refresh applies when the stream is opened; an authentication failure that occurs after the stream is open is not retried.
+
+These require the `flight` extra. On a REST-only install the client still imports and all REST calls work; the first Flight call raises `DCHConfigError` telling you to install `data-connect-hub[flight]`.
+
+## Error Handling
+
+Every failure raised by the SDK derives from `DCHError`, so a single `except` covers transport failures, HTTP errors, and malformed responses alike:
+
+```python
+from data_connect_hub import DCHError, DCHNotFoundError
+
+try:
+    conn = client.get_connection("conn-uuid")
+except DCHNotFoundError:
+    ...
+except DCHError as exc:  # connection, timeout, auth, schema drift, ...
+    ...
+```
+
+| Exception | Raised when |
+|---|---|
+| `DCHConfigError` | Invalid client configuration or argument (e.g. a blank id) |
+| `DCHConnectionError` | The server was unreachable or the transport failed |
+| `DCHTimeoutError` | The request exceeded `rest_timeout` |
+| `DCHAuthenticationError` / `DCHForbiddenError` | HTTP 401 / 403 |
+| `DCHNotFoundError` | HTTP 404 |
+| `DCHValidationError` | HTTP 400 / 422 |
+| `DCHServerError` | HTTP 5xx |
+| `DCHResponseError` | The response was not JSON, or did not match the expected schema |
+| `DCHQueryError` | A Flight SQL query failed |
+
+Transient failures — HTTP 429/502/503/504, timeouts, and network or protocol errors — are retried automatically with exponential backoff on idempotent methods. See `max_retries`, `backoff_base`, and `backoff_max`.
+
+## Requirements
+
+- Python 3.11+
+- Core dependencies: httpx, pydantic
+- Flight SQL extras: adbc-driver-flightsql, pyarrow, pandas (`pip install "data-connect-hub[flight]"`)
+
+## Releases
+
+The package version is derived from Git history by `setuptools-scm` — there is no
+version file to bump. Building therefore requires a full clone with tags; a shallow
+clone or a tree without usable package metadata fails to build.
+
+**TestPyPI (pre-release).** Run the *Publish Python SDK to TestPyPI* workflow manually
+from the Actions tab. The version is a development release derived from the distance
+since the last tag, for example `0.1.devN` before the first tag exists and
+`0.1.1.dev12` after `sdk-v0.1.0`. Re-dispatching on an already-published commit produces
+the same version and fails on the duplicate upload; land a commit first.
+
+**PyPI (tagged release).** Push an SDK-specific tag of `sdk-v` followed by the PEP 440
+version, for example `sdk-v0.1.0`; the tag is what defines the published version. The
+*Release Python SDK* workflow builds and validates the distribution, publishes it to PyPI
+using trusted publishing, then creates the GitHub Release.
+
+Locally, `make sdk-package-check` builds and validates the distribution the same way CI does.
+
+## Contributing
+
+See [CONTRIBUTING.md](../../CONTRIBUTING.md) for development setup, commands, and contribution guidelines.