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.3.tar.gz (63.1 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.3-py3-none-any.whl (21.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: osp_provider_contracts-0.2.3.tar.gz
  • Upload date:
  • Size: 63.1 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.3.tar.gz
Algorithm Hash digest
SHA256 a87b7b0d34bb039479319df99a173adc287c76ab9eed9de64f9c6c37ae8d4b03
MD5 09157e3c76560f9a51d680063b20b324
BLAKE2b-256 a5b7f42339611e96c23bbf2b2df2f49aaa2d6a4954aa86d04f518813eb2a2053

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for osp_provider_contracts-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 0c5601e1249d32460759955850f1b381076a2f334810e1384aa4cb50ef446ff7
MD5 0b2af67be905d194981ba9c463bf69e5
BLAKE2b-256 0234b4eacea3a00b67ebbc8d5510fddab1668ea651e3a1e76f63103a885a0dcf

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