nopaque 0.1.0__tar.gz

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

@@ -0,0 +1,31 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+      - name: Install hatch and build
+        run: pip install hatch build
+      - name: Lint
+        run: hatch run lint
+      - name: Type check
+        run: hatch run type
+      - name: Test
+        run: hatch run test
+      - name: Build distributions
+        run: python -m build

nopaque-0.1.0/.github/workflows/nightly-integration.yml

@@ -0,0 +1,22 @@
+name: Nightly Integration
+
+on:
+  schedule:
+    - cron: "0 6 * * *"   # 06:00 UTC daily
+  workflow_dispatch:
+
+jobs:
+  integration:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: pip
+      - run: pip install hatch
+      - name: Run integration suite
+        env:
+          NOPAQUE_API_KEY: ${{ secrets.NOPAQUE_DEV_API_KEY }}
+          NOPAQUE_BASE_URL: https://api.dev.nopaque.co.uk
+        run: hatch run test:integration -v

nopaque-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,48 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write   # required for PyPI OIDC trusted publishing
+      contents: write   # required to create GitHub Release
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: pip
+
+      - name: Install hatch and build
+        run: pip install hatch build
+
+      - name: Verify tag matches package version
+        run: |
+          TAG="${GITHUB_REF#refs/tags/v}"
+          VERSION=$(python -c "import re, pathlib; m=re.search(r'__version__ = \"(.*)\"', pathlib.Path('src/nopaque/_version.py').read_text()); print(m.group(1))")
+          if [ "$TAG" != "$VERSION" ]; then
+            echo "Tag $TAG does not match package version $VERSION"
+            exit 1
+          fi
+
+      - name: Run tests
+        run: hatch run test
+
+      - name: Build distributions
+        run: python -m build
+
+      - name: Publish to PyPI (trusted publishing)
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          generate_release_notes: true
+          files: dist/*

nopaque-0.1.0/.gitignore

@@ -0,0 +1,15 @@
+__pycache__/
+*.pyc
+*.pyo
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.hatch/
+dist/
+build/
+*.egg-info/
+.coverage
+htmlcov/
+.venv/
+venv/
+.env

nopaque-0.1.0/CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+The format follows [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-04-19
+
+### Added
+- Initial release.
+- Synchronous (`Nopaque`) and asynchronous (`AsyncNopaque`) clients.
+- Full coverage of the API-key-authenticated Nopaque REST API:
+  mapping, profiles, testing (configs/jobs/runs), batches, sweeps,
+  datasets, load testing, scheduler, enrichment, audio.
+- Automatic pagination, polling helpers for long-running jobs,
+  one-call audio upload/download.
+- Method-aware retry with exponential jitter and `Retry-After` honor.
+- Typed exception hierarchy.
+
+[Unreleased]: https://github.com/nopaque/python-sdk/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/nopaque/python-sdk/releases/tag/v0.1.0

nopaque-0.1.0/LICENSE

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

nopaque-0.1.0/PKG-INFO

@@ -0,0 +1,134 @@
+Metadata-Version: 2.4
+Name: nopaque
+Version: 0.1.0
+Summary: Official Python SDK for the Nopaque API
+Project-URL: Homepage, https://nopaque.co.uk
+Project-URL: Documentation, https://nopaque.co.uk/docs/sdks
+Project-URL: Repository, https://github.com/nopaque/python-sdk
+Project-URL: Issues, https://github.com/nopaque/python-sdk/issues
+Author-email: Nopaque <support@nopaque.co.uk>
+License: MIT License
+        
+        Copyright (c) 2026 Nopaque Ltd
+        
+        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.
+License-File: LICENSE
+Keywords: api,ivr,nopaque,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.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: httpx>=0.27
+Requires-Dist: pydantic>=2.6
+Description-Content-Type: text/markdown
+
+# nopaque - Python SDK for Nopaque
+
+Official Python client for the [Nopaque](https://nopaque.co.uk) API.
+
+## Install
+
+```bash
+pip install nopaque
+```
+
+## Quick start
+
+```python
+from nopaque import Nopaque
+
+client = Nopaque(api_key="nop_live_...")   # or set NOPAQUE_API_KEY
+
+# Create a mapping job and wait for it to complete
+job = client.mapping.create(
+    name="Main IVR",
+    phone_number="+441234567890",
+    mapping_mode="dtmf",
+)
+client.mapping.start(job.id)
+final = client.mapping.wait_for_complete(job.id)
+print(final.status)
+
+# List audio files with automatic pagination
+for audio in client.audio.list():
+    print(audio.id, audio.file_name)
+
+client.close()
+```
+
+## Async
+
+```python
+import asyncio
+from nopaque import AsyncNopaque
+
+async def main():
+    async with AsyncNopaque() as client:
+        job = await client.mapping.get("map_abc123")
+        print(job.status)
+
+asyncio.run(main())
+```
+
+## Features
+
+- Full coverage of the Nopaque REST API via API-key auth
+- Typed Pydantic v2 models for every request and response
+- Paired sync (`Nopaque`) and async (`AsyncNopaque`) clients
+- Automatic pagination for list endpoints
+- Polling helpers for long-running jobs (`wait_for_complete`)
+- One-call audio upload/download wrapping the presigned-URL flow
+- Method-aware retry with exponential jitter and `Retry-After` honor
+- Typed exception hierarchy (`NotFoundError`, `RateLimitError`, etc.)
+
+## Documentation
+
+Full reference: <https://nopaque.co.uk/docs/sdks>
+
+## Authentication
+
+Pass your API key to the client:
+
+```python
+Nopaque(api_key="nop_live_...")
+```
+
+Or set the environment variable:
+
+```bash
+export NOPAQUE_API_KEY=nop_live_...
+```
+
+API keys are workspace-scoped and subject to per-minute rate limits based on
+your subscription tier. Free tier cannot use API keys.
+
+## Requirements
+
+- Python 3.9+
+- `httpx >= 0.27`, `pydantic >= 2.6`
+
+## License
+
+MIT

nopaque-0.1.0/README.md

@@ -0,0 +1,88 @@
+# nopaque - Python SDK for Nopaque
+
+Official Python client for the [Nopaque](https://nopaque.co.uk) API.
+
+## Install
+
+```bash
+pip install nopaque
+```
+
+## Quick start
+
+```python
+from nopaque import Nopaque
+
+client = Nopaque(api_key="nop_live_...")   # or set NOPAQUE_API_KEY
+
+# Create a mapping job and wait for it to complete
+job = client.mapping.create(
+    name="Main IVR",
+    phone_number="+441234567890",
+    mapping_mode="dtmf",
+)
+client.mapping.start(job.id)
+final = client.mapping.wait_for_complete(job.id)
+print(final.status)
+
+# List audio files with automatic pagination
+for audio in client.audio.list():
+    print(audio.id, audio.file_name)
+
+client.close()
+```
+
+## Async
+
+```python
+import asyncio
+from nopaque import AsyncNopaque
+
+async def main():
+    async with AsyncNopaque() as client:
+        job = await client.mapping.get("map_abc123")
+        print(job.status)
+
+asyncio.run(main())
+```
+
+## Features
+
+- Full coverage of the Nopaque REST API via API-key auth
+- Typed Pydantic v2 models for every request and response
+- Paired sync (`Nopaque`) and async (`AsyncNopaque`) clients
+- Automatic pagination for list endpoints
+- Polling helpers for long-running jobs (`wait_for_complete`)
+- One-call audio upload/download wrapping the presigned-URL flow
+- Method-aware retry with exponential jitter and `Retry-After` honor
+- Typed exception hierarchy (`NotFoundError`, `RateLimitError`, etc.)
+
+## Documentation
+
+Full reference: <https://nopaque.co.uk/docs/sdks>
+
+## Authentication
+
+Pass your API key to the client:
+
+```python
+Nopaque(api_key="nop_live_...")
+```
+
+Or set the environment variable:
+
+```bash
+export NOPAQUE_API_KEY=nop_live_...
+```
+
+API keys are workspace-scoped and subject to per-minute rate limits based on
+your subscription tier. Free tier cannot use API keys.
+
+## Requirements
+
+- Python 3.9+
+- `httpx >= 0.27`, `pydantic >= 2.6`
+
+## License
+
+MIT

nopaque-0.1.0/examples/async_example.py

@@ -0,0 +1,27 @@
+"""Async client example: parallel fetch of multiple resources."""
+import asyncio
+
+from nopaque import AsyncNopaque
+
+
+async def _collect(iterator):
+    out = []
+    async for item in iterator:
+        out.append(item)
+    return out
+
+
+async def main() -> None:
+    async with AsyncNopaque() as client:
+        audio_task = asyncio.create_task(
+            _collect(client.audio.list(limit=10))
+        )
+        profiles_task = asyncio.create_task(
+            _collect(client.profiles.list(limit=10))
+        )
+        audio, profiles = await asyncio.gather(audio_task, profiles_task)
+        print(f"{len(audio)} audio files, {len(profiles)} profiles")
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

nopaque-0.1.0/examples/audio_upload.py

@@ -0,0 +1,18 @@
+"""Upload a local audio file, then download it by ID."""
+import sys
+from pathlib import Path
+
+from nopaque import Nopaque
+
+if len(sys.argv) != 2:
+    print("Usage: python audio_upload.py <path-to-audio-file>")
+    sys.exit(1)
+
+path = Path(sys.argv[1])
+with Nopaque() as client:
+    audio = client.audio.upload(file=str(path))
+    print(f"Uploaded {audio.id} ({audio.file_name})")
+
+    out = Path("downloaded.wav")
+    client.audio.download(audio.id, to=str(out))
+    print(f"Downloaded to {out}")

nopaque-0.1.0/examples/mapping_and_wait.py

@@ -0,0 +1,33 @@
+"""Create a mapping job, start it, wait until it terminates, print tree stats."""
+import os
+
+from nopaque import Nopaque
+
+PHONE_NUMBER = os.environ["TARGET_PHONE_NUMBER"]   # e.g. +441234567890
+
+with Nopaque() as client:
+    job = client.mapping.create(
+        name="Demo mapping",
+        phone_number=PHONE_NUMBER,
+        mapping_mode="dtmf",
+    )
+    print(f"Created job {job.id}")
+
+    client.mapping.start(job.id)
+    print("Started run; waiting for completion...")
+
+    final = client.mapping.wait_for_complete(
+        job.id,
+        timeout=900.0,
+        on_update=lambda j: print(f"  status={j.status}"),
+    )
+    print(f"Final status: {final.status}")
+
+    tree = client.mapping.tree(job.id)
+    if tree.stats:
+        s = tree.stats
+        print(
+            f"Total calls: {s.total_calls} "
+            f"(completed={s.completed_calls}, failed={s.failed_calls}, "
+            f"loops={s.loops_detected})"
+        )

nopaque-0.1.0/examples/quickstart.py

@@ -0,0 +1,11 @@
+"""Five-line Nopaque quickstart.
+
+Before running: export NOPAQUE_API_KEY=your_key
+"""
+from nopaque import Nopaque
+
+client = Nopaque()
+print("Listing audio files in workspace:")
+for audio in client.audio.list(limit=5):
+    print(f"  {audio.id} - {audio.file_name}")
+client.close()

nopaque-0.1.0/pyproject.toml

@@ -0,0 +1,87 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "nopaque"
+dynamic = ["version"]
+description = "Official Python SDK for the Nopaque API"
+readme = "README.md"
+requires-python = ">=3.9"
+license = { file = "LICENSE" }
+authors = [{ name = "Nopaque", email = "support@nopaque.co.uk" }]
+keywords = ["nopaque", "ivr", "sdk", "api"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "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",
+    "Typing :: Typed",
+]
+dependencies = [
+    "httpx>=0.27",
+    "pydantic>=2.6",
+]
+
+[project.urls]
+Homepage = "https://nopaque.co.uk"
+Documentation = "https://nopaque.co.uk/docs/sdks"
+Repository = "https://github.com/nopaque/python-sdk"
+Issues = "https://github.com/nopaque/python-sdk/issues"
+
+[tool.hatch.version]
+path = "src/nopaque/_version.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/nopaque"]
+
+[tool.hatch.envs.default]
+dependencies = [
+    "pytest>=8",
+    "pytest-asyncio>=0.23",
+    "pytest-httpx>=0.30",
+    "mypy>=1.10",
+    "ruff>=0.4",
+]
+
+[tool.hatch.envs.default.scripts]
+test = "pytest {args:tests}"
+"test:integration" = "pytest tests/integration {args}"
+type = "mypy src/nopaque"
+lint = "ruff check src/nopaque tests"
+format = "ruff format src/nopaque tests"
+
+[[tool.hatch.envs.default.matrix]]
+python = ["3.9", "3.10", "3.11", "3.12"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]
+addopts = "--ignore=tests/integration"
+markers = [
+    "integration: marks tests that hit the live dev API (run only when NOPAQUE_API_KEY is set)",
+]
+
+[tool.ruff]
+line-length = 100
+target-version = "py39"
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "B", "UP", "N"]
+# UP006/UP007 suggest PEP 585/604 generics, but runtime-evaluated Pydantic
+# models need Python 3.10+ for that syntax; we target 3.9.
+ignore = ["UP006", "UP007", "UP035", "UP045"]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**/*.py" = ["E501"]
+
+[tool.mypy]
+python_version = "3.9"
+warn_unused_configs = true
+disallow_untyped_defs = true
+check_untyped_defs = true
+ignore_missing_imports = true

