csrd-message 0.3.0__py3-none-any.whl

csrd/message/__init__.py

@@ -0,0 +1,10 @@
+"""Messaging abstractions for publisher/consumer workflows.
+
+This package intentionally provides broker-agnostic interfaces first.
+Concrete adapters (for example RabbitMQ/Kafka) are expected to implement
+these protocols in follow-up iterations.
+"""
+
+from ._types import Acknowledgement, Message, MessageConsumer, MessagePublisher
+
+__all__ = ("Acknowledgement", "Message", "MessageConsumer", "MessagePublisher")

csrd/message/_types.py

@@ -0,0 +1,38 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from datetime import UTC, datetime
+from enum import StrEnum
+from typing import Any, Protocol
+
+
+class Acknowledgement(StrEnum):
+    """Consumer acknowledgement decision for a processed message."""
+
+    ACK = "ack"
+    RETRY = "retry"
+    REJECT = "reject"
+
+
+@dataclass(frozen=True, slots=True)
+class Message:
+    """Immutable transport-agnostic message envelope."""
+
+    topic: str
+    payload: dict[str, Any]
+    key: str | None = None
+    headers: dict[str, str] = field(default_factory=dict)
+    message_id: str | None = None
+    timestamp: datetime = field(default_factory=lambda: datetime.now(UTC))
+
+
+class MessagePublisher(Protocol):
+    """Protocol contract for outbound message publishing."""
+
+    async def publish(self, message: Message) -> None: ...
+
+
+class MessageConsumer(Protocol):
+    """Protocol contract for inbound message consumption."""
+
+    async def consume(self, message: Message) -> Acknowledgement: ...

csrd_message-0.3.0.dist-info/METADATA

@@ -0,0 +1,78 @@
+Metadata-Version: 2.4
+Name: csrd-message
+Version: 0.3.0
+Summary: Messaging abstractions for publisher/consumer workflows with optional RabbitMQ and Kafka extras
+Project-URL: Repository, https://github.com/csrd-api/fastapi-common
+Project-URL: Documentation, https://github.com/csrd-api/fastapi-common/tree/main/packages/message
+Project-URL: Changelog, https://github.com/csrd-api/fastapi-common/blob/main/CHANGELOG.md
+License: MIT
+Requires-Python: >=3.12
+Provides-Extra: all
+Requires-Dist: aio-pika<10,>=9; extra == 'all'
+Requires-Dist: aiokafka<1,>=0.11; extra == 'all'
+Provides-Extra: kafka
+Requires-Dist: aiokafka<1,>=0.11; extra == 'kafka'
+Provides-Extra: rabbit
+Requires-Dist: aio-pika<10,>=9; extra == 'rabbit'
+Description-Content-Type: text/markdown
+
+# csrd.message
+
+Transport-agnostic message abstractions for publish/consume workflows.
+
+## Why this package exists
+
+- Provide a stable API for messaging behavior independent of broker choice
+- Enable optional broker installs with extras (`rabbit`, `kafka`)
+- Keep service code portable across RabbitMQ and Kafka backends
+
+## Installation
+
+```bash
+# Core abstractions only
+uv add csrd-message
+
+# RabbitMQ support
+uv add 'csrd-message[rabbit]'
+
+# Kafka support
+uv add 'csrd-message[kafka]'
+
+# Both brokers
+uv add 'csrd-message[all]'
+```
+
+## Important extras note
+
+Python extras are part of the same PyPI project, not a separate project.
+
+- `csrd-message` and `csrd-message[rabbit]` resolve to the same package name (`csrd-message`)
+- The extra only adds optional dependencies declared by this package
+- Extras do not create new package names on PyPI
+
+## Initial API surface
+
+- `Message` - immutable message envelope
+- `MessagePublisher` - protocol for publishing messages
+- `MessageConsumer` - protocol for consuming messages
+- `Acknowledgement` - ack/retry/reject semantics
+
+## Quick example
+
+```python
+from csrd.message import Acknowledgement, Message, MessagePublisher
+
+
+class InMemoryPublisher:
+    async def publish(self, message: Message) -> None:
+        print(message.topic, message.payload)
+
+
+async def send(publisher: MessagePublisher) -> None:
+    await publisher.publish(Message(topic="orders.created", payload={"order_id": "o-1"}))
+```
+
+## Status
+
+This is a v0 skeleton package to reserve naming and establish contracts.
+Concrete RabbitMQ/Kafka adapters are planned follow-up work, while the shared envelope/protocol API is considered stable for early adopters.

csrd_message-0.3.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+csrd/message/__init__.py,sha256=qGquWw5hHJIXGYE2JAOoJz0cI1mZfYg4yxfVn9KQCVw,411
+csrd/message/_types.py,sha256=W1gb-gW6u1uUfiJxx7geX9r1EQ8yDsaF7PAqyVnj5J0,1004
+csrd/message/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+csrd_message-0.3.0.dist-info/METADATA,sha256=TQxYQkGnVZYDhTrEc6RpLNpMPPtmL6q8nrXmDBytc30,2430
+csrd_message-0.3.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+csrd_message-0.3.0.dist-info/RECORD,,

csrd_message-0.3.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any