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.9.tar.gz (60.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.9-py3-none-any.whl (26.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: osp_provider_contracts-0.2.9.tar.gz
  • Upload date:
  • Size: 60.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.9.tar.gz
Algorithm Hash digest
SHA256 3a2cf3e854a3d2d02c49903d92fd1289658c9fd1bade51ceb07171ec7e389bc4
MD5 b0aa0e009870b899481d2c2abb57fc5d
BLAKE2b-256 b1ab8be38eb3af2907644ca76313f62ec89f85cad6d382823a3eefbcd4a376b8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for osp_provider_contracts-0.2.9-py3-none-any.whl
Algorithm Hash digest
SHA256 399e5c7d0c81c80a562fcf8e656ff7e2745cc7b66f057e71ee351fdf328d9190
MD5 122eb246be40cf1faa270553713bb8de
BLAKE2b-256 8c0bb644d186b3a336b51f3fd16b8e76a04df0470b89f2eb11260af3bab8c334

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