Skip to main content

Shared Prophet event publisher runtime

Project description

Prophet logo


prophet-events-runtime

prophet-events-runtime is the shared Python runtime contract used by Prophet-generated action services.

Main project repository:

It defines:

  • an async EventPublisher protocol
  • a canonical EventWireEnvelope dataclass
  • utility helpers (create_event_id, now_iso)
  • sync bridge helpers (publish_sync, publish_batch_sync)
  • a NoOpEventPublisher for local wiring and tests

Install

python3 -m pip install prophet-events-runtime

API

from typing import Iterable, Protocol

class EventPublisher(Protocol):
    async def publish(self, envelope: EventWireEnvelope) -> None: ...
    async def publish_batch(self, envelopes: Iterable[EventWireEnvelope]) -> None: ...
from dataclasses import dataclass
from typing import Dict, Optional

@dataclass(kw_only=True)
class EventWireEnvelope:
    event_id: str
    trace_id: str
    event_type: str
    schema_version: str
    occurred_at: str
    source: str
    payload: Dict[str, object]
    attributes: Optional[Dict[str, str]] = None

Exports:

  • EventPublisher
  • EventWireEnvelope
  • NoOpEventPublisher
  • create_event_id()
  • now_iso()
  • publish_sync(publisher, envelope)
  • publish_batch_sync(publisher, envelopes)

Implement a Platform Publisher

from __future__ import annotations

from typing import Iterable

from prophet_events_runtime import EventPublisher
from prophet_events_runtime import EventWireEnvelope


class PlatformClient:
    async def send_event(self, payload: dict) -> None: ...
    async def send_events(self, payloads: list[dict]) -> None: ...


class PlatformEventPublisher(EventPublisher):
    def __init__(self, client: PlatformClient) -> None:
        self._client = client

    async def publish(self, envelope: EventWireEnvelope) -> None:
        await self._client.send_event(envelope.__dict__)

    async def publish_batch(self, envelopes: Iterable[EventWireEnvelope]) -> None:
        await self._client.send_events([envelope.__dict__ for envelope in envelopes])

With Prophet-Generated Code

Generated Python action services publish event wire envelopes after successful handler execution. If you do not provide an implementation, you can wire NoOpEventPublisher for local development.

Local Validation

From repository root:

PYTHONPATH=prophet-lib/python/src python3 -m unittest discover -s prophet-lib/python/tests -p 'test_*.py' -v
python3 -m pip install --upgrade build twine
python3 -m build prophet-lib/python
python3 -m twine check prophet-lib/python/dist/*

More Information

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

prophet_events_runtime-0.2.1.tar.gz (3.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

prophet_events_runtime-0.2.1-py3-none-any.whl (3.7 kB view details)

Uploaded Python 3

File details

Details for the file prophet_events_runtime-0.2.1.tar.gz.

File metadata

  • Download URL: prophet_events_runtime-0.2.1.tar.gz
  • Upload date:
  • Size: 3.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for prophet_events_runtime-0.2.1.tar.gz
Algorithm Hash digest
SHA256 03748594689a2aa4884f1dd2bbb4a0878f1370c1cd340d6706466a1bed121325
MD5 af96f415e084d66b2f7edbd832a6deb7
BLAKE2b-256 3502b6d30ce170d766aed8538ccb81eae3683832b9bef8e9c4613d6b74e817c5

See more details on using hashes here.

Provenance

The following attestation bundles were made for prophet_events_runtime-0.2.1.tar.gz:

Publisher: publish-prophet-lib.yml on Chainso/prophet

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file prophet_events_runtime-0.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for prophet_events_runtime-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8622f14a077e94c4aaa5ba73116be33e3b5f7f779743a178eb17afeb83485f98
MD5 1163a6a2ac46e1b647edbec515f74a28
BLAKE2b-256 0bea7c36edcf7206b8fba40846b33e88deffaa4250441377a4853ed3743a9e23

See more details on using hashes here.

Provenance

The following attestation bundles were made for prophet_events_runtime-0.2.1-py3-none-any.whl:

Publisher: publish-prophet-lib.yml on Chainso/prophet

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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