getdx 0.1.0__tar.gz

getdx-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,61 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint:
+    name: Lint, Format & Type-check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: uv sync --dev
+
+      - name: Check formatting
+        run: uv run ruff format --check src/ tests/
+
+      - name: Lint
+        run: uv run ruff check src/ tests/
+
+      - name: Type check
+        run: uv run mypy src/
+
+  test:
+    name: Test (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --dev
+
+      - name: Run tests with coverage
+        run: uv run pytest
+
+      - name: Upload coverage artifact
+        if: matrix.python-version == '3.12'
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-xml
+          path: coverage.xml
+          if-no-files-found: ignore

getdx-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,33 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build-and-publish:
+    name: Build and publish to PyPI
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+      contents: read
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Set up Python 3.12
+        run: uv python install 3.12
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

getdx-0.1.0/.gitignore

@@ -0,0 +1,18 @@
+__pycache__/
+.pytest_cache/
+.ruff_cache/
+.venv/
+*.pyc
+dist/
+build/
+*.egg-info/
+.env
+.mypy_cache/
+.coverage
+coverage.xml
+htmlcov/
+.claude/
+.omc/
+
+# Local-only readiness checklist
+TODO.md

getdx-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,17 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.9
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml
+      - id: check-merge-conflict
+      - id: check-added-large-files

getdx-0.1.0/CHANGELOG.md

@@ -0,0 +1,82 @@
+# 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.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-05-21
+
+### Added
+
+#### Core client
+- `DXClient` — top-level sync client exposing `web` and `data_cloud` namespaces via a context-manager interface.
+- `DXWebConfig` and `DXDataCloudConfig` — frozen dataclass configuration objects for each API.
+- `DXClientConfig` — composite config for passing both configs together.
+- `DXClientNotConfiguredError` raised when an unconfigured namespace is accessed.
+
+#### DX Web API client (`client.web`)
+- `entities` — list, info, scorecards, and tasks operations.
+- `entity_relations` — list entity relationships with cursor-based pagination.
+- `entity_types` — entity type listing.
+- `scorecards` — scorecard listing and detail operations.
+- `teams` — team listing and detail operations.
+- `users` — user listing and detail operations.
+- `user_groups` — user group operations.
+- `events` — event ingestion and listing.
+- `initiatives` — initiative listing and detail operations.
+- `orgfiles` — org file operations.
+- `platformx` — PlatformX operations.
+- `queries` — query execution operations.
+- `snapshots` — snapshot operations.
+- `workflow_runs` — workflow run operations.
+- `aggregates` — higher-level helpers built on top of core services:
+  - `entity_overview(identifier)` — fetches entity info, scorecards, and tasks in a single call and returns an `EntityOverview` dataclass.
+  - `entity_relations(identifier, ...)` — fetches all pages of entity relations and returns an `EntityRelationsGraph` dataclass with resolved nodes and edges.
+
+#### DX Data Cloud API client (`client.data_cloud`)
+- `custom_data` — upsert and delete custom data records; convenience helpers `delete_by_id` and `delete_by_reference_key`.
+- `deployments` — deployment record operations; convenience helpers `set_pull_services_by_github_pull_id` and `set_pull_services_by_repo_and_number`.
+- `incidents` — incident record operations.
+- `pipeline_runs` — pipeline run record operations.
+- `repo_groups` — repository group get and upsert operations.
+- `ai_tool_metrics` — AI tool metrics operations.
+
+#### Error hierarchy
+- `DXAPIError` — base exception for all SDK errors.
+- `DXClientConfigurationError` — raised for invalid or incomplete client configuration.
+- `DXClientNotConfiguredError` — raised when accessing a namespace that was not configured.
+- `DXArgumentError` — raised for invalid arguments passed to SDK methods.
+- `DXResponseError` — raised for HTTP error responses; carries `status_code`, `response_json`, and `response_text`.
+- `DXTransportError` — raised for network-level transport failures.
+- `DXAuthError` — raised on HTTP 401 responses.
+- `DXPermissionError` — raised on HTTP 403 responses.
+- `DXFeatureUnavailableError` — raised when a feature is not available for the account.
+- `DXValidationError` — raised on HTTP 422 / request validation failures.
+- `DXRateLimitError` — raised on HTTP 429; carries `retry_after_seconds` when the server provides a `Retry-After` header.
+- `DXServerError` — raised on HTTP 5xx responses.
+
+#### Retry and transport
+- `RetryConfig` — frozen dataclass controlling `max_attempts`, exponential `backoff_base_seconds` / `backoff_max_seconds`, and the set of `retry_statuses` (default: 429, 500, 502, 503, 504).
+- Automatic exponential back-off for GET requests; honours the `Retry-After` response header for rate-limit delays.
+- Retries on `httpx.TransportError` for GET requests.
+
+#### Auto-generated service wrappers
+- Web API and Data Cloud API service modules generated from OpenAPI specs via `scripts/generate_from_openapi.py`.
+- Regeneration script accepts `--api-name` and `--spec` arguments to target either API.
+
+#### Packaging and typing
+- `py.typed` marker included in the wheel (PEP 561 compliant; fully typed package).
+- Supports Python 3.10, 3.11, 3.12, and 3.13.
+- Runtime dependencies: `httpx>=0.27.0`, `typing-extensions>=4.12.0`.
+- Built with `hatchling>=1.25.0`.
+
+#### Environment variable fallbacks
+- `DX_WEB_API_TOKEN` — fallback token for the Web API.
+- `DX_DATA_CLOUD_TOKEN` — fallback token for the Data Cloud API.
+- `DX_DATA_CLOUD_INSTANCE` — fallback instance name for the Data Cloud API base URL.
+
+[Unreleased]: https://github.com/priiiiit/dx-python/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/priiiiit/dx-python/releases/tag/v0.1.0

getdx-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,118 @@
+# Contributing to getdx
+
+Thank you for your interest in contributing! This guide covers everything you need to get started.
+
+## Development Setup
+
+This project uses [uv](https://docs.astral.sh/uv/) for dependency management.
+
+```bash
+# Clone the repository
+git clone https://github.com/priiiiit/dx-python.git
+cd dx-python
+
+# Install all dependencies including dev extras
+uv sync --dev
+```
+
+**Requirements:** Python 3.10+
+
+## Project Structure
+
+```
+src/getdx/        # Package source code
+tests/            # Test suite
+scripts/          # Code generation and other utilities
+specs/            # OpenAPI specifications
+```
+
+## Running Tests
+
+```bash
+uv run pytest
+```
+
+Tests use [pytest-httpx](https://github.com/Colin-b/pytest-httpx) to mock HTTP interactions. Please add tests for any new functionality or bug fixes.
+
+Optional live smoke tests (require real API credentials):
+
+```bash
+RUN_LIVE_DX_TESTS=1 uv run pytest tests/live -q
+```
+
+## Code Style
+
+This project uses [ruff](https://docs.astral.sh/ruff/) for formatting and linting (line length: 100).
+
+```bash
+# Format code
+uv run ruff format .
+
+# Lint code
+uv run ruff check .
+
+# Auto-fix lint issues where possible
+uv run ruff check --fix .
+```
+
+Please ensure your code passes both format and lint checks before opening a pull request.
+
+### Pre-commit hooks
+
+Install [pre-commit](https://pre-commit.com/) hooks so format, lint, and basic
+file-hygiene checks run automatically on every commit:
+
+```bash
+uv run pre-commit install
+```
+
+You can run all hooks against the full tree on demand:
+
+```bash
+uv run pre-commit run --all-files
+```
+
+### Type checking
+
+This project is fully typed (`py.typed`). Type checks must pass on `src/`:
+
+```bash
+uv run mypy src/
+```
+
+## Auto-Generated API Services
+
+The service wrappers for the DX Web API and DX Data Cloud API are **auto-generated** from OpenAPI specifications via `scripts/generate_from_openapi.py`. Do not hand-edit these files — any manual changes will be overwritten the next time code generation runs.
+
+To regenerate the API wrappers after updating a spec:
+
+```bash
+# Regenerate from the DX Web API spec
+uv run python scripts/generate_from_openapi.py --api-name web --spec specs/dx_web_api_openapi.json
+
+# Regenerate from the DX Data Cloud API spec
+uv run python scripts/generate_from_openapi.py --api-name data_cloud --spec specs/dx_data_cloud_api_openapi.json
+```
+
+If you need to change the structure or behavior of the generated code, modify the generator script rather than the generated output.
+
+## Building the Package
+
+```bash
+uv build
+```
+
+## Pull Request Process
+
+1. Fork the repository and create a branch from `main`.
+2. Make your changes, following the code style guidelines above.
+3. Add or update tests as appropriate.
+4. Ensure all checks pass:
+   ```bash
+   uv run ruff format .
+   uv run ruff check .
+   uv run pytest
+   ```
+5. Open a pull request against `main` with a clear description of what changed and why.
+
+For significant changes, consider opening an issue first to discuss the approach before investing time in implementation.

getdx-0.1.0/LICENSE

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

getdx-0.1.0/PKG-INFO

@@ -0,0 +1,146 @@
+Metadata-Version: 2.4
+Name: getdx
+Version: 0.1.0
+Summary: Python SDK for the DX Web and DX Data Cloud APIs
+Project-URL: Homepage, https://github.com/priiiiit/dx-python
+Project-URL: Repository, https://github.com/priiiiit/dx-python
+Project-URL: Issues, https://github.com/priiiiit/dx-python/issues
+Project-URL: Documentation, https://docs.getdx.com
+Author: Priit Pihus
+License-Expression: MIT
+License-File: LICENSE
+Keywords: api,client,data,developer experience,devex,dx,engineering metrics,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: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: typing-extensions>=4.12.0
+Description-Content-Type: text/markdown
+
+# getdx
+
+[![PyPI version](https://img.shields.io/pypi/v/getdx.svg)](https://pypi.org/project/getdx/)
+[![Python versions](https://img.shields.io/pypi/pyversions/getdx.svg)](https://pypi.org/project/getdx/)
+[![CI](https://github.com/priiiiit/dx-python/actions/workflows/ci.yml/badge.svg)](https://github.com/priiiiit/dx-python/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+Sync-first Python SDK covering both DX APIs:
+- DX Web API (`https://api.getdx.com`)
+- DX Data Cloud API (`https://{instance}.getdx.net/api`)
+
+This SDK does not cache API responses. Each call fetches fresh data.
+
+## Install
+
+```bash
+pip install getdx
+```
+
+Requires Python 3.10+.
+
+## Quickstart
+
+### Web API only
+```python
+from getdx import DXClient, DXWebConfig
+
+with DXClient(web=DXWebConfig(token="<DX_WEB_API_TOKEN>")) as client:
+    entities = client.web.entities.list(limit=10)
+    overview = client.web.aggregates.entity_overview("my-entity-id")
+    print(entities)
+    print(overview.tasks)
+```
+
+### Data Cloud API only
+```python
+from getdx import DXClient, DXDataCloudConfig
+
+with DXClient(
+    data_cloud=DXDataCloudConfig(
+        token="<DX_DATA_CLOUD_TOKEN>",
+        instance="yourinstance",
+    )
+) as client:
+    group = client.data_cloud.repo_groups.get(reference_id="frontend-team")
+    print(group)
+```
+
+### Both APIs in one client
+```python
+from getdx import DXClient, DXDataCloudConfig, DXWebConfig
+
+with DXClient(
+    web=DXWebConfig(token="<DX_WEB_API_TOKEN>"),
+    data_cloud=DXDataCloudConfig(token="<DX_DATA_CLOUD_TOKEN>", instance="yourinstance"),
+) as client:
+    web_entity = client.web.entities.info("entity-1")
+    repo_group = client.data_cloud.repo_groups.get(reference_id="frontend-team")
+```
+
+## Data Cloud convenience helpers
+- `client.data_cloud.custom_data.delete_by_id(id)`
+- `client.data_cloud.custom_data.delete_by_reference_key(reference, key)`
+- `client.data_cloud.deployments.set_pull_services_by_github_pull_id(...)`
+- `client.data_cloud.deployments.set_pull_services_by_repo_and_number(...)`
+
+## Optional namespace behavior
+If `web` or `data_cloud` was not configured on `DXClient`, accessing that namespace raises
+`DXClientNotConfiguredError`.
+
+## Environment variables
+- `DX_WEB_API_TOKEN` for Web API token fallback
+- `DX_DATA_CLOUD_TOKEN` for Data Cloud token fallback
+- `DX_DATA_CLOUD_INSTANCE` for Data Cloud instance fallback
+
+## Development
+
+Clone and install with `uv`:
+
+```bash
+git clone https://github.com/priiiiit/dx-python.git
+cd dx-python
+uv sync --dev
+```
+
+### Regenerate API wrappers
+Generated modules live under:
+- `src/getdx/web/` (operations.py, services/)
+- `src/getdx/data_cloud/` (operations.py, services/)
+
+```bash
+uv run python scripts/generate_from_openapi.py \
+  --api-name web \
+  --spec specs/dx_web_api_openapi.json
+
+uv run python scripts/generate_from_openapi.py \
+  --api-name data_cloud \
+  --spec specs/dx_data_cloud_api_openapi.json
+```
+
+### Testing and linting
+```bash
+uv run ruff format .
+uv run ruff check .
+uv run pytest
+```
+
+Optional live smoke tests:
+```bash
+RUN_LIVE_DX_TESTS=1 uv run pytest tests/live -q
+```
+
+For Data Cloud live smoke, set:
+- `DX_DATA_CLOUD_TOKEN`
+- `DX_DATA_CLOUD_INSTANCE`
+- `DX_DATA_CLOUD_TEST_REFERENCE_ID`
+
+## License
+
+MIT — see [LICENSE](LICENSE).

getdx-0.1.0/README.md

@@ -0,0 +1,120 @@
+# getdx
+
+[![PyPI version](https://img.shields.io/pypi/v/getdx.svg)](https://pypi.org/project/getdx/)
+[![Python versions](https://img.shields.io/pypi/pyversions/getdx.svg)](https://pypi.org/project/getdx/)
+[![CI](https://github.com/priiiiit/dx-python/actions/workflows/ci.yml/badge.svg)](https://github.com/priiiiit/dx-python/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+Sync-first Python SDK covering both DX APIs:
+- DX Web API (`https://api.getdx.com`)
+- DX Data Cloud API (`https://{instance}.getdx.net/api`)
+
+This SDK does not cache API responses. Each call fetches fresh data.
+
+## Install
+
+```bash
+pip install getdx
+```
+
+Requires Python 3.10+.
+
+## Quickstart
+
+### Web API only
+```python
+from getdx import DXClient, DXWebConfig
+
+with DXClient(web=DXWebConfig(token="<DX_WEB_API_TOKEN>")) as client:
+    entities = client.web.entities.list(limit=10)
+    overview = client.web.aggregates.entity_overview("my-entity-id")
+    print(entities)
+    print(overview.tasks)
+```
+
+### Data Cloud API only
+```python
+from getdx import DXClient, DXDataCloudConfig
+
+with DXClient(
+    data_cloud=DXDataCloudConfig(
+        token="<DX_DATA_CLOUD_TOKEN>",
+        instance="yourinstance",
+    )
+) as client:
+    group = client.data_cloud.repo_groups.get(reference_id="frontend-team")
+    print(group)
+```
+
+### Both APIs in one client
+```python
+from getdx import DXClient, DXDataCloudConfig, DXWebConfig
+
+with DXClient(
+    web=DXWebConfig(token="<DX_WEB_API_TOKEN>"),
+    data_cloud=DXDataCloudConfig(token="<DX_DATA_CLOUD_TOKEN>", instance="yourinstance"),
+) as client:
+    web_entity = client.web.entities.info("entity-1")
+    repo_group = client.data_cloud.repo_groups.get(reference_id="frontend-team")
+```
+
+## Data Cloud convenience helpers
+- `client.data_cloud.custom_data.delete_by_id(id)`
+- `client.data_cloud.custom_data.delete_by_reference_key(reference, key)`
+- `client.data_cloud.deployments.set_pull_services_by_github_pull_id(...)`
+- `client.data_cloud.deployments.set_pull_services_by_repo_and_number(...)`
+
+## Optional namespace behavior
+If `web` or `data_cloud` was not configured on `DXClient`, accessing that namespace raises
+`DXClientNotConfiguredError`.
+
+## Environment variables
+- `DX_WEB_API_TOKEN` for Web API token fallback
+- `DX_DATA_CLOUD_TOKEN` for Data Cloud token fallback
+- `DX_DATA_CLOUD_INSTANCE` for Data Cloud instance fallback
+
+## Development
+
+Clone and install with `uv`:
+
+```bash
+git clone https://github.com/priiiiit/dx-python.git
+cd dx-python
+uv sync --dev
+```
+
+### Regenerate API wrappers
+Generated modules live under:
+- `src/getdx/web/` (operations.py, services/)
+- `src/getdx/data_cloud/` (operations.py, services/)
+
+```bash
+uv run python scripts/generate_from_openapi.py \
+  --api-name web \
+  --spec specs/dx_web_api_openapi.json
+
+uv run python scripts/generate_from_openapi.py \
+  --api-name data_cloud \
+  --spec specs/dx_data_cloud_api_openapi.json
+```
+
+### Testing and linting
+```bash
+uv run ruff format .
+uv run ruff check .
+uv run pytest
+```
+
+Optional live smoke tests:
+```bash
+RUN_LIVE_DX_TESTS=1 uv run pytest tests/live -q
+```
+
+For Data Cloud live smoke, set:
+- `DX_DATA_CLOUD_TOKEN`
+- `DX_DATA_CLOUD_INSTANCE`
+- `DX_DATA_CLOUD_TEST_REFERENCE_ID`
+
+## License
+
+MIT — see [LICENSE](LICENSE).

getdx-0.1.0/examples/01_web_api_basics.py

@@ -0,0 +1,30 @@
+"""
+Web API basics: listing entities, teams, scorecards, and initiatives.
+"""
+
+from getdx import DXClient, DXWebConfig
+
+with DXClient(web=DXWebConfig(token="<DX_WEB_API_TOKEN>")) as client:
+    # List all entities (first page)
+    entities = client.web.entities.list(limit=20)
+    print("Entities:", entities)
+
+    # Get details for a specific entity
+    entity = client.web.entities.info("my-service")
+    print("Entity:", entity)
+
+    # List all teams
+    teams = client.web.teams.list(limit=10)
+    print("Teams:", teams)
+
+    # Look up a team by reference ID
+    team = client.web.teams.info(reference_id="platform-team")
+    print("Team:", team)
+
+    # List all scorecards
+    scorecards = client.web.scorecards.list()
+    print("Scorecards:", scorecards)
+
+    # List published initiatives
+    initiatives = client.web.initiatives.list(published=True)
+    print("Initiatives:", initiatives)

getdx-0.1.0/examples/02_entity_overview_and_relations.py

@@ -0,0 +1,19 @@
+"""
+Entity overview and relations graph using the aggregate helpers.
+"""
+
+from getdx import DXClient, DXWebConfig
+
+with DXClient(web=DXWebConfig(token="<DX_WEB_API_TOKEN>")) as client:
+    # Fetch entity info + scorecards + tasks in one call
+    overview = client.web.aggregates.entity_overview("checkout-service")
+    print("Entity:", overview.entity)
+    print("Open tasks:", overview.tasks)
+    print("Scorecards:", overview.scorecards)
+
+    # Build a full relations graph (auto-paginates)
+    graph = client.web.aggregates.entity_relations("checkout-service")
+    print(f"Nodes ({len(graph.nodes)}):", list(graph.nodes.keys()))
+    print(f"Edges ({len(graph.edges)}):")
+    for edge in graph.edges:
+        print(f"  {edge['source']} -> {edge['target']}")