Skip to main content

Thin runtime harness for OSP providers (RabbitMQ transport + contract execution).

Project description

osp-provider-runtime

Thin, boring runtime harness for OSP providers.

This package handles RabbitMQ message plumbing so provider implementations can focus on business logic.

What it does (v0.1)

  • Parses a versioned request envelope.
  • Builds provider RequestContext/ProviderRequest and calls execute(...).
  • Serializes a standard response envelope.
  • Applies explicit ack/requeue/dead-letter decisions.
  • Emits structured logs for delivery decisions.
  • Supports explicit runtime knobs for prefetch/concurrency/retries/timeouts/DLQ.
  • Accepts contract_v1 request envelopes.

Result payload conventions

Provider results should keep ProviderResult.data focused on the resolved values for the task. The runtime builds the full update payload envelope:

  • requested: request payload from the orchestrator
  • resolved: your ProviderResult.data (after runtime normalization)
  • provenance: optional; extracted from ProviderResult.data["provenance"]
  • dry_run: derived from the request payload

Special keys in ProviderResult.data:

  • progress_events (list): lifted into the update payload and removed from resolved to avoid duplicate TaskEvent rows.
  • provenance (dict): lifted into the top-level provenance field.

Avoid embedding envelope-shaped keys (requested, resolved, request_input, request_defaults) inside ProviderResult.data. The runtime will drop them to keep the stored result compact and predictable.

What it does not do

  • No provider framework.
  • No plugin system.
  • No workflow orchestration.

Install

pip install osp-provider-runtime

Development

env -u VIRTUAL_ENV uv sync --extra dev
hatch shell
hatch run check
hatch run build
hatch run verify

Note: before osp-provider-contracts is published to your index, use uv for local checks in this monorepo:

env -u VIRTUAL_ENV uv run ruff check .
env -u VIRTUAL_ENV uv run mypy src tests
env -u VIRTUAL_ENV uv run pytest

Runtime Knobs

Set these via RuntimeConfig in your provider runtime_app.py:

  • prefetch_count (default 1)
  • concurrency (default 1)
  • max_attempts (default 5)
  • handler_timeout_seconds (optional)
  • dead_letter_exchange (optional)
  • dead_letter_routing_key (optional)
  • heartbeat_seconds (default 60)
  • blocked_connection_timeout_seconds (default 30)
  • updates_signing_enabled (default False)
  • updates_signing_kid (required when signing enabled)
  • updates_signing_secret (UTF-8 shared secret; set this or _b64)
  • updates_signing_secret_b64 (base64-encoded shared secret; preferred for random bytes)

Update Emission

Use TaskReporter for provider task lifecycle updates. The runtime keeps transport details compatible with orchestrator consumers.

Docs:

  • docs/runtime-contract.md
  • docs/provider-updates.md
  • docs/migration-task-reporter.md
  • docs/runtime-upgrade-checklist.md
  • docs/release-notes-task-reporter.md

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_runtime-0.2.15.tar.gz (85.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_runtime-0.2.15-py3-none-any.whl (37.0 kB view details)

Uploaded Python 3

File details

Details for the file osp_provider_runtime-0.2.15.tar.gz.

File metadata

  • Download URL: osp_provider_runtime-0.2.15.tar.gz
  • Upload date:
  • Size: 85.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for osp_provider_runtime-0.2.15.tar.gz
Algorithm Hash digest
SHA256 27298f782b887d162aec8627b6a98fa4e7561ccb9c8998c6e0b5f8dbf99e76a2
MD5 55b6dece6698126bc2f3ec7b7646fb39
BLAKE2b-256 607996b0db89247d26a2b8ed0470d9d8a12d2bcd14a257688b6c711511226433

See more details on using hashes here.

File details

Details for the file osp_provider_runtime-0.2.15-py3-none-any.whl.

File metadata

File hashes

Hashes for osp_provider_runtime-0.2.15-py3-none-any.whl
Algorithm Hash digest
SHA256 7a96192dc84da2164e2a3ee409d4abef0ea8ba3b368dd0eb52fe65ca6a42cd7d
MD5 5ee474d1bcfbeecf1725bdfa454ac3c5
BLAKE2b-256 fe2f109b62a48c6c531f82e10cac990dd78bffd89706bb5c4e539e411360ff34

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