csrd-message 0.3.0__tar.gz

csrd_message-0.3.0/.gitignore

@@ -0,0 +1,217 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+/env/
+/venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer,
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+*.db
+
+
+# Import linter cache
+.import_linter_cache/
+
+# IDE
+.idea/
+.idea/*

csrd_message-0.3.0/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,60 @@
+# 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/pyproject.toml

@@ -0,0 +1,25 @@
+[project]
+name = "csrd-message"
+version = "0.3.0"
+description = "Messaging abstractions for publisher/consumer workflows with optional RabbitMQ and Kafka extras"
+license = { text = "MIT" }
+requires-python = ">=3.12"
+dependencies = []
+readme = "README.md"
+
+[project.optional-dependencies]
+rabbit = ["aio-pika>=9,<10"]
+kafka = ["aiokafka>=0.11,<1"]
+all = ["aio-pika>=9,<10", "aiokafka>=0.11,<1"]
+
+[project.urls]
+Repository = "https://github.com/csrd-api/fastapi-common"
+Documentation = "https://github.com/csrd-api/fastapi-common/tree/main/packages/message"
+Changelog = "https://github.com/csrd-api/fastapi-common/blob/main/CHANGELOG.md"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/csrd"]

csrd_message-0.3.0/src/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-0.3.0/src/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/tests/test_message.py

@@ -0,0 +1,16 @@
+from csrd.message import Acknowledgement, Message
+
+
+def test_message_defaults() -> None:
+    msg = Message(topic="orders.created", payload={"id": "o-1"})
+
+    assert msg.topic == "orders.created"
+    assert msg.payload["id"] == "o-1"
+    assert msg.headers == {}
+    assert msg.timestamp is not None
+
+
+def test_ack_values() -> None:
+    assert Acknowledgement.ACK.value == "ack"
+    assert Acknowledgement.RETRY.value == "retry"
+    assert Acknowledgement.REJECT.value == "reject"