Sync OpenAPI spec with upstream (April 15, 2026) (#7)

* Sync OpenAPI spec with upstream (April 15, 2026)

Fetch latest spec from api-staging.ionq.co and regenerate the client.
Adds new GET /jobs/{UUID}/circuits/{lang} endpoint for retrieving
compiled circuit files in native or qasm3 format.

Closes #6

* Add tests for GET /jobs/{UUID}/circuits/{lang} endpoint

* Add code coverage enforcement at 90% for hand-written code

Adds pytest-cov with a 90% fail-under threshold, measuring only
hand-written ionq_core modules (excludes generated api/, models/,
client.py, errors.py, types.py). Current coverage: 93%.

* Achieve 100% test coverage on hand-written code

Add tests for all previously uncovered paths: transport close/aclose,
pagination None responses, async polling (timeout, sleep, None job),
session error paths, retry-after date parsing, and version fallback.
Bump coverage threshold from 90% to 100%.

* Simplify coverage tests: drop version reload, unit-test retry-after

Replace importlib.reload-based version fallback test with a coverage
exclusion for PackageNotFoundError (defensive pattern, same as
TYPE_CHECKING). Simplify retry-after date test to call _parse_retry_after
directly with a far-future date, eliminating all monkeypatching.

* Fix lint: move _real_sleep after imports, reformat test file

* Harden coverage config: branch coverage, skip non-primary versions

Enable branch coverage (already at 100% with 112 branches). Add
show_missing and skip_covered for cleaner reports. Add standard
exclude_also patterns (@overload, NotImplementedError, __main__).
Only run coverage on Python 3.12; other versions run tests without
coverage instrumentation overhead.

* Fix docs, export UNSET/Unset, flesh out changelog

- Fix CONTRIBUTING.md: add missing --custom-template-path flag
- Add CI badge and API docs link to README
- Fix Documentation URL in pyproject.toml to point to GitHub Pages
- Export UNSET and Unset from __init__.py (needed by all model consumers)
- Flesh out CHANGELOG.md with all 0.1.0 features

* Add CODEOWNERS, issue templates, and GitHub Release job

- CODEOWNERS: @ionq/sdk-team owns all files
- Issue templates: bug report and feature request YAML forms
- config.yml: directs account/billing questions to IonQ support
- Release workflow: create GitHub Release with auto-generated notes
  after successful PyPI publish

* Add pip-audit dependency vulnerability scanning to CI

* Fix pip-audit: use uvx instead of GH action (uv venvs lack pip)

* Address code review: fix template ordering, trim redundancies

- Fix __all__ ordering in Jinja template to match generator output
- Remove redundant CODEOWNERS lines (wildcard already covers all)
- Add get_compiled_file to README endpoint table
- Remove unnecessary uv sync from audit job
- Remove unused raise NotImplementedError coverage exclusion

Author: splch

.github/CODEOWNERS

@@ -0,0 +1,3 @@
+# Default owners for everything in the repo.
+* @ionq/sdk-team
+

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,32 @@
+name: Bug Report
+description: Report a bug in ionq-core
+labels: [bug]
+
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: What happened, and what did you expect to happen?
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Reproduction
+      description: Minimal code or steps to reproduce the bug.
+      render: Python
+
+  - type: textarea
+    id: version
+    attributes:
+      label: Version Information
+      description: |
+        Paste the output of:
+        ```bash
+        python -c "import ionq_core; print(ionq_core.__version__); import platform; print(platform.python_version()); print(platform.platform())"
+        ```
+      render: Text
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: IonQ Support
+    url: https://ionq.com/contact
+    about: For account, billing, or platform questions, contact IonQ support directly.

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,12 @@
+name: Feature Request
+description: Suggest a feature for ionq-core
+labels: [enhancement]
+
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: What problem would this solve, and how would you like it to work?
+    validations:
+      required: true

.github/workflows/ci.yml

@@ -48,4 +48,17 @@ jobs:
           python-version: ${{ matrix.python-version }}
           enable-cache: ${{ github.event_name == 'push' }}
       - run: uv sync
-      - run: uv run pytest
+      - run: uv run pytest ${{ matrix.python-version != '3.12' && '--no-cov' || '' }}
+
+  audit:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
+        with:
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
+        with:
+          python-version: "3.12"
+          enable-cache: ${{ github.event_name == 'push' }}
+      - run: uvx pip-audit --require-hashes --strict -r <(uv pip compile pyproject.toml --generate-hashes)

.github/workflows/release.yml

@@ -67,3 +67,18 @@ jobs:
           name: dist
           path: dist/
       - uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b # v1.14.0
+
+  github-release:
+    needs: publish
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
+        with:
+          persist-credentials: false
+      - name: Create GitHub Release
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: gh release create "$GITHUB_REF_NAME" --generate-notes

CHANGELOG.md

@@ -9,8 +9,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Auto-generated Python client from OpenAPI spec
-- IonQClient convenience wrapper
-- Sync and async support
-- OpenAPI Overlay for spec workarounds
-- CI/CD workflows
+- Auto-generated Python client from the IonQ OpenAPI v0.4 spec (endpoints, typed models, sync + async)
+- `IonQClient` convenience wrapper with API key handling, configurable base URL, and User-Agent
+- Retry transport with exponential backoff, idempotency-aware retry, and Retry-After support
+- Structured exception hierarchy (`IonQError` -> `APIError` -> `AuthenticationError`, `RateLimitError`, etc.)
+- Pagination helpers (`iter_jobs`, `aiter_jobs`, `iter_session_jobs`, `aiter_session_jobs`)
+- Job polling helpers (`wait_for_job`, `async_wait_for_job`) with timeout and failure detection
+- `SessionManager` for QPU session lifecycle (create, end, status, context manager)
+- `ClientExtension` API for downstream SDKs to inject hooks, headers, timeouts, and transport wrappers
+- Native gate unitary matrices (`gpi_matrix`, `gpi2_matrix`, `ms_matrix`, `zz_matrix`)
+- OpenAPI Overlay for spec workarounds (nullable schemas, missing endpoints, gate fixes)
+- 100% test coverage on hand-written code (line + branch) enforced in CI
+- CI/CD: lint, type check, tests on Python 3.12-3.14, generated code staleness check, weekly spec drift detection

CONTRIBUTING.md

@@ -53,6 +53,7 @@ uvx openapi-python-client==0.28.3 generate \
     --path /tmp/patched-spec.json \
     --meta none \
     --config openapi-python-client-config.yaml \
+    --custom-template-path custom-templates \
     --output-path ionq_core \
     --overwrite
 ```

README.md

@@ -2,6 +2,8 @@
 
 [![PyPI version](https://img.shields.io/pypi/v/ionq-core.svg)](https://pypi.org/project/ionq-core/)
 [![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
+[![CI](https://github.com/ionq/ionq-core-python/actions/workflows/ci.yml/badge.svg)](https://github.com/ionq/ionq-core-python/actions/workflows/ci.yml)
+[![API Docs](https://img.shields.io/badge/docs-API%20reference-blue)](https://ionq.github.io/ionq-core-python/)
 
 A Python client library for the [IonQ Cloud Platform API](https://docs.ionq.com/), providing full access to IonQ's quantum computing services. Supports both synchronous and asynchronous usage, with typed models for all request and response objects.
 
@@ -249,6 +251,7 @@ session = SessionManager.from_id(client, "existing-session-id")
 | Cancel a job | `ionq_core.api.default.cancel_job` | Yes |
 | Cancel jobs (bulk) | `ionq_core.api.default.cancel_jobs` | Yes |
 | Get job cost | `ionq_core.api.default.get_job_cost` | Yes |
+| Get compiled circuit | `ionq_core.api.default.get_compiled_file` | Yes |
 | Estimate job cost | `ionq_core.api.default.estimate_job_cost` | Yes |
 
 ### Sessions

custom-templates/package_init.py.jinja

@@ -25,8 +25,10 @@ from ._polling import (
 from ._session import SessionManager
 from .client import AuthenticatedClient, Client
 from .ionq_client import IonQClient, __version__
+from .types import UNSET, Unset
 
 __all__ = (
+    "UNSET",
     "APIConnectionError",
     "APIError",
     "APITimeoutError",
@@ -46,6 +48,7 @@ __all__ = (
     "RateLimitError",
     "ServerError",
     "SessionManager",
+    "Unset",
     "__version__",
     "aiter_jobs",
     "aiter_session_jobs",