Metadata-Version: 2.4
Name: pico-kafka
Version: 0.1.0
Summary: Kafka for the Pico ecosystem: @kafka_consumer methods and @kafka_producer clients over aiokafka.
Author-email: David Perez Cabrera <dperezcabrera@gmail.com>
License: MIT License
        
        Copyright (c) 2025 David Pérez Cabrera
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/dperezcabrera/pico-kafka
Project-URL: Documentation, https://dperezcabrera.github.io/pico-kafka/
Project-URL: Repository, https://github.com/dperezcabrera/pico-kafka
Project-URL: Changelog, https://github.com/dperezcabrera/pico-kafka/blob/main/CHANGELOG.md
Project-URL: Issue Tracker, https://github.com/dperezcabrera/pico-kafka/issues
Keywords: kafka,messaging,streaming,aiokafka,ioc,spring boot
Classifier: Development Status :: 4 - Beta
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Typing :: Typed
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pico-ioc>=2.2.0
Requires-Dist: aiokafka>=0.11
Provides-Extra: dev
Requires-Dist: pytest>=8; extra == "dev"
Requires-Dist: pytest-asyncio; extra == "dev"
Requires-Dist: pytest-cov>=5; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Dynamic: license-file

# pico-kafka

[![PyPI](https://img.shields.io/pypi/v/pico-kafka.svg)](https://pypi.org/project/pico-kafka/)
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/dperezcabrera/pico-kafka)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
![CI (tox matrix)](https://github.com/dperezcabrera/pico-kafka/actions/workflows/ci.yml/badge.svg)
[![codecov](https://codecov.io/gh/dperezcabrera/pico-kafka/branch/main/graph/badge.svg)](https://codecov.io/gh/dperezcabrera/pico-kafka)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=dperezcabrera_pico-kafka&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=dperezcabrera_pico-kafka)
[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=dperezcabrera_pico-kafka&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=dperezcabrera_pico-kafka)
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=dperezcabrera_pico-kafka&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=dperezcabrera_pico-kafka)
[![PyPI Downloads](https://img.shields.io/pypi/dm/pico-kafka)](https://pypi.org/project/pico-kafka/)
[![Docs](https://img.shields.io/badge/Docs-pico--kafka-blue?style=flat&logo=readthedocs&logoColor=white)](https://dperezcabrera.github.io/pico-kafka/)
[![Interactive Lab](https://img.shields.io/badge/Learn-online-green?style=flat&logo=python&logoColor=white)](https://dperezcabrera.github.io/pico-learn/)

Kafka for the [pico ecosystem](https://github.com/dperezcabrera/pico-ioc): `@kafka_consumer` methods and declarative `@kafka_producer` clients over aiokafka.

## Installation

```bash
pip install pico-kafka
```

## Quick start

```yaml
kafka:
  bootstrap_servers: kafka.internal:9092
  group_id: myapp
```

Consume — a component method per topic, JSON value decoded for you:

```python
from pico_ioc import component
from pico_kafka import kafka_consumer

@component
class OrderProjection:
    @kafka_consumer("orders")
    async def on_order(self, message: dict):
        ...

    @kafka_consumer("orders", group_id="analytics")   # independent fan-out
    def on_order_analytics(self, message: dict):
        ...
```

Produce — stubs, like a pico-httpx client:

```python
from pico_kafka import kafka_producer, produce

@kafka_producer
class OrderEvents:
    @produce("orders")
    def order_created(self, message): ...
```

Semantics:

- Consumers and producers run on a dedicated background loop — works in sync scripts, FastAPI apps and workers alike, no lifespan wiring.
- Each record resolves its component through the container (prototype scope = fresh instance per record).
- A record whose handler raises is logged and **skipped** — offsets advance, a poison record cannot stall the partition.
- Sync produce stubs block until the broker acks; async stubs await it. Everything stops with the container.

## Documentation

Full documentation: https://dperezcabrera.github.io/pico-kafka/

## License

MIT
