cdata-connect 0.0.1.dev1__tar.gz

cdata_connect-0.0.1.dev1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 CData Software, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

cdata_connect-0.0.1.dev1/MANIFEST.in

@@ -0,0 +1,8 @@
+include README.md
+include LICENSE
+include pyproject.toml
+prune dist
+prune build
+global-exclude *.py[cod]
+global-exclude .DS_Store
+global-exclude Thumbs.db

cdata_connect-0.0.1.dev1/PKG-INFO

@@ -0,0 +1,290 @@
+Metadata-Version: 2.4
+Name: cdata-connect
+Version: 0.0.1.dev1
+Summary: CData Connect Python DB-API 2.0 interface library
+Author-email: "CData Software, Inc." <support@cdata.com>
+License-Expression: MIT
+Project-URL: Homepage, https://www.cdata.com/connect/
+Project-URL: Repository, https://github.com/CDataSoftware/cloud-sdk-python
+Project-URL: Bug Tracker, https://github.com/CDataSoftware/cloud-sdk-python/issues
+Keywords: cdata,dbapi,database,connector
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Database :: Front-Ends
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.28.0
+Requires-Dist: ijson>=3.1.0
+Requires-Dist: pyhocon>=0.3.60
+Provides-Extra: full
+Requires-Dist: pandas>=1.3.0; extra == "full"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-mock>=3.10; extra == "dev"
+Requires-Dist: requests; extra == "dev"
+Dynamic: license-file
+
+# ConnectAI Python Connector
+
+A Python [DB-API 2.0 (PEP 249)](https://peps.python.org/pep-0249/) compliant connector for [CData Connect AI](https://www.cdata.com/connect/). Query any data source connected through Connect AI using the standard Python database interface.
+
+## Installation
+
+```bash
+pip install cdata-connect
+```
+
+For pandas integration:
+
+```bash
+pip install "cdata-connect[full]"
+```
+
+## Quick Start
+
+```python
+import cdata_connect
+
+conn = cdata_connect.connect(
+    base_url="https://cloud.cdata.com/api/",
+    username="you@example.com",
+    password="<your_personal_access_token>",
+)
+
+cursor = conn.cursor()
+cursor.execute("SELECT * FROM [Salesforce1].[Salesforce].[Account]")
+rows = cursor.fetchall()
+for row in rows:
+    print(row)
+
+conn.close()
+```
+
+## Configuration File
+
+Use a [PyHOCON](https://github.com/chimpler/pyhocon) config file to keep credentials out of code:
+
+```hocon
+# config.conf
+cdata_api_db {
+  base_url = "https://cloud.cdata.com/api/"
+  username = "you@example.com"
+  password = "<your_personal_access_token>"
+}
+```
+
+```python
+conn = cdata_connect.connect(config_path="config.conf")
+```
+
+## Parameterized Queries
+
+```python
+cursor.execute(
+    "SELECT * FROM [DB].[public].[users] WHERE city = %(city)s LIMIT %(limit)s",
+    {"city": "New York", "limit": 10},
+)
+```
+
+## Batch Operations
+
+```python
+cursor.executemany(
+    "INSERT INTO [DB].[public].[cities] (city, id) VALUES (@city, @id)",
+    [
+		{"@city": {"dataType": 5, "value": "New York"}, "@id": {"dataType": 8, "value": 1}},
+		{"@city": {"dataType": 5, "value": "London"},   "@id": {"dataType": 8, "value": 2}},
+    ],
+)
+```
+
+## Stored Procedures
+
+```python
+cursor.callproc("[DB].[public].[my_procedure]", ("arg1", "arg2"))
+rows = cursor.fetchall()
+```
+
+## Connection Options
+
+| Parameter | Description | Default |
+|-----------|-------------|---------|
+| `base_url` | Connect AI API base URL | — |
+| `username` | Authentication username | — |
+| `password` | Personal access token | — |
+| `config_path` | Path to PyHOCON config file | — |
+| `workspace` | Connect AI workspace name | — |
+| `timeout` | HTTP request timeout (seconds) | `30` |
+| `max_retries` | Retries on transient 5xx errors | `3` |
+| `retry_delay` | Base delay between retries (seconds) | `1.0` |
+
+## DB-API 2.0 Compliance
+
+| Attribute | Value |
+|-----------|-------|
+| `apilevel` | `"2.0"` |
+| `threadsafety` | `3` |
+| `paramstyle` | `"pyformat"` |
+
+**Supported methods:** `connect()`, `cursor()`, `execute()`, `executemany()`, `callproc()`, `fetchone()`, `fetchmany()`, `fetchall()`, `close()`, `commit()`, `rollback()`
+
+## Exception Hierarchy
+
+```
+cdata_connect.Error
+├── InterfaceError
+└── DatabaseError
+    ├── DataError
+    ├── OperationalError
+    ├── IntegrityError
+    ├── InternalError
+    ├── ProgrammingError
+    └── NotSupportedError
+```
+
+## Requirements
+
+- Python >= 3.10
+- `requests >= 2.28.0`
+- `ijson >= 3.1.0`
+- `pyhocon >= 0.3.60`
+
+## Running Tests
+
+Tests are split into **unit** (no server) and **integration** (mock server auto-starts).
+
+```bash
+pip install -e ".[dev]"
+
+# Unit tests only — fast, no server needed
+pytest tests/unit/ -v
+
+# Integration tests — mock server auto-starts on localhost
+pytest tests/integration/ -v
+
+# All tests
+pytest tests/ -v
+
+# Run against a live Connect AI endpoint
+CDATA_BASE_URL=https://cloud.cdata.com/api \
+CDATA_USERNAME=you@example.com \
+CDATA_PASSWORD=<pat> \
+SKIP_LIVE_TESTS=0 \
+pytest tests/integration/ -v
+```
+
+See [`tests/README.md`](tests/README.md) for test organization details.
+
+### Test Environment Variables
+
+| Variable | Description | Default |
+|----------|-------------|---------|
+| `CDATA_BASE_URL` | API endpoint | `http://localhost:8080/api` |
+| `CDATA_USERNAME` | Auth username | `test@example.com` |
+| `CDATA_PASSWORD` | Auth password / PAT | `any_token` |
+| `MOCK_PORT` | Mock server port | `8080` |
+| `MOCK_SERVER_DIR` | Path to mock server | `../connect-ai-mock` |
+| `SKIP_LIVE_TESTS` | Skip live API tests | `1` |
+
+## Building from Source
+
+Install the build tool:
+
+```bash
+pip install build
+```
+
+Build both the wheel and source distribution from the `connector/` directory:
+
+```bash
+cd connector
+python -m build
+```
+
+Artifacts are written to `connector/dist/`:
+
+```
+dist/
+├── cdata_connect-1.0.0-py3-none-any.whl   # Wheel (preferred for install)
+└── cdata_connect-1.0.0.tar.gz             # Source distribution
+```
+
+Install the locally built wheel:
+
+```bash
+pip install dist/cdata_connect-1.0.0-py3-none-any.whl
+```
+
+### Publishing to PyPI
+
+```bash
+pip install twine
+
+# Verify the package metadata before uploading
+twine check dist/*
+
+# Upload to TestPyPI first (recommended for a dry run)
+twine upload --repository testpypi dist/*
+
+# Upload to PyPI
+twine upload dist/*
+```
+
+Store your PyPI credentials in `~/.pypirc` or pass them as environment variables:
+
+```ini
+# ~/.pypirc
+[pypi]
+username = __token__
+password = pypi-<your-api-token>
+```
+
+## Demo Client
+
+A demo script at the repo root (`client_demo.py`) exercises the connector end-to-end against the mock server. It covers:
+
+- `SELECT` with `fetchall`, `fetchone`, and `fetchmany`
+- `cursor.description` (column metadata)
+- Parameterized queries (`pyformat`)
+- Batch `INSERT` via `executemany` and `SELECT` to verify
+- `DELETE` and confirm empty result
+- Stored procedure via `callproc`
+- Error handling (`OperationalError` on bad host)
+
+**Step 1 — Start the mock server** (in one terminal):
+
+```bash
+cd connect-ai-mock
+pip install -r requirements.txt
+python run.py
+# Server ready at http://localhost:8080
+```
+
+**Step 2 — Install the connector and run the demo** (in another terminal):
+
+```bash
+# Install from PyPI
+pip install cdata-connect
+
+# OR install the locally built wheel
+pip install connector/dist/cdata_connect-1.0.0-py3-none-any.whl
+
+# Run
+python client_demo.py
+```
+
+Expected output covers all 9 demo sections and ends with `All done.`
+
+## License
+
+MIT — see [LICENSE](LICENSE)

cdata_connect-0.0.1.dev1/README.md

@@ -0,0 +1,254 @@
+# ConnectAI Python Connector
+
+A Python [DB-API 2.0 (PEP 249)](https://peps.python.org/pep-0249/) compliant connector for [CData Connect AI](https://www.cdata.com/connect/). Query any data source connected through Connect AI using the standard Python database interface.
+
+## Installation
+
+```bash
+pip install cdata-connect
+```
+
+For pandas integration:
+
+```bash
+pip install "cdata-connect[full]"
+```
+
+## Quick Start
+
+```python
+import cdata_connect
+
+conn = cdata_connect.connect(
+    base_url="https://cloud.cdata.com/api/",
+    username="you@example.com",
+    password="<your_personal_access_token>",
+)
+
+cursor = conn.cursor()
+cursor.execute("SELECT * FROM [Salesforce1].[Salesforce].[Account]")
+rows = cursor.fetchall()
+for row in rows:
+    print(row)
+
+conn.close()
+```
+
+## Configuration File
+
+Use a [PyHOCON](https://github.com/chimpler/pyhocon) config file to keep credentials out of code:
+
+```hocon
+# config.conf
+cdata_api_db {
+  base_url = "https://cloud.cdata.com/api/"
+  username = "you@example.com"
+  password = "<your_personal_access_token>"
+}
+```
+
+```python
+conn = cdata_connect.connect(config_path="config.conf")
+```
+
+## Parameterized Queries
+
+```python
+cursor.execute(
+    "SELECT * FROM [DB].[public].[users] WHERE city = %(city)s LIMIT %(limit)s",
+    {"city": "New York", "limit": 10},
+)
+```
+
+## Batch Operations
+
+```python
+cursor.executemany(
+    "INSERT INTO [DB].[public].[cities] (city, id) VALUES (@city, @id)",
+    [
+		{"@city": {"dataType": 5, "value": "New York"}, "@id": {"dataType": 8, "value": 1}},
+		{"@city": {"dataType": 5, "value": "London"},   "@id": {"dataType": 8, "value": 2}},
+    ],
+)
+```
+
+## Stored Procedures
+
+```python
+cursor.callproc("[DB].[public].[my_procedure]", ("arg1", "arg2"))
+rows = cursor.fetchall()
+```
+
+## Connection Options
+
+| Parameter | Description | Default |
+|-----------|-------------|---------|
+| `base_url` | Connect AI API base URL | — |
+| `username` | Authentication username | — |
+| `password` | Personal access token | — |
+| `config_path` | Path to PyHOCON config file | — |
+| `workspace` | Connect AI workspace name | — |
+| `timeout` | HTTP request timeout (seconds) | `30` |
+| `max_retries` | Retries on transient 5xx errors | `3` |
+| `retry_delay` | Base delay between retries (seconds) | `1.0` |
+
+## DB-API 2.0 Compliance
+
+| Attribute | Value |
+|-----------|-------|
+| `apilevel` | `"2.0"` |
+| `threadsafety` | `3` |
+| `paramstyle` | `"pyformat"` |
+
+**Supported methods:** `connect()`, `cursor()`, `execute()`, `executemany()`, `callproc()`, `fetchone()`, `fetchmany()`, `fetchall()`, `close()`, `commit()`, `rollback()`
+
+## Exception Hierarchy
+
+```
+cdata_connect.Error
+├── InterfaceError
+└── DatabaseError
+    ├── DataError
+    ├── OperationalError
+    ├── IntegrityError
+    ├── InternalError
+    ├── ProgrammingError
+    └── NotSupportedError
+```
+
+## Requirements
+
+- Python >= 3.10
+- `requests >= 2.28.0`
+- `ijson >= 3.1.0`
+- `pyhocon >= 0.3.60`
+
+## Running Tests
+
+Tests are split into **unit** (no server) and **integration** (mock server auto-starts).
+
+```bash
+pip install -e ".[dev]"
+
+# Unit tests only — fast, no server needed
+pytest tests/unit/ -v
+
+# Integration tests — mock server auto-starts on localhost
+pytest tests/integration/ -v
+
+# All tests
+pytest tests/ -v
+
+# Run against a live Connect AI endpoint
+CDATA_BASE_URL=https://cloud.cdata.com/api \
+CDATA_USERNAME=you@example.com \
+CDATA_PASSWORD=<pat> \
+SKIP_LIVE_TESTS=0 \
+pytest tests/integration/ -v
+```
+
+See [`tests/README.md`](tests/README.md) for test organization details.
+
+### Test Environment Variables
+
+| Variable | Description | Default |
+|----------|-------------|---------|
+| `CDATA_BASE_URL` | API endpoint | `http://localhost:8080/api` |
+| `CDATA_USERNAME` | Auth username | `test@example.com` |
+| `CDATA_PASSWORD` | Auth password / PAT | `any_token` |
+| `MOCK_PORT` | Mock server port | `8080` |
+| `MOCK_SERVER_DIR` | Path to mock server | `../connect-ai-mock` |
+| `SKIP_LIVE_TESTS` | Skip live API tests | `1` |
+
+## Building from Source
+
+Install the build tool:
+
+```bash
+pip install build
+```
+
+Build both the wheel and source distribution from the `connector/` directory:
+
+```bash
+cd connector
+python -m build
+```
+
+Artifacts are written to `connector/dist/`:
+
+```
+dist/
+├── cdata_connect-1.0.0-py3-none-any.whl   # Wheel (preferred for install)
+└── cdata_connect-1.0.0.tar.gz             # Source distribution
+```
+
+Install the locally built wheel:
+
+```bash
+pip install dist/cdata_connect-1.0.0-py3-none-any.whl
+```
+
+### Publishing to PyPI
+
+```bash
+pip install twine
+
+# Verify the package metadata before uploading
+twine check dist/*
+
+# Upload to TestPyPI first (recommended for a dry run)
+twine upload --repository testpypi dist/*
+
+# Upload to PyPI
+twine upload dist/*
+```
+
+Store your PyPI credentials in `~/.pypirc` or pass them as environment variables:
+
+```ini
+# ~/.pypirc
+[pypi]
+username = __token__
+password = pypi-<your-api-token>
+```
+
+## Demo Client
+
+A demo script at the repo root (`client_demo.py`) exercises the connector end-to-end against the mock server. It covers:
+
+- `SELECT` with `fetchall`, `fetchone`, and `fetchmany`
+- `cursor.description` (column metadata)
+- Parameterized queries (`pyformat`)
+- Batch `INSERT` via `executemany` and `SELECT` to verify
+- `DELETE` and confirm empty result
+- Stored procedure via `callproc`
+- Error handling (`OperationalError` on bad host)
+
+**Step 1 — Start the mock server** (in one terminal):
+
+```bash
+cd connect-ai-mock
+pip install -r requirements.txt
+python run.py
+# Server ready at http://localhost:8080
+```
+
+**Step 2 — Install the connector and run the demo** (in another terminal):
+
+```bash
+# Install from PyPI
+pip install cdata-connect
+
+# OR install the locally built wheel
+pip install connector/dist/cdata_connect-1.0.0-py3-none-any.whl
+
+# Run
+python client_demo.py
+```
+
+Expected output covers all 9 demo sections and ends with `All done.`
+
+## License
+
+MIT — see [LICENSE](LICENSE)

cdata_connect-0.0.1.dev1/cdata_connect/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 CData Software, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

cdata_connect-0.0.1.dev1/cdata_connect/__init__.py

@@ -0,0 +1,82 @@
+from typing import Optional
+
+from .connection import Connection
+from .exceptions import (
+    ConfigurationError,
+    DatabaseError,
+    DataError,
+    Error,
+    IntegrityError,
+    InterfaceError,
+    InternalError,
+    NotSupportedError,
+    OperationalError,
+    ProgrammingError,
+    Warning,
+)
+from .util.types import (
+    DBAPI_TYPE_STRING,
+    DBAPI_TYPE_BINARY,
+    DBAPI_TYPE_NUMBER,
+    DBAPI_TYPE_TIMESTAMP,
+    Date,
+    Time,
+    Timestamp,
+    Binary,
+    DateFromTicks,
+    TimeFromTicks,
+    TimestampFromTicks,
+)
+from .version import __version__
+
+# PEP 249 mandatory module-level type objects
+STRING = DBAPI_TYPE_STRING       # 0
+BINARY = DBAPI_TYPE_BINARY       # 1
+NUMBER = DBAPI_TYPE_NUMBER       # 2
+DATETIME = DBAPI_TYPE_TIMESTAMP  # 3
+ROWID = DBAPI_TYPE_STRING        # No dedicated ROWID type; STRING is the standard fallback
+
+# DB API 2.0 module attributes
+apilevel = "2.0"
+threadsafety = 1
+paramstyle = "pyformat"
+
+
+def connect(
+    config_path: Optional[str] = None,
+    base_url: Optional[str] = None,
+    username: Optional[str] = None,
+    password: Optional[str] = None,
+    workspace: Optional[str] = None,
+    timeout: int = 30,
+    max_retries: int = 3,
+    retry_delay: float = 1.0,
+) -> Connection:
+    """
+    Create a connection to the CData Connect API.
+
+    :param base_url: The base URL of the CData Connect API.
+    :param username: The username for authentication.
+    :param password: The password for authentication.
+    :param config_path: Optional path to a pyhocon config file.
+    :param workspace: Optional workspace name to append as a query parameter.
+    :param timeout: HTTP request timeout in seconds. Default 30.
+    :param max_retries: Retry count for transient 5xx errors. Default 3.
+    :param retry_delay: Base seconds between retries (exponential backoff). Default 1.0.
+    :return: A Connection object.
+    """
+    if not config_path and not (base_url and username and password):
+        raise InterfaceError(
+            "Either config_path or base_url, username, and password must be provided."
+        )
+
+    return Connection(
+        config_path=config_path,
+        base_url=base_url,
+        username=username,
+        password=password,
+        workspace=workspace,
+        timeout=timeout,
+        max_retries=max_retries,
+        retry_delay=retry_delay,
+    )