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 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.8.tar.gz (59.4 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.8-py3-none-any.whl (25.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: osp_provider_contracts-0.2.8.tar.gz
  • Upload date:
  • Size: 59.4 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.8.tar.gz
Algorithm Hash digest
SHA256 5a929d72a0e0d4aac5ab5d2a2af85add489fd7bab80e492d7b4d8e61fb210f0a
MD5 1bc5e40edae95a85ffe050cedf6fef4d
BLAKE2b-256 a3646460d525a23a5df699b7d44b2bdbc4ffb7a79ed0c58a92ab06b11e613ae6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for osp_provider_contracts-0.2.8-py3-none-any.whl
Algorithm Hash digest
SHA256 8ffc44f5d88d50ce215e64b5d7c289b0d5b52fb2dcd1858cf63830bb6bdd27bd
MD5 ea74d0c3306b956ece03585ae27954c5
BLAKE2b-256 561dd824ebab1f57351cd57800c2d0672b153af12d7832735b226c65aba13f64

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