spakky-kafka 3.4.0

Apache Kafka plugin for Spakky framework

Spakky Kafka

Apache Kafka plugin for Spakky Framework.

Installation

pip install spakky-kafka

Or install via Spakky extras:

pip install spakky[kafka]

Configuration

Set environment variables with the SPAKKY_KAFKA_ prefix:

export SPAKKY_KAFKA_GROUP_ID="my-consumer-group"
export SPAKKY_KAFKA_CLIENT_ID="my-app"
export SPAKKY_KAFKA_BOOTSTRAP_SERVERS="localhost:9092"
export SPAKKY_KAFKA_AUTO_OFFSET_RESET="earliest"  # earliest, latest, none

SASL Authentication (Optional)

export SPAKKY_KAFKA_SECURITY_PROTOCOL="SASL_SSL"
export SPAKKY_KAFKA_SASL_MECHANISM="PLAIN"
export SPAKKY_KAFKA_SASL_USERNAME="username"
export SPAKKY_KAFKA_SASL_PASSWORD="password"

Topic Configuration (Optional)

export SPAKKY_KAFKA_NUMBER_OF_PARTITIONS="3"
export SPAKKY_KAFKA_REPLICATION_FACTOR="1"

Usage

Event Publishing

from spakky.domain.models.event import AbstractDomainEvent
from spakky.domain.ports.event.event_publisher import IEventPublisher
from spakky.pod.annotations.pod import Pod

class UserCreatedEvent(AbstractDomainEvent):
    user_id: int
    email: str

@Pod()
class UserService:
    def __init__(self, publisher: IEventPublisher) -> None:
        self.publisher = publisher

    def create_user(self, email: str) -> User:
        user = User(email=email)
        self.publisher.publish(UserCreatedEvent(user_id=user.id, email=email))
        return user

Event Consuming

from spakky.stereotype.event_handler import EventHandler, on_event

@EventHandler()
class UserEventHandler:
    def __init__(self, notification_service: NotificationService) -> None:
        self.notification_service = notification_service

    @on_event(UserCreatedEvent)
    async def on_user_created(self, event: UserCreatedEvent) -> None:
        await self.notification_service.send_welcome_email(event.email)

Async Variants

For async applications, use IAsyncEventPublisher:

from spakky.domain.ports.event.event_publisher import IAsyncEventPublisher

@Pod()
class AsyncUserService:
    def __init__(self, publisher: IAsyncEventPublisher) -> None:
        self.publisher = publisher

    async def create_user(self, email: str) -> User:
        user = User(email=email)
        await self.publisher.publish(UserCreatedEvent(user_id=user.id, email=email))
        return user

Features

• Automatic topic creation: Topics are created based on event type names
• Sync and Async support: Both synchronous and asynchronous publishers/consumers
• Background service pattern: Consumer polling runs as a background service
• Pydantic serialization: Events are serialized/deserialized using Pydantic
• Confluent Kafka client: Built on the robust confluent-kafka library

Components

Component	Description
KafkaEventPublisher	Synchronous event publisher
AsyncKafkaEventPublisher	Asynchronous event publisher
KafkaEventConsumer	Synchronous event consumer (background service)
AsyncKafkaEventConsumer	Asynchronous event consumer (background service)
KafkaConnectionConfig	Configuration via environment variables

License

MIT License