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)

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.14.tar.gz (82.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_runtime-0.2.14-py3-none-any.whl (35.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: osp_provider_runtime-0.2.14.tar.gz
  • Upload date:
  • Size: 82.1 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.14.tar.gz
Algorithm Hash digest
SHA256 13aea51543c938d98f8bf4492b505cd91535d4cc2f232d042f7613ada2b25f42
MD5 06c6898212c331ee1e1aa1b461888cee
BLAKE2b-256 c9348f55c34c15ad105b411c6cade115ce5741c30031f25b74c2cb229473e3a7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for osp_provider_runtime-0.2.14-py3-none-any.whl
Algorithm Hash digest
SHA256 954469aeb294ad933174a927d22d44a725b4bfa044d027d71ed9647107d3e4b1
MD5 daeafb4b22c5983dee1877940f46c7a9
BLAKE2b-256 da12adca9f92cc69552176b480cecb1ec17efbf05a92a996005698d9b1696e45

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