openframe-adapters-queue-kafka 1.1.0__tar.gz

openframe_adapters_queue_kafka-1.1.0/.gitignore

@@ -0,0 +1,221 @@
+# 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
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# 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/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# Miscellaneous
+.DS_Store

openframe_adapters_queue_kafka-1.1.0/PKG-INFO

@@ -0,0 +1,150 @@
+Metadata-Version: 2.4
+Name: openframe-adapters-queue-kafka
+Version: 1.1.0
+Summary: OpenFrame Microservice Suite - Apache Kafka queue adapter.
+Project-URL: Homepage, https://github.com/Furious-Meteors/openframe-adapters
+Project-URL: Documentation, https://furious-meteors.github.io/openframe-adapters/
+Project-URL: Repository, https://github.com/Furious-Meteors/openframe-adapters
+Project-URL: Changelog, https://github.com/Furious-Meteors/openframe-adapters/blob/production/.github/CHANGELOG.md
+Project-URL: Bug Tracker, https://github.com/Furious-Meteors/openframe-adapters/issues
+Author-email: Furious Meteors Engineering <engineering@furiousmeteors.dev>
+Maintainer-email: Furious Meteors Engineering <engineering@furiousmeteors.dev>
+License: MIT
+Keywords: hexagonal,kafka,messaging,microservice,openframe,queue
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Distributed Computing
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: aiokafka>=0.11
+Requires-Dist: openframe-core<3,>=2.0
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest-mock>=3.14; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# openframe-adapters-queue-kafka
+
+Apache Kafka queue adapter for the **OpenFrame Microservice Development Suite**.
+
+Part of the [`openframe-adapters`](https://github.com/Furious-Meteors/openframe-adapters) monorepo.
+
+---
+
+## What it provides
+
+| Symbol | Purpose |
+|---|---|
+| `KafkaSettings` | Pydantic-settings subclass — reads all config from env vars |
+| `KafkaProducer[T]` | Generic async message producer — `BaseProducer[T]` |
+| `KafkaConsumer[T]` | Generic async message consumer — `BaseConsumer[T]` |
+| `KafkaPlugin` | `OpenFramePlugin` — structured lifecycle via `PluginRegistry` |
+
+## Installation
+
+```bash
+# Via meta-package (recommended)
+pip install "openframe-adapters[kafka]"
+
+# Or directly
+pip install openframe-adapters-queue-kafka
+```
+
+## Quick start
+
+```python
+from openframe.adapters.queue.kafka import KafkaSettings, KafkaProducer, KafkaConsumer
+
+settings = KafkaSettings(kafka_bootstrap_servers="localhost:9092")
+
+# Produce
+producer = KafkaProducer(settings)
+await producer.start()
+await producer.publish({"event": "item.created", "id": "abc"})
+await producer.publish_batch([{"event": "x"}, {"event": "y"}])
+await producer.close()
+
+# Consume
+consumer = KafkaConsumer(settings)
+
+async def handle(event: dict) -> None:
+    print(f"Received: {event}")
+
+await consumer.subscribe(handle)   # runs until consumer.close() called
+```
+
+## Configuration
+
+| Env var | Default | Description |
+|---|---|---|
+| `KAFKA_BOOTSTRAP_SERVERS` | **required** | `host:port,host:port` |
+| `KAFKA_TOPIC` | `"openframe"` | Default topic for producer and consumer |
+| `KAFKA_GROUP_ID` | `"openframe-group"` | Consumer group ID |
+| `KAFKA_AUTO_OFFSET_RESET` | `"earliest"` | `"earliest"` or `"latest"` |
+| `KAFKA_MAX_POLL_RECORDS` | `10` | Max messages per poll |
+| `KAFKA_SESSION_TIMEOUT_MS` | `30000` | Consumer session timeout |
+| `KAFKA_REQUEST_TIMEOUT_MS` | `30000` | Broker request timeout |
+| `KAFKA_SECURITY_PROTOCOL` | `"PLAINTEXT"` | `"PLAINTEXT"`, `"SSL"`, `"SASL_PLAINTEXT"` |
+| `KAFKA_SASL_MECHANISM` | `""` | `"PLAIN"`, `"SCRAM-SHA-256"`, etc. |
+| `KAFKA_SASL_USERNAME` | `""` | SASL username |
+| `KAFKA_SASL_PASSWORD` | `""` | SASL password |
+
+## Typed domain objects
+
+```python
+from openframe.adapters.queue.kafka import KafkaProducer, KafkaConsumer, KafkaSettings
+from dataclasses import dataclass, asdict
+
+@dataclass
+class OrderEvent:
+    order_id: str
+    event_type: str
+
+class OrderProducer(KafkaProducer[OrderEvent]):
+    def _serialise(self, message: OrderEvent) -> bytes:
+        import json
+        return json.dumps(asdict(message)).encode("utf-8")
+
+class OrderConsumer(KafkaConsumer[OrderEvent]):
+    def _deserialise(self, raw: bytes) -> OrderEvent:
+        import json
+        return OrderEvent(**json.loads(raw.decode("utf-8")))
+```
+
+## Plugin lifecycle (optional)
+
+```python
+from openframe.core.plugins import PluginRegistry
+from openframe.adapters.queue.kafka import KafkaPlugin, KafkaSettings
+
+registry = PluginRegistry()
+registry.register(KafkaPlugin(KafkaSettings()))
+await registry.initialize_all()
+
+plugin = registry.get("queue")
+producer = plugin.get_producer()
+await producer.publish({"event": "item.created"})
+
+consumer = plugin.make_consumer()
+await consumer.subscribe(handler)
+```
+
+## Consumer acknowledgement semantics
+
+| Outcome | Behaviour |
+|---|---|
+| Handler returns | `ack()` called → offset committed → message consumed |
+| Handler raises | `nack()` called → no commit → message redelivered |
+| `consumer.close()` | polling loop exits → consumer stopped cleanly |
+
+## License
+
+MIT — © Furious Meteors Engineering

openframe_adapters_queue_kafka-1.1.0/README.md

@@ -0,0 +1,117 @@
+# openframe-adapters-queue-kafka
+
+Apache Kafka queue adapter for the **OpenFrame Microservice Development Suite**.
+
+Part of the [`openframe-adapters`](https://github.com/Furious-Meteors/openframe-adapters) monorepo.
+
+---
+
+## What it provides
+
+| Symbol | Purpose |
+|---|---|
+| `KafkaSettings` | Pydantic-settings subclass — reads all config from env vars |
+| `KafkaProducer[T]` | Generic async message producer — `BaseProducer[T]` |
+| `KafkaConsumer[T]` | Generic async message consumer — `BaseConsumer[T]` |
+| `KafkaPlugin` | `OpenFramePlugin` — structured lifecycle via `PluginRegistry` |
+
+## Installation
+
+```bash
+# Via meta-package (recommended)
+pip install "openframe-adapters[kafka]"
+
+# Or directly
+pip install openframe-adapters-queue-kafka
+```
+
+## Quick start
+
+```python
+from openframe.adapters.queue.kafka import KafkaSettings, KafkaProducer, KafkaConsumer
+
+settings = KafkaSettings(kafka_bootstrap_servers="localhost:9092")
+
+# Produce
+producer = KafkaProducer(settings)
+await producer.start()
+await producer.publish({"event": "item.created", "id": "abc"})
+await producer.publish_batch([{"event": "x"}, {"event": "y"}])
+await producer.close()
+
+# Consume
+consumer = KafkaConsumer(settings)
+
+async def handle(event: dict) -> None:
+    print(f"Received: {event}")
+
+await consumer.subscribe(handle)   # runs until consumer.close() called
+```
+
+## Configuration
+
+| Env var | Default | Description |
+|---|---|---|
+| `KAFKA_BOOTSTRAP_SERVERS` | **required** | `host:port,host:port` |
+| `KAFKA_TOPIC` | `"openframe"` | Default topic for producer and consumer |
+| `KAFKA_GROUP_ID` | `"openframe-group"` | Consumer group ID |
+| `KAFKA_AUTO_OFFSET_RESET` | `"earliest"` | `"earliest"` or `"latest"` |
+| `KAFKA_MAX_POLL_RECORDS` | `10` | Max messages per poll |
+| `KAFKA_SESSION_TIMEOUT_MS` | `30000` | Consumer session timeout |
+| `KAFKA_REQUEST_TIMEOUT_MS` | `30000` | Broker request timeout |
+| `KAFKA_SECURITY_PROTOCOL` | `"PLAINTEXT"` | `"PLAINTEXT"`, `"SSL"`, `"SASL_PLAINTEXT"` |
+| `KAFKA_SASL_MECHANISM` | `""` | `"PLAIN"`, `"SCRAM-SHA-256"`, etc. |
+| `KAFKA_SASL_USERNAME` | `""` | SASL username |
+| `KAFKA_SASL_PASSWORD` | `""` | SASL password |
+
+## Typed domain objects
+
+```python
+from openframe.adapters.queue.kafka import KafkaProducer, KafkaConsumer, KafkaSettings
+from dataclasses import dataclass, asdict
+
+@dataclass
+class OrderEvent:
+    order_id: str
+    event_type: str
+
+class OrderProducer(KafkaProducer[OrderEvent]):
+    def _serialise(self, message: OrderEvent) -> bytes:
+        import json
+        return json.dumps(asdict(message)).encode("utf-8")
+
+class OrderConsumer(KafkaConsumer[OrderEvent]):
+    def _deserialise(self, raw: bytes) -> OrderEvent:
+        import json
+        return OrderEvent(**json.loads(raw.decode("utf-8")))
+```
+
+## Plugin lifecycle (optional)
+
+```python
+from openframe.core.plugins import PluginRegistry
+from openframe.adapters.queue.kafka import KafkaPlugin, KafkaSettings
+
+registry = PluginRegistry()
+registry.register(KafkaPlugin(KafkaSettings()))
+await registry.initialize_all()
+
+plugin = registry.get("queue")
+producer = plugin.get_producer()
+await producer.publish({"event": "item.created"})
+
+consumer = plugin.make_consumer()
+await consumer.subscribe(handler)
+```
+
+## Consumer acknowledgement semantics
+
+| Outcome | Behaviour |
+|---|---|
+| Handler returns | `ack()` called → offset committed → message consumed |
+| Handler raises | `nack()` called → no commit → message redelivered |
+| `consumer.close()` | polling loop exits → consumer stopped cleanly |
+
+## License
+
+MIT — © Furious Meteors Engineering

openframe_adapters_queue_kafka-1.1.0/openframe/__init__.py

@@ -0,0 +1 @@
+__path__ = __import__("pkgutil").extend_path(__path__, __name__)

openframe_adapters_queue_kafka-1.1.0/openframe/adapters/__init__.py

@@ -0,0 +1 @@
+__path__ = __import__("pkgutil").extend_path(__path__, __name__)

openframe_adapters_queue_kafka-1.1.0/openframe/adapters/queue/__init__.py

@@ -0,0 +1 @@
+__path__ = __import__("pkgutil").extend_path(__path__, __name__)

openframe_adapters_queue_kafka-1.1.0/openframe/adapters/queue/kafka/__init__.py

@@ -0,0 +1,49 @@
+"""
+openframe.adapters.queue.kafka
+================================
+Apache Kafka queue adapter for the OpenFrame Microservice Suite.
+
+Public API::
+
+    KafkaSettings  — Pydantic Settings subclass for connection config.
+    KafkaProducer  — Generic async message producer (BaseProducer[T]).
+    KafkaConsumer  — Generic async message consumer (BaseConsumer[T]).
+    KafkaPlugin    — OpenFramePlugin implementation for PluginRegistry.
+
+Quick start::
+
+    from openframe.adapters.queue.kafka import (
+        KafkaSettings,
+        KafkaProducer,
+        KafkaConsumer,
+    )
+
+    settings = KafkaSettings(kafka_bootstrap_servers="localhost:9092")
+
+    # Produce
+    producer = KafkaProducer(settings)
+    await producer.start()
+    await producer.publish({"event": "item.created", "id": "abc"})
+    await producer.close()
+
+    # Consume
+    consumer = KafkaConsumer(settings)
+
+    async def handle(event: dict) -> None:
+        print(f"Received: {event}")
+
+    await consumer.subscribe(handle)
+"""
+from __future__ import annotations
+
+from .config import KafkaSettings
+from .consumer import KafkaConsumer
+from .plugin import KafkaPlugin
+from .producer import KafkaProducer
+
+__all__ = [
+    "KafkaSettings",
+    "KafkaProducer",
+    "KafkaConsumer",
+    "KafkaPlugin",
+]

openframe_adapters_queue_kafka-1.1.0/openframe/adapters/queue/kafka/config.py

@@ -0,0 +1,51 @@
+"""
+openframe/adapters/queue/kafka/config.py
+==========================================
+Settings for the Kafka queue adapter, sourced from environment variables
+via ``openframe-core``'s ``BaseAdapterSettings`` (pydantic-settings).
+
+Required env vars:
+    KAFKA_BOOTSTRAP_SERVERS: Comma-separated broker list.
+                             Format: host:port,host:port
+
+Optional env vars (all have defaults):
+    KAFKA_TOPIC:              str  = "openframe"       — default topic
+    KAFKA_GROUP_ID:           str  = "openframe-group" — consumer group
+    KAFKA_AUTO_OFFSET_RESET:  str  = "earliest"
+    KAFKA_MAX_POLL_RECORDS:   int  = 10
+    KAFKA_SESSION_TIMEOUT_MS: int  = 30000
+    KAFKA_REQUEST_TIMEOUT_MS: int  = 30000
+    KAFKA_SECURITY_PROTOCOL:  str  = "PLAINTEXT"
+    KAFKA_SASL_MECHANISM:     str  = ""
+    KAFKA_SASL_USERNAME:      str  = ""
+    KAFKA_SASL_PASSWORD:      str  = ""
+    ADAPTER_NAME:             str  = "kafka"
+"""
+from __future__ import annotations
+
+from openframe.core.config import BaseAdapterSettings
+
+__all__ = ["KafkaSettings"]
+
+
+class KafkaSettings(BaseAdapterSettings):
+    """
+    Pydantic-settings subclass for the Kafka queue adapter.
+
+    All fields are read from environment variables with the exact names
+    shown above. ``BaseAdapterSettings`` provides ``operation_timeout``
+    (default 30.0 s) and ``connection_timeout`` (default 30.0 s).
+    """
+
+    kafka_bootstrap_servers: str
+    kafka_topic: str = "openframe"
+    kafka_group_id: str = "openframe-group"
+    kafka_auto_offset_reset: str = "earliest"
+    kafka_max_poll_records: int = 10
+    kafka_session_timeout_ms: int = 30_000
+    kafka_request_timeout_ms: int = 30_000
+    kafka_security_protocol: str = "PLAINTEXT"
+    kafka_sasl_mechanism: str = ""
+    kafka_sasl_username: str = ""
+    kafka_sasl_password: str = ""
+    adapter_name: str = "kafka"