semanticfed-sdk 2026.1031.1__tar.gz

semanticfed_sdk-2026.1031.1/.gitignore

@@ -0,0 +1,172 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$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
+
+# 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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.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 added to the global gitignore or merged into this project gitignore.  For a PyCharm
+#  project, it is recommended to include the following directory since it contains user-specific
+#  configurations:
+.idea/
+
+# VSCode
+.vscode/
+
+# OS generated files
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db

semanticfed_sdk-2026.1031.1/CHANGELOG.md

@@ -0,0 +1,49 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [CalVer](https://calver.org/) (`YYYY.MDD.PATCH`).
+
+## [Unreleased]
+
+### Changed (BOFF-4275)
+- First public release on PyPI as `semanticfed-sdk`, through the shared G60
+  release workflow (`release.yml`): CalVer tag or dispatch, hash-locked build
+  from `uv.lock`, upload, wheel smoke import, git tag and GitHub Release.
+- `__version__` comes from the installed distribution instead of a hard-coded
+  string, and is sent as the product version.
+- Requires `burdenoff-sdk-libs` 2026.1029.1.
+- The SDK presents the SemanticFed app Origin (`https://app.semanticfed.com`,
+  or `https://alphaapp.semanticfed.com` for the alpha gateway) so the workspace
+  gateway resolves product access and RBAC to SemanticFed. Override it with
+  `product_origin=` or `SEMANTICFED_ORIGIN`.
+- `SEMANTICFED_MODULES`, `SEMANTICFED_PRODUCT_ORIGINS` and
+  `resolve_product_origin` are exported.
+
+### Added
+- `tests/test_graphql_documents.py` validates every SemanticFed GraphQL
+  document against the vendored production workspace supergraph
+  (`schema/wspace.graphql`); CI runs it as a named step together with mypy.
+
+### Changed
+- Rewrote the SDK as a thin shell over `burdenoff-sdk-libs`. The hand-vendored
+  per-feature module tree (client, types, auth, user, workspace, rbac, team,
+  project, resources, billing, organization, payment, quota, store, support,
+  usage, utils, addon, plan, product) and its mock-based tests were removed.
+- All module surfaces are now nested under their owning module. The Semanticfed
+  domain bundle is reached via `sdk.semanticfed.<entity>` (connectors,
+  data_sources, connections, models, entities, dimensions, metrics,
+  relationships, queries, query_runs, access_policies, health).
+
+### Added
+- `SemanticfedSDK` facade mounting 23 modules from `burdenoff-sdk-libs`: the
+  shared generic set plus the `semanticfed` domain module and the standalone
+  `sandbox` module.
+- Shared-gateway defaults and the `burdenoff_cli_semanticfed` OIDC client id.
+- `py.typed` marker shipped in the wheel; strict mypy in CI.
+- Real-construction smoke tests (no mocks).
+
+### Removed
+- Vendored module directories under `src/semanticfed_sdk/` and the mock-based
+  unit tests.

semanticfed_sdk-2026.1031.1/LICENSE

@@ -0,0 +1,9 @@
+Copyright (c) 2025 Burdenoff Consultancy Services Private Limited, Algoshred Technologies Private Limited and all sister companies.
+
+All rights reserved.
+
+This software is proprietary and confidential. Unauthorized copying, modification, distribution, or use of this software, via any medium, is strictly prohibited without the express written permission of the copyright holders.
+
+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.
+
+For licensing inquiries, please contact: legal@algoshred.com

semanticfed_sdk-2026.1031.1/PKG-INFO

@@ -0,0 +1,269 @@
+Metadata-Version: 2.5
+Name: semanticfed-sdk
+Version: 2026.1031.1
+Summary: Official Python SDK for SemanticFed, the federated semantic layer (thin shell over burdenoff-sdk-libs)
+Project-URL: Homepage, https://semanticfed.com
+Project-URL: Documentation, https://github.com/algoshred/semanticfed-sdk-python#readme
+Project-URL: Repository, https://github.com/algoshred/semanticfed-sdk-python
+Project-URL: Issues, https://github.com/algoshred/semanticfed-sdk-python/issues
+Project-URL: Changelog, https://github.com/algoshred/semanticfed-sdk-python/blob/main/CHANGELOG.md
+Author-email: "Vignesh T.V" <vignesh@algoshred.com>
+Maintainer-email: "Vignesh T.V" <vignesh@algoshred.com>
+License: Copyright (c) 2025 Burdenoff Consultancy Services Private Limited, Algoshred Technologies Private Limited and all sister companies.
+        
+        All rights reserved.
+        
+        This software is proprietary and confidential. Unauthorized copying, modification, distribution, or use of this software, via any medium, is strictly prohibited without the express written permission of the copyright holders.
+        
+        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.
+        
+        For licensing inquiries, please contact: legal@algoshred.com
+License-File: LICENSE
+Keywords: api-client,burdenoff,graphql,python,sdk,semantic-layer,semanticfed
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: Other/Proprietary License
+Classifier: Operating System :: OS Independent
+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: Topic :: Internet :: WWW/HTTP :: HTTP Servers
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Requires-Dist: burdenoff-sdk-libs>=2026.1029.1
+Requires-Dist: httpx>=0.24.0
+Requires-Dist: typing-extensions>=4.0.0; python_version < '3.11'
+Provides-Extra: dev
+Requires-Dist: black>=23.0.0; extra == 'dev'
+Requires-Dist: flake8>=6.0.0; extra == 'dev'
+Requires-Dist: graphql-core>=3.2.0; extra == 'dev'
+Requires-Dist: isort>=5.12.0; extra == 'dev'
+Requires-Dist: mypy>=1.0.0; extra == 'dev'
+Requires-Dist: pre-commit>=3.0.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Requires-Dist: respx>=0.21.0; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: sphinx-autodoc-typehints>=1.19.0; extra == 'docs'
+Requires-Dist: sphinx-rtd-theme>=1.2.0; extra == 'docs'
+Requires-Dist: sphinx>=6.0.0; extra == 'docs'
+Provides-Extra: test
+Requires-Dist: pytest-asyncio>=0.21.0; extra == 'test'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'test'
+Requires-Dist: pytest>=7.0.0; extra == 'test'
+Requires-Dist: respx>=0.21.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+# semanticfed-sdk
+
+Official Python SDK for [SemanticFed](https://semanticfed.com), the federated semantic layer. It gives scripts, notebooks, CI/CD jobs and data pipelines async, typed access to connectors, data sources, semantic models, entities, dimensions, metrics, relationships, governed queries and access policies.
+
+This SDK is a thin shell over [`burdenoff-sdk-libs`](https://pypi.org/project/burdenoff-sdk-libs/). It talks to the Burdenoff production gateways by default and presents the SemanticFed app Origin, so product access and RBAC resolve to SemanticFed for every call.
+
+Node.js users: see [`@burdenoff/semanticfed-sdk`](https://www.npmjs.com/package/@burdenoff/semanticfed-sdk).
+
+## Features
+
+- Async/await throughout, built on `httpx`
+- Workspace-token auth for pipelines, plus email/password, device code, PKCE and client credentials
+- Automatic token refresh and a typed error hierarchy
+- 23 mounted modules: the shared platform set, `semanticfed` and `sandbox`
+- Full type hints with a `py.typed` marker; Python 3.10+
+
+## Installation
+
+```bash
+pip install semanticfed-sdk
+# or
+uv add semanticfed-sdk
+```
+
+## Quick start
+
+```python
+import asyncio
+import os
+
+from semanticfed_sdk import SemanticfedSDK
+
+
+async def main() -> None:
+    # Production gateways are the default. A workspace-scoped token is all a
+    # pipeline needs; the access token is used to mint or refresh it.
+    sdk = SemanticfedSDK(
+        access_token=os.environ["SEMANTICFED_ACCESS_TOKEN"],
+        workspace_token=os.environ["SEMANTICFED_WORKSPACE_TOKEN"],
+    )
+    try:
+        connectors = await sdk.semanticfed.connectors.list()
+        models = await sdk.semanticfed.models.list(status="PUBLISHED")
+        print(len(connectors.items), "connectors,", len(models.items), "published models")
+    finally:
+        await sdk.close()
+
+
+asyncio.run(main())
+```
+
+## Managing a semantic model
+
+```python
+from burdenoff_sdk_libs.modules.semanticfed.types import (
+    SemCreateConnectorInput,
+    SemCreateDataSourceInput,
+    SemCreateDimensionInput,
+    SemCreateEntityInput,
+    SemCreateMetricInput,
+    SemCreateModelInput,
+)
+
+s = sdk.semanticfed
+connector = await s.connectors.create(SemCreateConnectorInput(name="Warehouse", kind="POSTGRES"))
+source = await s.data_sources.create(
+    SemCreateDataSourceInput(connector_id=connector.id, name="analytics")
+)
+model = await s.models.create(SemCreateModelInput(name="Revenue", tags=["finance"]))
+orders = await s.entities.create(
+    SemCreateEntityInput(
+        model_id=model.id,
+        name="orders",
+        kind="TABLE",
+        data_source_id=source.id,
+        physical_name="public.orders",
+        primary_key="id",
+    )
+)
+await s.dimensions.create(SemCreateDimensionInput(entity_id=orders.id, name="region", data_type="STRING"))
+await s.metrics.create(
+    SemCreateMetricInput(entity_id=orders.id, name="gmv", aggregation="SUM", expression="amount")
+)
+await s.models.publish(model.id)
+```
+
+## Running a governed query
+
+```python
+from burdenoff_sdk_libs.modules.semanticfed.types import SemCreateQueryInput, SemPaginationInput
+
+query = await s.queries.create(
+    SemCreateQueryInput(
+        name="GMV by region",
+        model_id=model.id,
+        query_text="SELECT region, gmv FROM orders",
+        cacheable=True,
+        cache_ttl_seconds=300,
+    )
+)
+await s.queries.publish(query.id)
+
+run = await s.queries.run(query.id)
+finished = await s.query_runs.get(run.id)
+result = await s.query_runs.result(run.id, SemPaginationInput(limit=100))
+print(finished.status if finished else None, [c.name for c in result.columns], result.rows)
+```
+
+Access policies (`s.access_policies.list/create/set_active`) apply to every query the SDK runs, exactly as they do in the app.
+
+## API surface
+
+| Namespace | Operations |
+|---|---|
+| `connectors` | `get`, `list`, `create`, `update`, `archive` |
+| `data_sources` | `get`, `list`, `create`, `update`, `archive`, `transition` |
+| `connections` | `list`, `record` |
+| `models` | `get`, `list`, `create`, `update`, `archive`, `publish` |
+| `entities` | `get`, `list`, `create`, `update`, `delete` |
+| `dimensions`, `metrics` | `create` |
+| `relationships` | `list`, `create` |
+| `queries` | `get`, `list`, `create`, `update`, `archive`, `publish`, `run` |
+| `query_runs` | `get`, `list`, `result` |
+| `access_policies` | `list`, `create`, `set_active` |
+| `health` | `check` |
+
+Every document the SDK sends is validated in CI against the production workspace supergraph (`tests/test_graphql_documents.py`).
+
+## Modules
+
+All methods are async. The following modules are mounted on the `SemanticfedSDK`
+instance: `auth`, `billing`, `channels`, `conversations`, `devportal`,
+`export`, `files`, `groups`, `health`, `integrations`, `semanticfed`,
+`notifications`, `organizations`, `products`, `rbac`, `sandbox`, `scheduler`,
+`security`, `store`, `support`, `tags`, `tours`, `workspaces`.
+
+## Configuration
+
+```python
+from semanticfed_sdk import SemanticfedSDK
+
+sdk = SemanticfedSDK(
+    workspace_endpoint=None,   # SEMANTICFED_WORKSPACE_ENDPOINT, BURDENOFF_WORKSPACE_ENDPOINT, then prod
+    global_endpoint=None,      # SEMANTICFED_GLOBAL_ENDPOINT, BURDENOFF_GLOBAL_ENDPOINT, then prod
+    product_origin=None,       # SEMANTICFED_ORIGIN, then the app shell of a known gateway
+    client_id="burdenoff_cli_semanticfed",   # default
+    oidc_issuer=None,                       # derived from global_endpoint
+    api_key=None,
+    access_token=None,
+    refresh_token=None,
+    workspace_token=None,
+    timeout=30.0,
+    auto_refresh=True,
+)
+```
+
+## Error Handling
+
+```python
+from semanticfed_sdk import (
+    SemanticfedError,
+    AuthenticationError,
+    AuthorizationError,
+    NetworkError,
+    ValidationError,
+    RateLimitError,
+    DeviceCodeExpiredError,
+    DeviceCodeDeniedError,
+)
+
+try:
+    await sdk.auth.sign_in(email="user@example.com", password="wrong")
+except AuthenticationError:
+    print("Invalid credentials")
+except NetworkError:
+    print("Could not reach the API")
+except SemanticfedError as e:
+    print(f"SDK error: {e}")
+```
+
+## Development
+
+```bash
+python -m venv .venv && source .venv/bin/activate
+pip install -e ".[dev]"
+
+make format        # black + isort
+make lint          # flake8
+make type-check    # mypy (strict)
+make test          # pytest
+make sanity        # format-check + lint + type-check + test (cov>=80) + build
+```
+
+The release install is hash-locked: `uv sync --locked --all-extras` reproduces it.
+
+## Releasing
+
+Releases are cut from `main` by `.github/workflows/release.yml` (shared G60
+workflow): push a CalVer tag (`2026.1031.1`) or dispatch the workflow with an
+empty version. The run gates and builds from `uv.lock`, uploads to PyPI,
+smoke-imports the published wheel and creates the git tag and GitHub Release.
+
+## License
+
+Proprietary — Copyright Burdenoff Consultancy Services Pvt. Ltd.
+
+## Support
+
+- Issues: [GitHub Issues](https://github.com/algoshred/semanticfed-sdk-python/issues)