ergon-platform-sdk 0.1.0__tar.gz

ergon_platform_sdk-0.1.0/.gitignore

@@ -0,0 +1,218 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

ergon_platform_sdk-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ergondata Technologies
+
+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.

ergon_platform_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,167 @@
+Metadata-Version: 2.4
+Name: ergon-platform-sdk
+Version: 0.1.0
+Summary: Official Python client SDK for the Ergon Platform public API
+Project-URL: Homepage, https://github.com/ergondata-labs/ergon-platform-sdks
+Project-URL: Repository, https://github.com/ergondata-labs/ergon-platform-sdks
+Project-URL: Issues, https://github.com/ergondata-labs/ergon-platform-sdks/issues
+Author-email: Ergondata Technologies <anza.vossos@protonmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: api,client,ergon,sdk
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+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 :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.28.0
+Requires-Dist: pydantic[email]>=2.0.0
+Description-Content-Type: text/markdown
+
+# Ergon Platform SDK (Python)
+
+Typed Python client for the [Ergon Platform](https://github.com/ergondata-labs)
+public HTTP API. Async and sync, with automatic API-key authentication,
+retries, pagination, and typed errors.
+
+- Distribution: `ergon-platform-sdk`
+- Import root: `ergon_platform`
+
+> This is the **client** SDK (for consuming the platform API). It is unrelated
+> to `ergon-framework-python` (import root `ergon`), which is for *building*
+> services.
+
+## Install
+
+```bash
+pip install ergon-platform-sdk
+# or, in this workspace:
+uv sync
+```
+
+## Quick start
+
+### Synchronous
+
+```python
+from ergon_platform import ErgonClient
+
+# Machine-to-machine: the API key's company is baked into the issued token,
+# so you never pass company_id.
+client = ErgonClient(
+    client_id="ek_...",
+    client_secret="eks_...",
+    base_url="http://localhost",  # gateway origin
+)
+
+# IAM — `companies` is a uniform collection
+company = client.iam.companies.create(name="Acme")
+for key in client.iam.api_keys.iter(company_id=company.id):
+    print(key.name)
+
+# Workflows — the service node *is* the workflow resource (list/create are
+# company-scoped); drill into one workflow's subtree via the scope accessor.
+page = client.workflows.list(limit=50)  # company_id is inferred from the JWT
+for wf in page.items:
+    print(wf.id, wf.name)
+
+scope = client.workflows.workflow(page.items[0].id)
+scope.create_item(title="New ticket")          # POST workflows/{id}/items
+client.workflows.items.claim(item_id="...")     # id-addressed action
+```
+
+### Asynchronous
+
+```python
+import asyncio
+from ergon_platform import AsyncErgonClient
+
+
+async def main() -> None:
+    async with AsyncErgonClient(client_id="ek_...", client_secret="eks_...") as client:
+        # `iter` transparently follows pagination across pages
+        async for bucket in client.buckets.buckets.iter():
+            print(bucket.id, bucket.name)
+
+
+asyncio.run(main())
+```
+
+### Errors
+
+```python
+from ergon_platform import NotFoundError, PermissionDeniedError
+
+try:
+    client.iam.companies.get("does-not-exist")
+except NotFoundError as exc:
+    print(exc.status_code, exc.detail, exc.request_id)
+```
+
+## Authentication
+
+| Mode | Constructor args | Notes |
+|------|------------------|-------|
+| API key (M2M) | `client_id`, `client_secret` | Primary. Token exchanged + refreshed automatically. Tenant is implicit. |
+| Bearer token | `token=` | Pre-obtained JWT (e.g. a user access token). Pass `company_id=` if the token isn't pinned to a company. |
+
+## Services
+
+Ten services hang off the client:
+
+`client.iam`, `client.workflows`, `client.channels`, `client.agents`,
+`client.worksheets`, `client.buckets`, `client.event_streams`,
+`client.conversations`, `client.automations`, `client.apps`.
+
+## Conventions
+
+The facade follows the same shape across every service, so once you learn one
+you know them all:
+
+- **Collections** — a uniform REST resource exposes
+  `list` / `iter` / `get` / `create` / `update` / `delete`. For example
+  `client.buckets.buckets` or `client.iam.companies`.
+- **Pages** — `list(...)` returns a `Page` with `.items` and `.total`;
+  `iter(...)` is a generator (or async generator) that transparently walks
+  every page for you.
+- **Scopes** — resources nested under a parent id are reached through an
+  accessor that returns a sub-client, e.g.
+  `client.workflows.workflow(workflow_id)` exposes `workflows/{id}/*`, and
+  `client.buckets.buckets.access(bucket_id).grants` exposes the per-bucket
+  grant subtree.
+- **Actions** — non-CRUD endpoints are plain methods named after the verb,
+  e.g. `client.workflows.items.claim(item_id=...)` or
+  `.route(item_id=..., target_phase_id=...)`.
+- **Typing** — responses are parsed into generated Pydantic models when the
+  schema is unambiguous; otherwise a permissive model is used that preserves
+  every field the server returns (so new fields never break you).
+- **Escape hatch** — the full, fully-typed generated client and every schema
+  for every endpoint live under `ergon_platform._generated.<service>` if you
+  need an operation the facade doesn't surface ergonomically.
+
+Both `ErgonClient` and `AsyncErgonClient` expose the identical surface; the
+async variant returns awaitables / async iterators.
+
+## Coverage
+
+The facade wires **every public operation** of all ten services (see the
+generated matrix at [`docs/coverage.md`](https://github.com/ergondata-labs/ergon-platform-sdks/blob/main/docs/coverage.md)). Only each
+service's `/health` liveness probe is intentionally left out. A CI guard
+(`scripts/coverage.py --check`) fails the build if the platform grows a new
+endpoint that isn't wired, so the SDK can't silently drift behind the API.
+
+## Development
+
+```bash
+uv run python scripts/export_openapi.py   # refresh specs from a running platform
+uv run python scripts/generate.py          # regenerate the _generated client layer
+uv run python scripts/coverage.py          # regenerate docs/coverage.md
+uv run python scripts/coverage.py --check  # CI guard: fail on unwired endpoints
+uv run --package ergon-platform-sdk pytest # unit tests
+ERGON_INTEGRATION=1 uv run --package ergon-platform-sdk pytest -m integration
+```

ergon_platform_sdk-0.1.0/README.md

@@ -0,0 +1,142 @@
+# Ergon Platform SDK (Python)
+
+Typed Python client for the [Ergon Platform](https://github.com/ergondata-labs)
+public HTTP API. Async and sync, with automatic API-key authentication,
+retries, pagination, and typed errors.
+
+- Distribution: `ergon-platform-sdk`
+- Import root: `ergon_platform`
+
+> This is the **client** SDK (for consuming the platform API). It is unrelated
+> to `ergon-framework-python` (import root `ergon`), which is for *building*
+> services.
+
+## Install
+
+```bash
+pip install ergon-platform-sdk
+# or, in this workspace:
+uv sync
+```
+
+## Quick start
+
+### Synchronous
+
+```python
+from ergon_platform import ErgonClient
+
+# Machine-to-machine: the API key's company is baked into the issued token,
+# so you never pass company_id.
+client = ErgonClient(
+    client_id="ek_...",
+    client_secret="eks_...",
+    base_url="http://localhost",  # gateway origin
+)
+
+# IAM — `companies` is a uniform collection
+company = client.iam.companies.create(name="Acme")
+for key in client.iam.api_keys.iter(company_id=company.id):
+    print(key.name)
+
+# Workflows — the service node *is* the workflow resource (list/create are
+# company-scoped); drill into one workflow's subtree via the scope accessor.
+page = client.workflows.list(limit=50)  # company_id is inferred from the JWT
+for wf in page.items:
+    print(wf.id, wf.name)
+
+scope = client.workflows.workflow(page.items[0].id)
+scope.create_item(title="New ticket")          # POST workflows/{id}/items
+client.workflows.items.claim(item_id="...")     # id-addressed action
+```
+
+### Asynchronous
+
+```python
+import asyncio
+from ergon_platform import AsyncErgonClient
+
+
+async def main() -> None:
+    async with AsyncErgonClient(client_id="ek_...", client_secret="eks_...") as client:
+        # `iter` transparently follows pagination across pages
+        async for bucket in client.buckets.buckets.iter():
+            print(bucket.id, bucket.name)
+
+
+asyncio.run(main())
+```
+
+### Errors
+
+```python
+from ergon_platform import NotFoundError, PermissionDeniedError
+
+try:
+    client.iam.companies.get("does-not-exist")
+except NotFoundError as exc:
+    print(exc.status_code, exc.detail, exc.request_id)
+```
+
+## Authentication
+
+| Mode | Constructor args | Notes |
+|------|------------------|-------|
+| API key (M2M) | `client_id`, `client_secret` | Primary. Token exchanged + refreshed automatically. Tenant is implicit. |
+| Bearer token | `token=` | Pre-obtained JWT (e.g. a user access token). Pass `company_id=` if the token isn't pinned to a company. |
+
+## Services
+
+Ten services hang off the client:
+
+`client.iam`, `client.workflows`, `client.channels`, `client.agents`,
+`client.worksheets`, `client.buckets`, `client.event_streams`,
+`client.conversations`, `client.automations`, `client.apps`.
+
+## Conventions
+
+The facade follows the same shape across every service, so once you learn one
+you know them all:
+
+- **Collections** — a uniform REST resource exposes
+  `list` / `iter` / `get` / `create` / `update` / `delete`. For example
+  `client.buckets.buckets` or `client.iam.companies`.
+- **Pages** — `list(...)` returns a `Page` with `.items` and `.total`;
+  `iter(...)` is a generator (or async generator) that transparently walks
+  every page for you.
+- **Scopes** — resources nested under a parent id are reached through an
+  accessor that returns a sub-client, e.g.
+  `client.workflows.workflow(workflow_id)` exposes `workflows/{id}/*`, and
+  `client.buckets.buckets.access(bucket_id).grants` exposes the per-bucket
+  grant subtree.
+- **Actions** — non-CRUD endpoints are plain methods named after the verb,
+  e.g. `client.workflows.items.claim(item_id=...)` or
+  `.route(item_id=..., target_phase_id=...)`.
+- **Typing** — responses are parsed into generated Pydantic models when the
+  schema is unambiguous; otherwise a permissive model is used that preserves
+  every field the server returns (so new fields never break you).
+- **Escape hatch** — the full, fully-typed generated client and every schema
+  for every endpoint live under `ergon_platform._generated.<service>` if you
+  need an operation the facade doesn't surface ergonomically.
+
+Both `ErgonClient` and `AsyncErgonClient` expose the identical surface; the
+async variant returns awaitables / async iterators.
+
+## Coverage
+
+The facade wires **every public operation** of all ten services (see the
+generated matrix at [`docs/coverage.md`](https://github.com/ergondata-labs/ergon-platform-sdks/blob/main/docs/coverage.md)). Only each
+service's `/health` liveness probe is intentionally left out. A CI guard
+(`scripts/coverage.py --check`) fails the build if the platform grows a new
+endpoint that isn't wired, so the SDK can't silently drift behind the API.
+
+## Development
+
+```bash
+uv run python scripts/export_openapi.py   # refresh specs from a running platform
+uv run python scripts/generate.py          # regenerate the _generated client layer
+uv run python scripts/coverage.py          # regenerate docs/coverage.md
+uv run python scripts/coverage.py --check  # CI guard: fail on unwired endpoints
+uv run --package ergon-platform-sdk pytest # unit tests
+ERGON_INTEGRATION=1 uv run --package ergon-platform-sdk pytest -m integration
+```

ergon_platform_sdk-0.1.0/examples/debug_prod.py

@@ -0,0 +1,60 @@
+"""Smoke test against production — use with VS Code launch config (F5).
+
+Set breakpoints here or in ``ergon_platform._transport.http`` before running.
+
+Environment (via ``ergon-platform-sdks/.env`` or launch.json ``envFile``):
+
+    ERGON_BASE_URL=https://platform.ergondata.ai
+    ERGON_CLIENT_ID=ek_...
+    ERGON_CLIENT_SECRET=eks_...
+
+Note: ``iam.me()`` fails with API keys (401 User not found). Use ``iam.services()``
+for M2M auth verification — see INC-12 in docs/relatorio-sdk-auth-inconsistencias.md.
+"""
+
+from __future__ import annotations
+
+import os
+from pathlib import Path
+
+from ergon_platform import ErgonClient
+
+
+def _load_dotenv() -> None:
+    """Load ``ergon-platform-sdks/.env`` when not launched via VS Code envFile."""
+    env_path = Path(__file__).resolve().parents[2] / ".env"
+    if not env_path.is_file():
+        return
+    for line in env_path.read_text(encoding="utf-8").splitlines():
+        line = line.strip()
+        if not line or line.startswith("#"):
+            continue
+        key, _, value = line.partition("=")
+        key, value = key.strip(), value.strip()
+        if key and key not in os.environ:
+            os.environ[key] = value
+
+
+_load_dotenv()
+
+BASE_URL = os.environ.get("ERGON_BASE_URL", "https://platform.ergondata.ai")
+CLIENT_ID = os.environ["ERGON_CLIENT_ID"]
+CLIENT_SECRET = os.environ["ERGON_CLIENT_SECRET"]
+
+
+def main() -> None:
+    with ErgonClient(
+        client_id=CLIENT_ID,
+        client_secret=CLIENT_SECRET,
+        base_url=BASE_URL,
+    ) as client:
+        services = client.iam.services()
+        print(f"Auth OK — {len(services)} service(s) available")
+        for svc in services[:5]:
+            name = svc.get("name") if isinstance(svc, dict) else getattr(svc, "name", svc)
+            slug = svc.get("slug") if isinstance(svc, dict) else getattr(svc, "slug", "")
+            print(f"  - {name} ({slug})")
+
+
+if __name__ == "__main__":
+    main()

ergon_platform_sdk-0.1.0/examples/quickstart.py

@@ -0,0 +1,50 @@
+"""Quickstart for the Ergon Platform Python SDK.
+
+Run with real API key credentials::
+
+    ERGON_CLIENT_ID=ek_... ERGON_CLIENT_SECRET=eks_... \\
+        ERGON_BASE_URL=http://localhost \\
+        uv run python python/examples/quickstart.py
+"""
+
+from __future__ import annotations
+
+import asyncio
+import os
+
+from ergon_platform import AsyncErgonClient, ErgonAPIError, ErgonClient
+
+BASE_URL = os.getenv("ERGON_BASE_URL", "http://localhost")
+CLIENT_ID = os.environ["ERGON_CLIENT_ID"]
+CLIENT_SECRET = os.environ["ERGON_CLIENT_SECRET"]
+
+
+def sync_example() -> None:
+    # The API key's company is baked into the issued token, so no company_id.
+    with ErgonClient(client_id=CLIENT_ID, client_secret=CLIENT_SECRET, base_url=BASE_URL) as client:
+        me = client.iam.me()
+        print("Authenticated as:", me)
+
+        # Uniform collections expose create/get/list/iter/update/delete.
+        for bucket in client.buckets.buckets.iter(limit=25):
+            print("bucket:", bucket.id)
+
+        # Heterogeneous routes use the generic, path-relative verbs.
+        try:
+            page = client.workflows.get_page("companies/EXAMPLE_COMPANY_ID/workflows")
+            print("workflows total:", page.total)
+        except ErgonAPIError as exc:
+            print("workflows call failed:", exc.status_code, exc.detail)
+
+
+async def async_example() -> None:
+    async with AsyncErgonClient(
+        client_id=CLIENT_ID, client_secret=CLIENT_SECRET, base_url=BASE_URL
+    ) as client:
+        async for bucket in client.buckets.buckets.iter():
+            print("async bucket:", bucket.id)
+
+
+if __name__ == "__main__":
+    sync_example()
+    asyncio.run(async_example())