Datasphere-API 0.0.0__tar.gz → 0.1.1__tar.gz

datasphere_api-0.1.1/.commitlintrc.json

@@ -0,0 +1,7 @@
+{
+  "extends": ["@commitlint/config-conventional"],
+  "rules": {
+    "body-max-line-length": [0, "always", 100],
+    "footer-max-line-length": [0, "always", 100]
+  }
+}

datasphere_api-0.1.1/.editorconfig

@@ -0,0 +1,27 @@
+# Reference: https://editorconfig.org
+# Top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+# Default charset
+charset = utf-8
+
+# Indentation
+indent_style = space
+indent_size = 4
+
+# Whitespace
+trim_trailing_whitespace = true
+
+[*.py]
+max_line_length = 79
+
+[*.{yml,yaml,json,toml}]
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false

datasphere_api-0.1.1/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

datasphere_api-0.1.1/.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+
+  - package-ecosystem: "uv"
+    directory: "/"
+    schedule:
+      interval: "weekly"

datasphere_api-0.1.1/.github/workflows/ci.yml

@@ -0,0 +1,78 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    name: Lint (ruff)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+      - run: uv sync --no-dev
+      - run: uv run --with ruff ruff check .
+
+  test:
+    name: Test (Python ${{ matrix.python-version }} on ${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.12", "3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+      - run: uv python install ${{ matrix.python-version }}
+      - run: uv sync --python ${{ matrix.python-version }}
+      - run: uv run pytest
+
+  commitlint:
+    name: Commit messages
+    runs-on: ubuntu-latest
+    if: github.event_name == 'pull_request'
+    permissions:
+      contents: read
+      pull-requests: read
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: wagoid/commitlint-github-action@v6
+        with:
+          configFile: .commitlintrc.json
+
+  branch-name:
+    name: Branch name
+    runs-on: ubuntu-latest
+    if: github.event_name == 'pull_request'
+    steps:
+      - name: Validate branch name
+        run: |
+          name="${{ github.head_ref }}"
+          # Exempt automation branches whose names follow each tool's
+          # own convention (Dependabot, release-please).
+          if [[ "$name" == dependabot/* ]] \
+             || [[ "$name" == release-please--* ]]; then
+            echo "::notice::Skipping branch-name check for bot branch '$name'"
+            exit 0
+          fi
+          pattern='^(feat|fix|chore|docs|style|refactor|perf|test|build|ci|revert)/[a-z0-9._-]+$'
+          if ! echo "$name" | grep -Eq "$pattern"; then
+            echo "::error::Branch '$name' must match: $pattern"
+            exit 1
+          fi

datasphere_api-0.1.1/.github/workflows/release-please.yml

@@ -0,0 +1,19 @@
+name: release-please
+
+on:
+  push:
+    branches: [main]
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: googleapis/release-please-action@v5
+        with:
+          token: ${{ secrets.RELEASE_PLEASE_TOKEN }}
+          config-file: .release-please-config.json
+          manifest-file: .release-please-manifest.json

datasphere_api-0.1.1/.github/workflows/release.yml

@@ -0,0 +1,60 @@
+name: Release
+
+on:
+  push:
+    tags: ["v*"]
+
+permissions:
+  contents: read
+
+concurrency:
+  group: release-${{ github.ref }}
+  cancel-in-progress: false
+
+jobs:
+  build:
+    name: Build distributions
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v7
+      - run: uv build
+      - uses: actions/upload-artifact@v7
+        with:
+          name: dist
+          path: dist/
+          if-no-files-found: error
+
+  publish-pypi:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/Datasphere-API
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          skip-existing: true
+
+  github-release:
+    name: Upload distributions to GitHub Release
+    needs: publish-pypi
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist/
+      - uses: softprops/action-gh-release@v3
+        with:
+          tag_name: ${{ github.ref_name }}
+          files: dist/*

datasphere_api-0.1.1/.gitignore

@@ -0,0 +1,15 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+
+# Tool caches
+.pytest_cache/
+.ruff_cache/
+.coverage

datasphere_api-0.1.1/.pre-commit-config.yaml

@@ -0,0 +1,32 @@
+default_language_version:
+  python: python3.12
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml
+      - id: check-added-large-files
+      - id: check-merge-conflict
+      - id: mixed-line-ending
+        args: [--fix=lf]
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.12
+    hooks:
+      - id: ruff
+        args: [--fix]
+
+  - repo: https://github.com/compilerla/conventional-pre-commit
+    rev: v3.6.0
+    hooks:
+      - id: conventional-pre-commit
+        stages: [commit-msg]
+
+  - repo: https://github.com/gitleaks/gitleaks
+    rev: v8.30.1
+    hooks:
+      - id: gitleaks

datasphere_api-0.1.1/.python-version

@@ -0,0 +1 @@
+3.12

datasphere_api-0.1.1/.release-please-config.json

@@ -0,0 +1,25 @@
+{
+  "release-type": "python",
+  "bump-minor-pre-major": false,
+  "bump-patch-for-minor-pre-major": true,
+  "include-component-in-tag": false,
+  "pull-request-title-pattern": "chore: release ${version}",
+  "packages": {
+    ".": {
+      "package-name": "Datasphere-API",
+      "changelog-path": "CHANGELOG.md"
+    }
+  },
+  "changelog-sections": [
+    { "type": "feat",     "section": "Features" },
+    { "type": "fix",      "section": "Bug Fixes" },
+    { "type": "perf",     "section": "Performance" },
+    { "type": "refactor", "section": "Refactoring" },
+    { "type": "docs",     "section": "Documentation" },
+    { "type": "ci",       "section": "Continuous Integration", "hidden": true },
+    { "type": "chore",    "section": "Misc",                   "hidden": true },
+    { "type": "test",     "section": "Tests",                  "hidden": true },
+    { "type": "style",    "section": "Style",                  "hidden": true },
+    { "type": "build",    "section": "Build",                  "hidden": true }
+  ]
+}

datasphere_api-0.1.1/.release-please-manifest.json

@@ -0,0 +1 @@
+{".":"0.1.1"}

datasphere_api-0.1.1/.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+  "recommendations": [
+    "charliermarsh.ruff",
+    "editorconfig.editorconfig",
+    "vivaxy.vscode-conventional-commits"
+  ]
+}

datasphere_api-0.1.1/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "editor.rulers": [79]
+}

datasphere_api-0.1.1/CHANGELOG.md

@@ -0,0 +1,35 @@
+# Changelog
+
+## [0.1.1](https://github.com/peterschwps/SAP-Datasphere-API/compare/v0.1.0...v0.1.1) (2026-07-07)
+
+
+### Documentation
+
+* added readme badges ([7a96367](https://github.com/peterschwps/SAP-Datasphere-API/commit/7a96367516c011ad859063ef2aab9c37ee53a44e))
+
+## 0.1.0 (2026-07-07)
+
+
+### Features
+
+* added analytical models resource ([b8a939f](https://github.com/peterschwps/SAP-Datasphere-API/commit/b8a939f54c54f058f5896999e904d46f60bf5d44))
+* added async datasphere client ([0c76823](https://github.com/peterschwps/SAP-Datasphere-API/commit/0c76823581056c23b6d3b5583b0db623552e57ad))
+* added configuration and exceptions ([952a883](https://github.com/peterschwps/SAP-Datasphere-API/commit/952a883d42302361cf9696f042e002fe1e1c59d2))
+* added data models ([6bd54ca](https://github.com/peterschwps/SAP-Datasphere-API/commit/6bd54ca6bee10a3116b1b6418f974a520e0e4dbb))
+* added incremental result callbacks to all view batch methods ([cfa3bc7](https://github.com/peterschwps/SAP-Datasphere-API/commit/cfa3bc78235b28820af3ab49d1fe5f8dc244bbcc))
+* added remote tables resource ([c30d832](https://github.com/peterschwps/SAP-Datasphere-API/commit/c30d832754c2ffef77b15ac41bb9b3e7dfe92ca7))
+* added task chains resource ([024e3cd](https://github.com/peterschwps/SAP-Datasphere-API/commit/024e3cdfe25fab2e5a87867ab5584374d43313d1))
+* added token store and oauth authentication ([9fc89b3](https://github.com/peterschwps/SAP-Datasphere-API/commit/9fc89b30deb1662a24938fabb32754d1e642b6ee))
+* added views resource ([0e38058](https://github.com/peterschwps/SAP-Datasphere-API/commit/0e380581fe535ea0d3bb303fe2b2d4d40c7fe598))
+* exported public api ([1a7bb5d](https://github.com/peterschwps/SAP-Datasphere-API/commit/1a7bb5dfbb99bd498ac4cd6bf7bdbee33f42dfeb))
+
+
+### Documentation
+
+* added readme ([cab9a3d](https://github.com/peterschwps/SAP-Datasphere-API/commit/cab9a3d3f06d2cdad455d6823ea23e707ce29572))
+* updated cli repository link ([9c83f95](https://github.com/peterschwps/SAP-Datasphere-API/commit/9c83f953e07b2e361e42649fd957a6f6367fa893))
+
+
+### Continuous Integration
+
+* added release-please and pypi release pipeline ([e11b56e](https://github.com/peterschwps/SAP-Datasphere-API/commit/e11b56e1be80db58fbf4edd843cf210be9f2e6f2))

datasphere_api-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Peter Schwips
+
+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.

datasphere_api-0.1.1/PKG-INFO

@@ -0,0 +1,148 @@
+Metadata-Version: 2.4
+Name: Datasphere-API
+Version: 0.1.1
+Summary: Unofficial async Python client for the SAP Datasphere automation APIs.
+Project-URL: Homepage, https://github.com/peterschwps/SAP-Datasphere-API
+Project-URL: Repository, https://github.com/peterschwps/SAP-Datasphere-API
+Project-URL: Issues, https://github.com/peterschwps/SAP-Datasphere-API/issues
+Author: Peter Schwips
+License-Expression: MIT
+License-File: LICENSE
+Keywords: API,Async,Automation,Client,Datasphere,SAP
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: platformdirs>=4.4.0
+Requires-Dist: playwright>=1.54.0
+Description-Content-Type: text/markdown
+
+# Datasphere-API
+
+[![CI](https://github.com/peterschwps/SAP-Datasphere-API/actions/workflows/ci.yml/badge.svg)](https://github.com/peterschwps/SAP-Datasphere-API/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/Datasphere-API)](https://pypi.org/project/Datasphere-API/)
+[![Python](https://img.shields.io/pypi/pyversions/Datasphere-API)](https://pypi.org/project/Datasphere-API/)
+
+Unofficial async Python client for the SAP Datasphere automation APIs.
+This library powers the
+[SAP-Datasphere-CLI](https://github.com/peterschwps/SAP-Datasphere-CLI)
+and can be used to build your own automations (e.g. MCP servers or
+scheduled jobs).
+
+> [!NOTE]
+> This project is not affiliated with, endorsed by, or supported by SAP.
+> It uses the same internal HTTP endpoints as the SAP Datasphere web UI,
+> which may change without notice.
+
+## Features
+
+- **Views**: export view analytics (persistence candidates), search
+  views by attribute, persist/unpersist views, create/remove partitions,
+  lock/unlock partitions.
+- **Remote Tables**: list tables with statistics information,
+  create/update statistics (Record Count / Simple / Histogram), refresh
+  statistics.
+- **Task Chains**: run task chains and wait for their completion.
+- **Analytical Models**: export models with all their views (optionally
+  per space), measure view persistence runtimes.
+- **OAuth login included**: interactive authorization code flow via a
+  real Chrome/Edge window (Playwright) with automatic token refresh and
+  a shared token cache.
+
+## Installation
+
+```bash
+uv add datasphere-api
+# or
+pip install datasphere-api
+```
+
+The interactive login drives an installed Chrome or Edge browser via
+Playwright channels — a regular Chrome/Edge installation is required,
+no `playwright install` download is needed.
+
+## Quickstart
+
+```python
+import asyncio
+
+from datasphere_api import DatasphereClient, DatasphereConfig
+
+
+async def main() -> None:
+    config = DatasphereConfig(
+        base_url="https://example.eu10.hcs.cloud.sap",
+        authorization_url=(
+            "https://example.authentication.eu10.hana.ondemand.com"
+            "/oauth/authorize"
+        ),
+        token_url=(
+            "https://example.authentication.eu10.hana.ondemand.com"
+            "/oauth/token"
+        ),
+        client_id="...",
+        client_secret="...",
+    )
+    client = DatasphereClient(config)
+    try:
+        await client.login()
+        results = await client.task_chains.run(
+            chains=[{"entity": "MY_CHAIN", "space": "MY_SPACE"}],
+        )
+        print(results)
+    finally:
+        await client.aclose()
+
+
+asyncio.run(main())
+```
+
+The URLs and credentials can be found in your tenant under
+System > Administration (Tenant Links and App Integration). The OAuth
+client has to be of type "Interactive Usage" with the redirect URI
+`http://localhost:8080`.
+
+## Authentication
+
+`client.login()` first tries to refresh cached tokens from the token
+store (`session.json` in the user data directory of `Datasphere`). If no
+tokens are cached or the refresh fails, a browser window opens for the
+interactive login. All consumers of this library share the same token
+cache, so a login in one tool also benefits the others.
+
+## Layered results
+
+The library returns data on two levels:
+
+- **Curated results** (recommended): high-level operations like
+  `views.persist_views()` or `remote_tables.create_statistics()` return
+  small, typed result structures (see `datasphere_api.models`). Their
+  keys intentionally match the CSV/JSON exports of the CLI.
+- **Raw payloads**: low-level fetchers like `views.get_all_views()` or
+  `remote_tables.get_all_tables()` return the parsed API payload, typed
+  with broad TypedDicts. For anything not covered, `client.session` is
+  the authenticated `httpx.AsyncClient` — you can call any endpoint
+  directly.
+
+Long-running batch operations accept an `on_result`/`on_update`
+callback that is invoked after every finished item, so consumers can
+save intermediate results during runs that take hours.
+
+## Development
+
+```bash
+uv sync
+uv run pytest
+uv run ruff check .
+uv run pyright
+```
+
+## License
+
+[MIT](LICENSE)

datasphere_api-0.1.1/README.md

@@ -0,0 +1,123 @@
+# Datasphere-API
+
+[![CI](https://github.com/peterschwps/SAP-Datasphere-API/actions/workflows/ci.yml/badge.svg)](https://github.com/peterschwps/SAP-Datasphere-API/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/Datasphere-API)](https://pypi.org/project/Datasphere-API/)
+[![Python](https://img.shields.io/pypi/pyversions/Datasphere-API)](https://pypi.org/project/Datasphere-API/)
+
+Unofficial async Python client for the SAP Datasphere automation APIs.
+This library powers the
+[SAP-Datasphere-CLI](https://github.com/peterschwps/SAP-Datasphere-CLI)
+and can be used to build your own automations (e.g. MCP servers or
+scheduled jobs).
+
+> [!NOTE]
+> This project is not affiliated with, endorsed by, or supported by SAP.
+> It uses the same internal HTTP endpoints as the SAP Datasphere web UI,
+> which may change without notice.
+
+## Features
+
+- **Views**: export view analytics (persistence candidates), search
+  views by attribute, persist/unpersist views, create/remove partitions,
+  lock/unlock partitions.
+- **Remote Tables**: list tables with statistics information,
+  create/update statistics (Record Count / Simple / Histogram), refresh
+  statistics.
+- **Task Chains**: run task chains and wait for their completion.
+- **Analytical Models**: export models with all their views (optionally
+  per space), measure view persistence runtimes.
+- **OAuth login included**: interactive authorization code flow via a
+  real Chrome/Edge window (Playwright) with automatic token refresh and
+  a shared token cache.
+
+## Installation
+
+```bash
+uv add datasphere-api
+# or
+pip install datasphere-api
+```
+
+The interactive login drives an installed Chrome or Edge browser via
+Playwright channels — a regular Chrome/Edge installation is required,
+no `playwright install` download is needed.
+
+## Quickstart
+
+```python
+import asyncio
+
+from datasphere_api import DatasphereClient, DatasphereConfig
+
+
+async def main() -> None:
+    config = DatasphereConfig(
+        base_url="https://example.eu10.hcs.cloud.sap",
+        authorization_url=(
+            "https://example.authentication.eu10.hana.ondemand.com"
+            "/oauth/authorize"
+        ),
+        token_url=(
+            "https://example.authentication.eu10.hana.ondemand.com"
+            "/oauth/token"
+        ),
+        client_id="...",
+        client_secret="...",
+    )
+    client = DatasphereClient(config)
+    try:
+        await client.login()
+        results = await client.task_chains.run(
+            chains=[{"entity": "MY_CHAIN", "space": "MY_SPACE"}],
+        )
+        print(results)
+    finally:
+        await client.aclose()
+
+
+asyncio.run(main())
+```
+
+The URLs and credentials can be found in your tenant under
+System > Administration (Tenant Links and App Integration). The OAuth
+client has to be of type "Interactive Usage" with the redirect URI
+`http://localhost:8080`.
+
+## Authentication
+
+`client.login()` first tries to refresh cached tokens from the token
+store (`session.json` in the user data directory of `Datasphere`). If no
+tokens are cached or the refresh fails, a browser window opens for the
+interactive login. All consumers of this library share the same token
+cache, so a login in one tool also benefits the others.
+
+## Layered results
+
+The library returns data on two levels:
+
+- **Curated results** (recommended): high-level operations like
+  `views.persist_views()` or `remote_tables.create_statistics()` return
+  small, typed result structures (see `datasphere_api.models`). Their
+  keys intentionally match the CSV/JSON exports of the CLI.
+- **Raw payloads**: low-level fetchers like `views.get_all_views()` or
+  `remote_tables.get_all_tables()` return the parsed API payload, typed
+  with broad TypedDicts. For anything not covered, `client.session` is
+  the authenticated `httpx.AsyncClient` — you can call any endpoint
+  directly.
+
+Long-running batch operations accept an `on_result`/`on_update`
+callback that is invoked after every finished item, so consumers can
+save intermediate results during runs that take hours.
+
+## Development
+
+```bash
+uv sync
+uv run pytest
+uv run ruff check .
+uv run pyright
+```
+
+## License
+
+[MIT](LICENSE)