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

Uploaded Python 3

File details

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

File metadata

  • Download URL: osp_provider_contracts-0.2.10.tar.gz
  • Upload date:
  • Size: 60.9 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.10.tar.gz
Algorithm Hash digest
SHA256 02b08fa1fafc5dd38e46885921763d25908ade5954416913fa75d90366aeec65
MD5 344ca925621c88094db0c11c6c4f4823
BLAKE2b-256 9de0f305197f3871ca3d322df2c479ad752f8e10bcfabdb5b942c20825acc294

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for osp_provider_contracts-0.2.10-py3-none-any.whl
Algorithm Hash digest
SHA256 a175b0487d9bccb3c474545571a28e6fdb707b5f9279e9ae024cfb00b6cb09dd
MD5 1fa4ead623ef77d322ec34eee9ad34a1
BLAKE2b-256 526143259765af9b306465e5dbdf80009bb35305189747c562396bc221086e00

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