osp-provider-contracts
Shared Python contract package for OSP providers and orchestrator: typed interfaces, canonical errors, capabilities schema, idempotency helpers, and a reusable provider conformance kit.
For maintainer-facing internals and invariants, see src/README.md.
Scope (v0.1)
- Small, explicit provider protocol
- Shared request/result/context types
- Canonical error taxonomy with retry metadata
- Capabilities and manifest v2 schema validation
- Conformance assertions and a reusable pytest suite for provider CI
- Canonical gate reason enum for approval-required flows
No pytest plugin is included. Providers opt in by subclassing the conformance suite from a local test module.
Approval-Required Contract
Providers that need human approval should raise ValidationError with
detail="approval_required" and include a structured extra payload:
gate_reason: one ofosp_provider_contracts.GateReasonstring valuesimportance: integer risk/urgency indicator when applicable (1 => 2 approvals)required_approvals: optional explicit total quorum override (e.g., 2 for dual control)reason: stable machine-readable reason stringdetails: provider-specific context for operators and audit
Providers do not send approval-authority tiers. required_approvals only
requests the total number of approvals. The orchestrator may add fixed-tier
requirements from gate policy, such as provider-admin sudo or global
break-glass approval, without changing provider payloads.
Install
pip install osp-provider-contracts
Development
env -u VIRTUAL_ENV uv sync --extra dev
hatch shell
hatch run dev:check
hatch run dev:build
hatch run dev:verify
Release
See docs/release.md for the manual/gated publish flow.
Tag and push:
git tag v0.2.0
git push origin v0.2.0
1 maintainer
Release files for osp-provider-contracts 0.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| osp_provider_contracts-0.3.0.tar.gz | 97.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| osp_provider_contracts-0.3.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 149.1 kB
Release files / osp_provider_contracts-0.3.0.tar.gz
| Download URL | osp_provider_contracts-0.3.0.tar.gz |
|---|---|
| Size | 97.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e0f9948a77b9d17b00fc4cfda884527d6ebac4230f54f7a08c9f1b7f1b9c109d
|
|
BLAKE2b-256 checksum How to use checksums |
455cc7ffa006a93f9b3eca25f2104fd49c14c6a046cbeb39279fb1467a3f9c56
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.5
|
Release files / osp_provider_contracts-0.3.0-py3-none-any.whl
| Download URL | osp_provider_contracts-0.3.0-py3-none-any.whl |
|---|---|
| Size | 51.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8abe51d86ae278e1b3335e97e80f04a3b4a2c464efd33a0d6bdd78f34ba00be4
|
|
BLAKE2b-256 checksum How to use checksums |
9ee428122e42a051f59b001778df9d5d6a17ef94a48dc1bb6d286187064b880e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.5
|
