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.

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.2.tar.gz (50.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.2-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: osp_provider_contracts-0.2.2.tar.gz
  • Upload date:
  • Size: 50.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.2.tar.gz
Algorithm Hash digest
SHA256 fb8eb44aebcfef7e978975bbfcc43f8f2cbf5438c214db6fedf41e1f6dcbfa22
MD5 232b06a2f58ef885c9cee7de003e8072
BLAKE2b-256 bf35161125dafcf3da22b7cd56236745f79c38fa61ac2445143cc7b66f2a2ffe

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for osp_provider_contracts-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b5fa1cad09eb82ad0f89e8dec88411fa4ffc30feea26478e6c074344de34b7ad
MD5 34e496faf240017c1c281863018f4c9c
BLAKE2b-256 87e786360793e80904287fb09f31f933823781c3733326f4480f14db6176aec4

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