nopaque-0.1.0/src/nopaque/__init__.py

@@ -0,0 +1,115 @@
+"""Official Python SDK for the Nopaque API."""
+from ._client import AsyncNopaque, Nopaque
+from ._errors import (
+    APIConnectionError,
+    APITimeoutError,
+    AuthenticationError,
+    ConflictError,
+    NopaqueAPIError,
+    NopaqueConfigError,
+    NopaqueError,
+    NopaqueTimeoutError,
+    NotFoundError,
+    PermissionError,
+    RateLimitError,
+    ServerError,
+    ValidationError,
+)
+from ._version import __version__
+from .models import (
+    AudioDownloadURL,
+    AudioFile,
+    AudioUploadURL,
+    Batch,
+    BatchRun,
+    Dataset,
+    DTMFOption,
+    EnrichmentJob,
+    EnrichmentResult,
+    LoadTest,
+    LoadTestEstimate,
+    LoadTestProgress,
+    LoadTestRun,
+    LoadTestStatus,
+    MappingJob,
+    MappingJobConfig,
+    MappingJobStats,
+    MappingPath,
+    MappingRun,
+    MappingStep,
+    MappingTree,
+    Profile,
+    ProfileItem,
+    ProfileParameters,
+    ResolvedDataset,
+    ResolvedEntry,
+    RetryConfig,
+    Schedule,
+    StepResult,
+    Sweep,
+    SweepRun,
+    TestConfig,
+    TestJob,
+    TestRun,
+    TokenUsage,
+    TokenUsageDetails,
+    TreeNode,
+)
+
+__all__ = [
+    "__version__",
+    "Nopaque",
+    "AsyncNopaque",
+    # Errors
+    "NopaqueError",
+    "NopaqueAPIError",
+    "AuthenticationError",
+    "PermissionError",
+    "NotFoundError",
+    "ValidationError",
+    "ConflictError",
+    "RateLimitError",
+    "ServerError",
+    "APIConnectionError",
+    "APITimeoutError",
+    "NopaqueConfigError",
+    "NopaqueTimeoutError",
+    # Models
+    "AudioDownloadURL",
+    "AudioFile",
+    "AudioUploadURL",
+    "Batch",
+    "BatchRun",
+    "Dataset",
+    "DTMFOption",
+    "EnrichmentJob",
+    "EnrichmentResult",
+    "LoadTest",
+    "LoadTestEstimate",
+    "LoadTestProgress",
+    "LoadTestRun",
+    "LoadTestStatus",
+    "MappingJob",
+    "MappingJobConfig",
+    "MappingJobStats",
+    "MappingPath",
+    "MappingRun",
+    "MappingStep",
+    "MappingTree",
+    "Profile",
+    "ProfileItem",
+    "ProfileParameters",
+    "ResolvedDataset",
+    "ResolvedEntry",
+    "RetryConfig",
+    "Schedule",
+    "StepResult",
+    "Sweep",
+    "SweepRun",
+    "TestConfig",
+    "TestJob",
+    "TestRun",
+    "TokenUsage",
+    "TokenUsageDetails",
+    "TreeNode",
+]