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.13.tar.gz (64.0 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.13-py3-none-any.whl (28.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: osp_provider_contracts-0.2.13.tar.gz
  • Upload date:
  • Size: 64.0 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.13.tar.gz
Algorithm Hash digest
SHA256 e31ba5ecc5dd207a4286eadb0b4a3761440c7bd6f14d2baa089d865985628f30
MD5 523ada5cb738ccc517434a7b1bb564cc
BLAKE2b-256 41592e3dd0002f227efd5005f46cf4ac92ebd7c2e11086232377c3236bb981d6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for osp_provider_contracts-0.2.13-py3-none-any.whl
Algorithm Hash digest
SHA256 5e0f5d6f2c7a69b3c959edc208b1111386929284256056f58d1766a1caeef007
MD5 25a9d60091d9c702393d9cd253174f48
BLAKE2b-256 25890713f68916bbec77b65de4bff9d2705c11d371c903375c75e75cdce034ca

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