Voltane-EU / djpykafka

djpykafka

🚧 This project is WIP and is subject to change at any time

This project is currently in the alpha state, even though it can be used in production with some caution. Make sure to fix the version in your requirements.txt and review changes frequently.

Installation

pip install djpykafka

Examples

Add the KafkaPublishMixin to your model class.

from django.db import models
from djpykafka.models import KafkaPublishMixin


class MyModel(KafkaPublishMixin, models.Model):
    ...

Create a publisher class, e.g. at events/publish/{modelname_plural}.py

from djpykafka.events.publish import EventPublisher, DataChangePublisher
from ... import models
from ...schemas import response
from . import connection


class MyModelPublisher(
    DataChangePublisher,
    EventPublisher,
    orm_model=models.MyModel,
    event_schema=response.MyModel,
    connection=connection,
    topic='bizberry.access.users',
    data_type='access.user',
):
    pass

AsyncAPI Docs

This feature is WIP.

Install djpykafka with the extra docs (pip install djpykafka[docs]) and add the following snippets to your asgi.py:

from starlette.responses import HTMLResponse, JSONResponse
from starlette.routing import Route
from fastapi.encoders import jsonable_encoder
from asyncapi_docgen.docs import get_asyncapi_ui_html

# ! Import after django's get_asgi_application()

from djpykafka.docs.asyncapi import get_asyncapi


def asyncapi_html(request):
    return HTMLResponse(get_asyncapi_ui_html(asyncapi_url='/asyncapi.json'))


def asyncapi_json(request):
    return JSONResponse(jsonable_encoder(get_asyncapi(), by_alias=True, exclude_none=True))


app = FastAPI(
    ...,
    routes=[
        Route('/asyncapi', asyncapi_html),
        Route('/asyncapi.json', asyncapi_json),
    ],
)