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.11.tar.gz (61.6 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.11-py3-none-any.whl (26.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: osp_provider_contracts-0.2.11.tar.gz
  • Upload date:
  • Size: 61.6 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.11.tar.gz
Algorithm Hash digest
SHA256 e095f5994ae50577e24bbeaae06bc5717f78e06215392a5dd1dbea34398ab9f5
MD5 e110fa7a25e8309751419a4f6724846d
BLAKE2b-256 05aa964c767ebc624ccd4466e991346d90ff7071cbd573bb8cf666a600cb479b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for osp_provider_contracts-0.2.11-py3-none-any.whl
Algorithm Hash digest
SHA256 11cebc61adff590f31f55fa33efdbcb53470168545178c21f4bcc9c0053d46c0
MD5 5381e809053e6a896fa33775d88bf705
BLAKE2b-256 2e8367a516f09608f325e15e6baf8c38fa809e27d9bf5c4c7c3225f84ef09cc6

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