dpdpguard-sdk 1.0.0__tar.gz

dpdpguard_sdk-1.0.0/.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: CI
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: pip install --upgrade pip
+      - run: pip install -e ".[dev]"
+      - run: ruff check .
+      - run: mypy src
+      - run: pytest --cov=src --cov-report=term-missing
+
+  build:
+    runs-on: ubuntu-latest
+    needs: test
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with: { python-version: "3.12" }
+      - run: pip install --upgrade build twine
+      - run: python -m build
+      - run: twine check dist/*

dpdpguard_sdk-1.0.0/.github/workflows/publish.yml

@@ -0,0 +1,36 @@
+# Publishes to PyPI using Trusted Publishing (OIDC) - no API token stored as
+# a secret. Configure this repo/workflow as a trusted publisher under the
+# project's PyPI settings (pypi.org > your project > Publishing) before the
+# first run: https://docs.pypi.org/trusted-publishers/
+name: Publish
+on:
+  release:
+    types: [published]
+  workflow_dispatch: {}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with: { python-version: "3.12" }
+      - run: pip install --upgrade build
+      - run: python -m build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    runs-on: ubuntu-latest
+    needs: build
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

dpdpguard_sdk-1.0.0/.gitignore

@@ -0,0 +1,220 @@
+# 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
+*.lcov
+.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/*
+!.pixi/config.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
+
+# 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

dpdpguard_sdk-1.0.0/CHANGELOG.md

@@ -0,0 +1,30 @@
+# 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 [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2026-07-30
+
+### Added
+
+- `DpdpGuardClient` — typed client over `/api/v1` (spec §4.2): public reads
+  (`get_organization`, `get_notices`, `get_notice`, `get_banner_config`),
+  token brokering (`broker_token`, `link_anonymous_consent`), DSR
+  (`list_dsr_requests`, `create_dsr_request` with `Idempotency-Key` support),
+  grievances (`list_grievances`, `create_grievance`), and nomination
+  (`get_nomination`, `upsert_nomination`, `revoke_nomination`). Mirrors
+  `@dpdpguard/server` (Node/TypeScript) method for method.
+- `DpdpGuardApiError` and the ADR-002 error catalog (`ERROR_CATALOG`,
+  `ApiErrorCode`), vendored from `@dpdpguard/contract/conformance/error-catalog.json`.
+- `has_consent` / `ConsentRecord` — pure consent-gate helper.
+- `verify_webhook_signature` — HMAC-SHA256 verification of the
+  `X-DPDP-Signature` header, constant-time comparison.
+- `canonicalize_audit_event` / `compute_audit_hash` / `AuditHashInput` — audit-hash
+  canonicalization matching `convex/lib/auditHash.ts`, verified against the
+  vendored golden vectors in `_data/audit-hash-vectors.json`.
+- Every request sends `X-DPDP-SDK: python/<version>` for SDK-version
+  identification (spec §6.1 / ADR-002 D6).
+- Typed wire models (`OrgSummary`, `Notice`, `DsrRequest`, `Grievance`,
+  `Nomination`, etc.) hand-kept in sync with `openapi/v1.yaml`.

dpdpguard_sdk-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License Copyright (c) 2026 Chintan Shah
+
+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
+(including the next paragraph) 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.

dpdpguard_sdk-1.0.0/PKG-INFO

@@ -0,0 +1,139 @@
+Metadata-Version: 2.4
+Name: dpdpguard-sdk
+Version: 1.0.0
+Summary: DPDP Guard Server SDK (Python) - typed API client, consent gate, token broker, webhook verifier
+Project-URL: Homepage, https://github.com/dpdp-guard-ai/dpdpguard-python-sdk
+Project-URL: Spec, https://github.com/chintans/dpdpbot/blob/main/docs/specs/mobile-server-sdk.md
+Author: DPDP Guard
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+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.9
+Requires-Dist: httpx>=0.27
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pytest-cov>=5; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff>=0.5; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# dpdpguard-python-sdk
+
+DPDP Guard Server SDK (Python) — typed API client, consent gate, token broker
+helper, audit-hash verifier, and webhook signature verifier over DPDP Guard's
+public `/api/v1` (spec §4.2).
+
+PyPI distribution: `dpdpguard-sdk` · Import as: `dpdpguard`
+
+Part of the DPDP Guard SDK family. See the design spec:
+https://github.com/chintans/dpdpbot/blob/main/docs/specs/mobile-server-sdk.md
+
+This SDK mirrors [`@dpdpguard/server`](https://www.npmjs.com/package/@dpdpguard/server)
+(the Node/TypeScript reference implementation) method for method, so behavior —
+auth modes, idempotency headers, error codes, audit-hash canonicalization — stays
+identical across ecosystems (ADR-001's audit-uniformity goal).
+
+## Install
+
+```bash
+pip install dpdpguard-sdk
+```
+
+## Usage
+
+```python
+import os
+from dpdpguard import DpdpGuardClient, has_consent, verify_webhook_signature
+
+client = DpdpGuardClient(
+    "https://<your-deployment>.convex.site",
+    api_key=os.environ["DPDP_SERVICE_API_KEY"],  # convex/apiKeys.ts, for broker_token() only
+)
+
+# Mint a brokered principal access token (ADR-004 D1/D2) for a known user.
+client.broker_token(external_id)
+
+# Now authenticated calls use that token automatically.
+result = client.list_dsr_requests()
+client.create_dsr_request(organization_id=org_id, type="erasure")
+
+# Public reads need no auth at all.
+org = client.get_organization("acme")
+notices = client.get_notices(org["orgId"])
+
+# Verify an inbound webhook (convex/webhooks.ts's X-DPDP-Signature header).
+ok = verify_webhook_signature(webhook_secret, raw_body, request.headers.get("x-dpdp-signature"))
+```
+
+Use it as a context manager to close the underlying `httpx.Client` automatically:
+
+```python
+with DpdpGuardClient(base_url) as client:
+    org = client.get_organization("acme")
+```
+
+Every non-2xx response raises a `DpdpGuardApiError` with a `code` from the
+ADR-002 error catalog (`err.code`, e.g. `"NOT_FOUND"`) and the HTTP `status`.
+
+### Consent gate
+
+```python
+from dpdpguard import has_consent
+
+if not has_consent(consents, "Marketing"):
+    return  # don't send the campaign
+```
+
+### Audit-hash verification
+
+A holder of the platform's `DPDP_AUDIT_HASH_HMAC_SECRET` can independently
+verify a `consentAuditTrail` row's `auditHash`:
+
+```python
+from dpdpguard import AuditHashInput, compute_audit_hash
+
+input = AuditHashInput(
+    organization_id="org_abc123",
+    notice_id="notice_v1",
+    notice_version=1,
+    purpose="Newsletter",
+    data_types=["email"],
+    given_at=1700000000000,
+    source="direct",
+)
+assert compute_audit_hash(input, secret) == stored_audit_hash
+```
+
+## Contract
+
+This package vendors its wire contract from `dpdpbot`'s single source of
+truth (ADR-001/002) rather than depending on a published `@dpdpguard/contract`
+Python package (none exists yet):
+
+- `src/dpdpguard/models.py` is hand-kept in sync with `openapi/v1.yaml`'s
+  `components.schemas`.
+- `src/dpdpguard/errors.py` loads `_data/error-catalog.json`, vendored
+  verbatim from `@dpdpguard/contract/conformance/error-catalog.json`
+  (ADR-002 D2).
+- `tests/test_audit_hash.py` runs `_data/audit-hash-vectors.json` (vendored
+  from `@dpdpguard/contract/conformance/audit-hash-vectors.json`) as a
+  required CI gate (ADR-002 D5) — a failure means this SDK's `audit_hash.py`
+  has drifted from `convex/lib/auditHash.ts`.
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+ruff check .
+mypy src
+pytest --cov=src --cov-report=term-missing
+```

dpdpguard_sdk-1.0.0/README.md

@@ -0,0 +1,111 @@
+# dpdpguard-python-sdk
+
+DPDP Guard Server SDK (Python) — typed API client, consent gate, token broker
+helper, audit-hash verifier, and webhook signature verifier over DPDP Guard's
+public `/api/v1` (spec §4.2).
+
+PyPI distribution: `dpdpguard-sdk` · Import as: `dpdpguard`
+
+Part of the DPDP Guard SDK family. See the design spec:
+https://github.com/chintans/dpdpbot/blob/main/docs/specs/mobile-server-sdk.md
+
+This SDK mirrors [`@dpdpguard/server`](https://www.npmjs.com/package/@dpdpguard/server)
+(the Node/TypeScript reference implementation) method for method, so behavior —
+auth modes, idempotency headers, error codes, audit-hash canonicalization — stays
+identical across ecosystems (ADR-001's audit-uniformity goal).
+
+## Install
+
+```bash
+pip install dpdpguard-sdk
+```
+
+## Usage
+
+```python
+import os
+from dpdpguard import DpdpGuardClient, has_consent, verify_webhook_signature
+
+client = DpdpGuardClient(
+    "https://<your-deployment>.convex.site",
+    api_key=os.environ["DPDP_SERVICE_API_KEY"],  # convex/apiKeys.ts, for broker_token() only
+)
+
+# Mint a brokered principal access token (ADR-004 D1/D2) for a known user.
+client.broker_token(external_id)
+
+# Now authenticated calls use that token automatically.
+result = client.list_dsr_requests()
+client.create_dsr_request(organization_id=org_id, type="erasure")
+
+# Public reads need no auth at all.
+org = client.get_organization("acme")
+notices = client.get_notices(org["orgId"])
+
+# Verify an inbound webhook (convex/webhooks.ts's X-DPDP-Signature header).
+ok = verify_webhook_signature(webhook_secret, raw_body, request.headers.get("x-dpdp-signature"))
+```
+
+Use it as a context manager to close the underlying `httpx.Client` automatically:
+
+```python
+with DpdpGuardClient(base_url) as client:
+    org = client.get_organization("acme")
+```
+
+Every non-2xx response raises a `DpdpGuardApiError` with a `code` from the
+ADR-002 error catalog (`err.code`, e.g. `"NOT_FOUND"`) and the HTTP `status`.
+
+### Consent gate
+
+```python
+from dpdpguard import has_consent
+
+if not has_consent(consents, "Marketing"):
+    return  # don't send the campaign
+```
+
+### Audit-hash verification
+
+A holder of the platform's `DPDP_AUDIT_HASH_HMAC_SECRET` can independently
+verify a `consentAuditTrail` row's `auditHash`:
+
+```python
+from dpdpguard import AuditHashInput, compute_audit_hash
+
+input = AuditHashInput(
+    organization_id="org_abc123",
+    notice_id="notice_v1",
+    notice_version=1,
+    purpose="Newsletter",
+    data_types=["email"],
+    given_at=1700000000000,
+    source="direct",
+)
+assert compute_audit_hash(input, secret) == stored_audit_hash
+```
+
+## Contract
+
+This package vendors its wire contract from `dpdpbot`'s single source of
+truth (ADR-001/002) rather than depending on a published `@dpdpguard/contract`
+Python package (none exists yet):
+
+- `src/dpdpguard/models.py` is hand-kept in sync with `openapi/v1.yaml`'s
+  `components.schemas`.
+- `src/dpdpguard/errors.py` loads `_data/error-catalog.json`, vendored
+  verbatim from `@dpdpguard/contract/conformance/error-catalog.json`
+  (ADR-002 D2).
+- `tests/test_audit_hash.py` runs `_data/audit-hash-vectors.json` (vendored
+  from `@dpdpguard/contract/conformance/audit-hash-vectors.json`) as a
+  required CI gate (ADR-002 D5) — a failure means this SDK's `audit_hash.py`
+  has drifted from `convex/lib/auditHash.ts`.
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+ruff check .
+mypy src
+pytest --cov=src --cov-report=term-missing
+```

dpdpguard_sdk-1.0.0/pyproject.toml

@@ -0,0 +1,54 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "dpdpguard-sdk"
+version = "1.0.0"
+description = "DPDP Guard Server SDK (Python) - typed API client, consent gate, token broker, webhook verifier"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.9"
+authors = [{ name = "DPDP Guard" }]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Typing :: Typed",
+]
+dependencies = [
+    "httpx>=0.27",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8",
+    "pytest-cov>=5",
+    "ruff>=0.5",
+    "mypy>=1.10",
+]
+
+[project.urls]
+Homepage = "https://github.com/dpdp-guard-ai/dpdpguard-python-sdk"
+Spec = "https://github.com/chintans/dpdpbot/blob/main/docs/specs/mobile-server-sdk.md"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/dpdpguard"]
+
+[tool.hatch.build.targets.wheel.force-include]
+"src/dpdpguard/_data/error-catalog.json" = "dpdpguard/_data/error-catalog.json"
+"src/dpdpguard/_data/audit-hash-vectors.json" = "dpdpguard/_data/audit-hash-vectors.json"
+
+[tool.ruff]
+line-length = 100
+src = ["src", "tests"]
+
+[tool.mypy]
+strict = true
+packages = ["dpdpguard"]

dpdpguard_sdk-1.0.0/src/dpdpguard/__init__.py

@@ -0,0 +1,24 @@
+"""DPDP Guard Server SDK (Python) - typed API client, consent gate, token broker, webhook verifier"""
+
+from .audit_hash import AuditHashInput, canonicalize_audit_event, compute_audit_hash
+from .client import DpdpGuardClient
+from .consent_gate import ConsentRecord, has_consent
+from .errors import ERROR_CATALOG, ApiErrorCode, DpdpGuardApiError, ErrorCatalogEntry
+from .webhook_verifier import verify_webhook_signature
+
+__version__ = "1.0.0"
+
+__all__ = [
+    "ERROR_CATALOG",
+    "ApiErrorCode",
+    "AuditHashInput",
+    "ConsentRecord",
+    "DpdpGuardApiError",
+    "DpdpGuardClient",
+    "ErrorCatalogEntry",
+    "__version__",
+    "canonicalize_audit_event",
+    "compute_audit_hash",
+    "has_consent",
+    "verify_webhook_signature",
+]