walacor-python-sdk 0.1.1__tar.gz → 0.1.3__tar.gz

walacor_python_sdk-0.1.3/PKG-INFO

@@ -0,0 +1,195 @@
+Metadata-Version: 2.4
+Name: walacor_python_sdk
+Version: 0.1.3
+Summary: Python SDK for Walacor
+Author-email: Garo Kechichian <garo.keshish@gmail.com>
+License: Apache-2.0
+Project-URL: Documentation, https://apidoc.walacor.com
+Project-URL: Homepage, https://www.walacor.com
+Keywords: data-transformations,lineage,provenance,walacor
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.32.3
+Requires-Dist: pydantic>=2.10
+Provides-Extra: test
+Requires-Dist: pytest>=6; extra == "test"
+Provides-Extra: dev
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: tox; extra == "dev"
+Provides-Extra: data-science
+Requires-Dist: pandas>=2.0; extra == "data-science"
+Requires-Dist: pyarrow>=14; extra == "data-science"
+Requires-Dist: numpy>=1.26; extra == "data-science"
+Dynamic: license-file
+
+# Walacor Python SDK
+
+<div align="center">
+
+<img src="https://www.walacor.com/wp-content/uploads/2022/09/Walacor_Logo_Tag.png" width="300" />
+
+[![License Apache 2.0][badge-license]][license]
+[![Walacor (1100127456347832400)](https://img.shields.io/badge/My-Discord-%235865F2.svg?label=Walacor)](https://discord.gg/BaEWpsg8Yc)
+[![Walacor (1100127456347832400)](https://img.shields.io/static/v1?label=Walacor&message=LinkedIn&color=blue)](https://www.linkedin.com/company/walacor/)
+[![Walacor (1100127456347832400)](https://img.shields.io/static/v1?label=Walacor&message=Website&color)](https://www.walacor.com/product/)
+
+</div>
+
+[badge-license]: https://img.shields.io/badge/license-Apache2-green.svg?dummy
+[license]: https://github.com/walacor/objectvalidation/blob/main/LICENSE
+
+
+# Walacor Python SDK
+
+[![PyPI](https://img.shields.io/pypi/v/walacor-python-sdk.svg)](https://pypi.org/project/walacor-python-sdk/)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
+
+*A typed, lightweight wrapper around Walacor’s REST API for immutable provenance, schema management and (soon) data‑science transformations.*
+
+---
+
+## ✨ Features
+
+* **One‑liner setup** – a single `WalacorService` object bootstraps authentication and exposes sub‑clients (`auth`, `schema`, `data`, *etc.*)
+* **Pydantic models everywhere** – rich typing, runtime validation and IDE autocompletion.
+* **Version‑safe schemas** – helper methods to list, inspect and create schema blueprints.
+* **Composable requests** – thin wrappers over `requests` that automatically inject Bearer tokens and headers.
+* **Python 3.11 + only** – enjoy `typing` generics, `|` unions, `match` statements.
+
+---
+
+## 📦 Installation
+
+### From PyPI (recommended)
+
+```bash
+pip install walacor-python-sdk
+```
+
+### From source (editable)
+
+```bash
+git clone https://github.com/walacor/python-sdk.git
+cd python-sdk
+pip install -e .[dev,test]
+```
+
+> After installation, import via `walacor_sdk` (underscore), **not** the PyPI name with a dash.
+
+```python
+from walacor_sdk import WalacorService
+```
+
+---
+
+## 🚀 Quick Start
+
+### 1 – Create a service instance
+
+```python
+from walacor_sdk import WalacorService
+
+wal = WalacorService(
+    server="http://[walacor.instance.address/api",
+    username="Admin",
+    password="Password!"
+)
+```
+
+Need to change credentials later?
+
+```python
+wal.changeCred("new_user", "new_password")
+```
+
+### 2 – Work with schemas
+
+```python
+from walacor_sdk.schema.models import (
+    CreateSchemaRequest, CreateSchemaDefinition,
+    CreateFieldRequest, CreateIndexRequest
+)
+
+schema_req = CreateSchemaRequest(
+    ETId=50,    # system envelope for schemas
+    SV=1,
+    Schema=CreateSchemaDefinition(
+        ETId=654321,
+        TableName="books",
+        Family="library",
+        DoSummary=True,
+        Fields=[
+            CreateFieldRequest(FieldName="book_id", DataType="TEXT", Required=True),
+            CreateFieldRequest(FieldName="title",   DataType="TEXT", Required=True)
+        ],
+        Indexes=[
+            CreateIndexRequest(Fields=["book_id"], IndexValue="book_id")
+        ]
+    )
+)
+
+meta = wal.schema.create_schema(schema_req)
+print("Created schema envelope:", meta.EId)
+```
+
+Other handy calls:
+
+```python
+# list latest versions for every ETId
+for s in wal.schema.get_list_with_latest_version():
+    print(s.ETId, s.TableName)
+
+# detailed info for a known ETId
+info = wal.schema.get_schema_details_with_ETId(654321)
+print(info.Fields)
+```
+
+### 3 – Use enums & constants
+
+```python
+from walacor_sdk.utils.enums import SystemEnvelopeType
+print(SystemEnvelopeType.SCHEMA.value)   # -> 50
+```
+
+---
+
+## ⚙️ Error handling & logging
+
+* Network errors raise `requests.HTTPError` so you can retry or surface gracefully.
+* Validation errors are logged with `logging.error` and result in `None`/`[]` returns, never raw dictionaries.
+* The SDK writes to the module‑level *walacor\_sdk.utils.logger* logger; attach your own handler or redirect to file.
+
+---
+
+## 🧪 Running tests
+
+```bash
+pip install .[test]
+pytest -q
+```
+
+---
+
+## 🤝 Contributing
+
+We love PRs! Please open an issue first for large features. All contributions must:
+
+* Pass `pre-commit` hooks (`pre-commit run --all-files`).
+* Include unit tests with `pytest`.
+* Follow the existing docstring & typing style.
+
+For full contribution details, see 👉 [CONTRIBUTING.md](CONTRIBUTING.md).
+
+---
+
+## 📄 License
+
+Apache 2.0 © 2025 Walacor & Contributors.

walacor_python_sdk-0.1.3/README.md

@@ -0,0 +1,163 @@
+# Walacor Python SDK
+
+<div align="center">
+
+<img src="https://www.walacor.com/wp-content/uploads/2022/09/Walacor_Logo_Tag.png" width="300" />
+
+[![License Apache 2.0][badge-license]][license]
+[![Walacor (1100127456347832400)](https://img.shields.io/badge/My-Discord-%235865F2.svg?label=Walacor)](https://discord.gg/BaEWpsg8Yc)
+[![Walacor (1100127456347832400)](https://img.shields.io/static/v1?label=Walacor&message=LinkedIn&color=blue)](https://www.linkedin.com/company/walacor/)
+[![Walacor (1100127456347832400)](https://img.shields.io/static/v1?label=Walacor&message=Website&color)](https://www.walacor.com/product/)
+
+</div>
+
+[badge-license]: https://img.shields.io/badge/license-Apache2-green.svg?dummy
+[license]: https://github.com/walacor/objectvalidation/blob/main/LICENSE
+
+
+# Walacor Python SDK
+
+[![PyPI](https://img.shields.io/pypi/v/walacor-python-sdk.svg)](https://pypi.org/project/walacor-python-sdk/)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
+
+*A typed, lightweight wrapper around Walacor’s REST API for immutable provenance, schema management and (soon) data‑science transformations.*
+
+---
+
+## ✨ Features
+
+* **One‑liner setup** – a single `WalacorService` object bootstraps authentication and exposes sub‑clients (`auth`, `schema`, `data`, *etc.*)
+* **Pydantic models everywhere** – rich typing, runtime validation and IDE autocompletion.
+* **Version‑safe schemas** – helper methods to list, inspect and create schema blueprints.
+* **Composable requests** – thin wrappers over `requests` that automatically inject Bearer tokens and headers.
+* **Python 3.11 + only** – enjoy `typing` generics, `|` unions, `match` statements.
+
+---
+
+## 📦 Installation
+
+### From PyPI (recommended)
+
+```bash
+pip install walacor-python-sdk
+```
+
+### From source (editable)
+
+```bash
+git clone https://github.com/walacor/python-sdk.git
+cd python-sdk
+pip install -e .[dev,test]
+```
+
+> After installation, import via `walacor_sdk` (underscore), **not** the PyPI name with a dash.
+
+```python
+from walacor_sdk import WalacorService
+```
+
+---
+
+## 🚀 Quick Start
+
+### 1 – Create a service instance
+
+```python
+from walacor_sdk import WalacorService
+
+wal = WalacorService(
+    server="http://[walacor.instance.address/api",
+    username="Admin",
+    password="Password!"
+)
+```
+
+Need to change credentials later?
+
+```python
+wal.changeCred("new_user", "new_password")
+```
+
+### 2 – Work with schemas
+
+```python
+from walacor_sdk.schema.models import (
+    CreateSchemaRequest, CreateSchemaDefinition,
+    CreateFieldRequest, CreateIndexRequest
+)
+
+schema_req = CreateSchemaRequest(
+    ETId=50,    # system envelope for schemas
+    SV=1,
+    Schema=CreateSchemaDefinition(
+        ETId=654321,
+        TableName="books",
+        Family="library",
+        DoSummary=True,
+        Fields=[
+            CreateFieldRequest(FieldName="book_id", DataType="TEXT", Required=True),
+            CreateFieldRequest(FieldName="title",   DataType="TEXT", Required=True)
+        ],
+        Indexes=[
+            CreateIndexRequest(Fields=["book_id"], IndexValue="book_id")
+        ]
+    )
+)
+
+meta = wal.schema.create_schema(schema_req)
+print("Created schema envelope:", meta.EId)
+```
+
+Other handy calls:
+
+```python
+# list latest versions for every ETId
+for s in wal.schema.get_list_with_latest_version():
+    print(s.ETId, s.TableName)
+
+# detailed info for a known ETId
+info = wal.schema.get_schema_details_with_ETId(654321)
+print(info.Fields)
+```
+
+### 3 – Use enums & constants
+
+```python
+from walacor_sdk.utils.enums import SystemEnvelopeType
+print(SystemEnvelopeType.SCHEMA.value)   # -> 50
+```
+
+---
+
+## ⚙️ Error handling & logging
+
+* Network errors raise `requests.HTTPError` so you can retry or surface gracefully.
+* Validation errors are logged with `logging.error` and result in `None`/`[]` returns, never raw dictionaries.
+* The SDK writes to the module‑level *walacor\_sdk.utils.logger* logger; attach your own handler or redirect to file.
+
+---
+
+## 🧪 Running tests
+
+```bash
+pip install .[test]
+pytest -q
+```
+
+---
+
+## 🤝 Contributing
+
+We love PRs! Please open an issue first for large features. All contributions must:
+
+* Pass `pre-commit` hooks (`pre-commit run --all-files`).
+* Include unit tests with `pytest`.
+* Follow the existing docstring & typing style.
+
+For full contribution details, see 👉 [CONTRIBUTING.md](CONTRIBUTING.md).
+
+---
+
+## 📄 License
+
+Apache 2.0 © 2025 Walacor & Contributors.

{walacor_python_sdk-0.1.1 → walacor_python_sdk-0.1.3}/pyproject.toml

@@ -46,12 +46,28 @@ dev = [
   "pre-commit",
   "tox"
 ]
+
+data-science = [
+  "pandas>=2.0",
+  "pyarrow>=14",
+  "numpy>=1.26"
+]
+
 [tool.setuptools_scm]
 
 [project.urls]
 Documentation = "https://apidoc.walacor.com"
 Homepage = "https://www.walacor.com"
 
+[tool.setuptools.package-data]
+"walacor_sdk" = ["py.typed"]
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
 [tool.ruff]
 src = [ "src" ]
 

walacor_python_sdk-0.1.3/src/walacor_python_sdk.egg-info/PKG-INFO

@@ -0,0 +1,195 @@
+Metadata-Version: 2.4
+Name: walacor_python_sdk
+Version: 0.1.3
+Summary: Python SDK for Walacor
+Author-email: Garo Kechichian <garo.keshish@gmail.com>
+License: Apache-2.0
+Project-URL: Documentation, https://apidoc.walacor.com
+Project-URL: Homepage, https://www.walacor.com
+Keywords: data-transformations,lineage,provenance,walacor
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.32.3
+Requires-Dist: pydantic>=2.10
+Provides-Extra: test
+Requires-Dist: pytest>=6; extra == "test"
+Provides-Extra: dev
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: tox; extra == "dev"
+Provides-Extra: data-science
+Requires-Dist: pandas>=2.0; extra == "data-science"
+Requires-Dist: pyarrow>=14; extra == "data-science"
+Requires-Dist: numpy>=1.26; extra == "data-science"
+Dynamic: license-file
+
+# Walacor Python SDK
+
+<div align="center">
+
+<img src="https://www.walacor.com/wp-content/uploads/2022/09/Walacor_Logo_Tag.png" width="300" />
+
+[![License Apache 2.0][badge-license]][license]
+[![Walacor (1100127456347832400)](https://img.shields.io/badge/My-Discord-%235865F2.svg?label=Walacor)](https://discord.gg/BaEWpsg8Yc)
+[![Walacor (1100127456347832400)](https://img.shields.io/static/v1?label=Walacor&message=LinkedIn&color=blue)](https://www.linkedin.com/company/walacor/)
+[![Walacor (1100127456347832400)](https://img.shields.io/static/v1?label=Walacor&message=Website&color)](https://www.walacor.com/product/)
+
+</div>
+
+[badge-license]: https://img.shields.io/badge/license-Apache2-green.svg?dummy
+[license]: https://github.com/walacor/objectvalidation/blob/main/LICENSE
+
+
+# Walacor Python SDK
+
+[![PyPI](https://img.shields.io/pypi/v/walacor-python-sdk.svg)](https://pypi.org/project/walacor-python-sdk/)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
+
+*A typed, lightweight wrapper around Walacor’s REST API for immutable provenance, schema management and (soon) data‑science transformations.*
+
+---
+
+## ✨ Features
+
+* **One‑liner setup** – a single `WalacorService` object bootstraps authentication and exposes sub‑clients (`auth`, `schema`, `data`, *etc.*)
+* **Pydantic models everywhere** – rich typing, runtime validation and IDE autocompletion.
+* **Version‑safe schemas** – helper methods to list, inspect and create schema blueprints.
+* **Composable requests** – thin wrappers over `requests` that automatically inject Bearer tokens and headers.
+* **Python 3.11 + only** – enjoy `typing` generics, `|` unions, `match` statements.
+
+---
+
+## 📦 Installation
+
+### From PyPI (recommended)
+
+```bash
+pip install walacor-python-sdk
+```
+
+### From source (editable)
+
+```bash
+git clone https://github.com/walacor/python-sdk.git
+cd python-sdk
+pip install -e .[dev,test]
+```
+
+> After installation, import via `walacor_sdk` (underscore), **not** the PyPI name with a dash.
+
+```python
+from walacor_sdk import WalacorService
+```
+
+---
+
+## 🚀 Quick Start
+
+### 1 – Create a service instance
+
+```python
+from walacor_sdk import WalacorService
+
+wal = WalacorService(
+    server="http://[walacor.instance.address/api",
+    username="Admin",
+    password="Password!"
+)
+```
+
+Need to change credentials later?
+
+```python
+wal.changeCred("new_user", "new_password")
+```
+
+### 2 – Work with schemas
+
+```python
+from walacor_sdk.schema.models import (
+    CreateSchemaRequest, CreateSchemaDefinition,
+    CreateFieldRequest, CreateIndexRequest
+)
+
+schema_req = CreateSchemaRequest(
+    ETId=50,    # system envelope for schemas
+    SV=1,
+    Schema=CreateSchemaDefinition(
+        ETId=654321,
+        TableName="books",
+        Family="library",
+        DoSummary=True,
+        Fields=[
+            CreateFieldRequest(FieldName="book_id", DataType="TEXT", Required=True),
+            CreateFieldRequest(FieldName="title",   DataType="TEXT", Required=True)
+        ],
+        Indexes=[
+            CreateIndexRequest(Fields=["book_id"], IndexValue="book_id")
+        ]
+    )
+)
+
+meta = wal.schema.create_schema(schema_req)
+print("Created schema envelope:", meta.EId)
+```
+
+Other handy calls:
+
+```python
+# list latest versions for every ETId
+for s in wal.schema.get_list_with_latest_version():
+    print(s.ETId, s.TableName)
+
+# detailed info for a known ETId
+info = wal.schema.get_schema_details_with_ETId(654321)
+print(info.Fields)
+```
+
+### 3 – Use enums & constants
+
+```python
+from walacor_sdk.utils.enums import SystemEnvelopeType
+print(SystemEnvelopeType.SCHEMA.value)   # -> 50
+```
+
+---
+
+## ⚙️ Error handling & logging
+
+* Network errors raise `requests.HTTPError` so you can retry or surface gracefully.
+* Validation errors are logged with `logging.error` and result in `None`/`[]` returns, never raw dictionaries.
+* The SDK writes to the module‑level *walacor\_sdk.utils.logger* logger; attach your own handler or redirect to file.
+
+---
+
+## 🧪 Running tests
+
+```bash
+pip install .[test]
+pytest -q
+```
+
+---
+
+## 🤝 Contributing
+
+We love PRs! Please open an issue first for large features. All contributions must:
+
+* Pass `pre-commit` hooks (`pre-commit run --all-files`).
+* Include unit tests with `pytest`.
+* Follow the existing docstring & typing style.
+
+For full contribution details, see 👉 [CONTRIBUTING.md](CONTRIBUTING.md).
+
+---
+
+## 📄 License
+
+Apache 2.0 © 2025 Walacor & Contributors.

{walacor_python_sdk-0.1.1 → walacor_python_sdk-0.1.3}/src/walacor_python_sdk.egg-info/SOURCES.txt

@@ -12,10 +12,10 @@ src/walacor_python_sdk.egg-info/dependency_links.txt
 src/walacor_python_sdk.egg-info/requires.txt
 src/walacor_python_sdk.egg-info/top_level.txt
 src/walacor_sdk/__init__.py
+src/walacor_sdk/py.typed
 src/walacor_sdk/authentication/__init__.py
 src/walacor_sdk/authentication/auth_service.py
 src/walacor_sdk/authentication/models/__init__.py
-src/walacor_sdk/authentication/models/response.py
 src/walacor_sdk/base/__init__.py
 src/walacor_sdk/base/base_service.py
 src/walacor_sdk/base/facade.py

{walacor_python_sdk-0.1.1 → walacor_python_sdk-0.1.3}/src/walacor_python_sdk.egg-info/requires.txt

@@ -1,6 +1,11 @@
 requests>=2.32.3
 pydantic>=2.10
 
+[data-science]
+pandas>=2.0
+pyarrow>=14
+numpy>=1.26
+
 [dev]
 pre-commit
 tox

walacor_python_sdk-0.1.3/src/walacor_sdk/__init__.py

@@ -0,0 +1,26 @@
+import types
+
+from importlib import import_module
+from typing import TYPE_CHECKING
+
+from .base.walacor_service import WalacorService
+
+__all__: list[str] = [
+    "WalacorService",
+    "authentication",
+    "schema",
+    "file_request",
+    "data_requests",
+]
+
+
+def __getattr__(name: str) -> types.ModuleType:
+    if name in __all__[2:]:
+        mod = import_module(f"{__name__}.{name}")
+        globals()[name] = mod
+        return mod
+    raise AttributeError(name)
+
+
+if TYPE_CHECKING:  # pragma: no cover
+    from . import authentication, data_requests, file_request, schema

walacor_python_sdk-0.1.3/src/walacor_sdk/data_requests/__init__.py

@@ -0,0 +1,49 @@
+import types
+
+from importlib import import_module
+from typing import TYPE_CHECKING
+
+from .data_requests_service import DataRequestsService
+from .models.data_request_response import (
+    GetAllRecordsResponse,
+    GetComplexQMLQueryResponse,
+    GetComplexQueryResponse,
+    GetSingleRecordResponse,
+    QueryApiAggregateResponse,
+    QueryApiResponse,
+    SingleDataRequestResponse,
+)
+from .models.models import (
+    ComplexQMLQueryRecords,
+    ComplexQueryRecords,
+    QueryApiAggregate,
+    SubmissionResult,
+)
+
+__all__: list[str] = [
+    "DataRequestsService",
+    "SingleDataRequestResponse",
+    "GetAllRecordsResponse",
+    "GetSingleRecordResponse",
+    "GetComplexQueryResponse",
+    "QueryApiResponse",
+    "QueryApiAggregateResponse",
+    "GetComplexQMLQueryResponse",
+    "SubmissionResult",
+    "ComplexQueryRecords",
+    "QueryApiAggregate",
+    "ComplexQMLQueryRecords",
+    "models",
+]
+
+
+def __getattr__(name: str) -> types.ModuleType:
+    if name == "models":
+        mod = import_module(f"{__name__}.models")
+        globals()[name] = mod
+        return mod
+    raise AttributeError(name)
+
+
+if TYPE_CHECKING:  # pragma: no cover
+    from . import models