Skip to main content

Shared contracts for OSP providers and orchestrator.

Project description

osp-provider-contracts

Shared Python contract package for OSP providers and orchestrator: typed interfaces, canonical errors, capabilities schema, idempotency helpers, and lightweight conformance assertions.

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 schema validation
  • Conformance assertions for provider test suites
  • Canonical gate code enum for approval-required flows

No pytest plugin is included in v0.1.

Approval-Required Contract

Providers that need human approval should raise ValidationError with detail="approval_required" and include a structured extra payload:

  • gate_code: one of osp_provider_contracts.GateCode values (4xx)
  • importance: integer risk/urgency indicator when applicable
  • reason: stable machine-readable reason string
  • details: provider-specific context for operators and audit

Install

pip install osp-provider-contracts

Development

env -u VIRTUAL_ENV uv sync --extra dev
hatch shell
hatch run check
hatch run build
hatch run 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

osp_provider_contracts-0.2.4.tar.gz (65.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

osp_provider_contracts-0.2.4-py3-none-any.whl (22.7 kB view details)

Uploaded Python 3

File details

Details for the file osp_provider_contracts-0.2.4.tar.gz.

File metadata

  • Download URL: osp_provider_contracts-0.2.4.tar.gz
  • Upload date:
  • Size: 65.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for osp_provider_contracts-0.2.4.tar.gz
Algorithm Hash digest
SHA256 a1f0e3dd769af54a341530ece08923fd34a97c00c9d0321d0f81935511470e9b
MD5 09d1a024f481c530386c220cb94e8b00
BLAKE2b-256 af16a0e0e3a581dfb28de750b282db0f3af8ef80218953788560ef2059a68f2a

See more details on using hashes here.

File details

Details for the file osp_provider_contracts-0.2.4-py3-none-any.whl.

File metadata

File hashes

Hashes for osp_provider_contracts-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 463cd664022951bd34fe2b20dffb58dd6f0c7ebcf0f636b9e6009ed05e0b5331
MD5 1ddc3954ab1a4dea41abf8fe3518819e
BLAKE2b-256 e0b63aa3344dae5a324bc5045af8fd6733fa49e1c24265af8bb8944b34c3f844

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page