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 code 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_code: one of osp_provider_contracts.GateCode values (4xx)
  • importance: integer risk/urgency indicator when applicable
  • 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.5.tar.gz (66.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.5-py3-none-any.whl (22.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: osp_provider_contracts-0.2.5.tar.gz
  • Upload date:
  • Size: 66.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.5.tar.gz
Algorithm Hash digest
SHA256 a860fae3c0107ac7bd713aa55ebf2b2494d0303bf47d8e9f184aa0293219d600
MD5 aebc8a156b5830aba21dcf78e09c90f2
BLAKE2b-256 8489f071bae72c873caa6711b0eacd4d793e1d36dd61959f2c71d9abad7580be

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for osp_provider_contracts-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 799cc2fa7681c7ec79b1e757f29c78a6f9eddd4805f6de303da45694dfef4214
MD5 1bc7a1efc3c9794626e39753062f9d1a
BLAKE2b-256 fb137779c349e2e788106a932b72d8572e74f8c822111307725ee6dd42cd3490

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