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 reason 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_reason: one of osp_provider_contracts.GateReason string values
  • importance: integer risk/urgency indicator when applicable (1 => 2 approvals)
  • required_approvals: optional explicit quorum override (e.g., 2 for dual control)
  • 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 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

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.12.tar.gz (61.8 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.12-py3-none-any.whl (27.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: osp_provider_contracts-0.2.12.tar.gz
  • Upload date:
  • Size: 61.8 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.12.tar.gz
Algorithm Hash digest
SHA256 e879fcd527510ee6b07660f0e042b4fab548043d076ddfbdc8d59baafca0a08a
MD5 a74f893daace23caa86ae22172971dd6
BLAKE2b-256 2721cddc185d9ab9edd799670ea1874eef42b50b6ebf525c842aa5a8a53c7a3a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for osp_provider_contracts-0.2.12-py3-none-any.whl
Algorithm Hash digest
SHA256 9a4c8a18965a40816701d735941adf6ccbfff518be69c59d345a97c70d2d3e24
MD5 2f2a7ae6dcd42de17be779b417ff0366
BLAKE2b-256 ccb37fa9c49ca19c8d13f673f02fd70ad53ff3836974674e2263d87da3ef572c

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