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.4.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.4-py3-none-any.whl (3.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: prophet_events_runtime-0.2.4.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.4.tar.gz
Algorithm Hash digest
SHA256 7cfea482b240e9ae4650fdd63e682bc2ce1bffa1f4b7d8361e0b505f4ecc097b
MD5 6d00142e8c5e33f73096e6d494348883
BLAKE2b-256 4e77459fc50de992c3d5fbbaaace82424d48676e3b470b2ca4b6b965c9a7ffc1

See more details on using hashes here.

Provenance

The following attestation bundles were made for prophet_events_runtime-0.2.4.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.4-py3-none-any.whl.

File metadata

File hashes

Hashes for prophet_events_runtime-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 b69f3cdb49200e86f093784efe74ac7f015bdf37142bb7e831fbf094b0af1b3b
MD5 0c9ca5145d366de14c734bc6d6006a3c
BLAKE2b-256 efbbced7de2399e144347ff95e37beb8d83d48f76695251b40fbb0b5cad120cf

See more details on using hashes here.

Provenance

The following attestation bundles were made for prophet_events_runtime-0.2.4-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