# Muffin-Kafka
**Muffin-Kafka** – [Apache Kafka](https://kafka.apache.org) integration for [Muffin](https://klen.github.io/muffin) framework
[![Tests Status](https://github.com/klen/muffin-kafka/workflows/tests/badge.svg)](https://github.com/klen/muffin-kafka/actions)
[![PYPI Version](https://img.shields.io/pypi/v/muffin-kafka)](https://pypi.org/project/muffin-kafka/)
[![Python Versions](https://img.shields.io/pypi/pyversions/muffin-kafka)](https://pypi.org/project/muffin-kafka/)
## Requirements
* python >= 3.9
## Installation
**muffin-kafka** should be installed using pip:
```shell
$ pip install muffin-kafka
```
## Usage
```python
from muffin import Application
import muffin_kafka
# Create Muffin Application
app = Application('example')
# Initialize the plugin
kafka = muffin_kafka.Plugin(app, **options)
# As alternative:
# kafka = muffin_kafka.Plugin()
# ...
# kafka.setup(app, dsn="DSN_URL")
```
### Setup the plugin
TODO
## Bug tracker
If you have any suggestions, bug reports or annoyances please report them to
the issue tracker at https://github.com/klen/muffin-kafka/issues
## Contributing
Development of the project happens at: https://github.com/klen/muffin-kafka
## License
Licensed under a [MIT License](http://opensource.org/licenses/MIT)
Raw data
{
"_id": null,
"home_page": "https://github.com/klen/muffin-kafka",
"name": "muffin-kafka",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "kafka, asyncio, asgi, muffin",
"author": "Kirill Klenov",
"author_email": "horneds@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ca/ab/6f48f6d1353ca9ee5e03e9308f099ab01618b53be61bcbf0f6647ba4ceea/muffin_kafka-0.5.2.tar.gz",
"platform": null,
"description": "# Muffin-Kafka\n\n**Muffin-Kafka** \u2013 [Apache Kafka](https://kafka.apache.org) integration for [Muffin](https://klen.github.io/muffin) framework\n\n[![Tests Status](https://github.com/klen/muffin-kafka/workflows/tests/badge.svg)](https://github.com/klen/muffin-kafka/actions)\n[![PYPI Version](https://img.shields.io/pypi/v/muffin-kafka)](https://pypi.org/project/muffin-kafka/)\n[![Python Versions](https://img.shields.io/pypi/pyversions/muffin-kafka)](https://pypi.org/project/muffin-kafka/)\n\n## Requirements\n\n* python >= 3.9\n\n## Installation\n\n**muffin-kafka** should be installed using pip:\n\n```shell\n$ pip install muffin-kafka\n```\n\n## Usage\n\n```python\n from muffin import Application\n import muffin_kafka\n\n # Create Muffin Application\n app = Application('example')\n\n # Initialize the plugin\n kafka = muffin_kafka.Plugin(app, **options)\n\n # As alternative:\n # kafka = muffin_kafka.Plugin()\n # ...\n # kafka.setup(app, dsn=\"DSN_URL\")\n\n```\n\n### Setup the plugin\n\nTODO\n\n## Bug tracker\n\nIf you have any suggestions, bug reports or annoyances please report them to\nthe issue tracker at https://github.com/klen/muffin-kafka/issues\n\n\n## Contributing\n\nDevelopment of the project happens at: https://github.com/klen/muffin-kafka\n\n\n## License\n\nLicensed under a [MIT License](http://opensource.org/licenses/MIT)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Kafka Integration for Muffin framework",
"version": "0.5.2",
"project_urls": {
"Homepage": "https://github.com/klen/muffin-kafka",
"Repository": "https://github.com/klen/muffin-kafka"
},
"split_keywords": [
"kafka",
" asyncio",
" asgi",
" muffin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3cd4210b4b44bd9c9180ff2acb67e6d46cc4500289d492fe47d4f6649277c933",
"md5": "fc3a374be68cdb613e840395c6cdfb9d",
"sha256": "bb6db249cb5fe73cc22c633d9c589882db7e926ef9f92657f6fb8736073f83be"
},
"downloads": -1,
"filename": "muffin_kafka-0.5.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fc3a374be68cdb613e840395c6cdfb9d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 4544,
"upload_time": "2024-10-18T09:39:49",
"upload_time_iso_8601": "2024-10-18T09:39:49.834931Z",
"url": "https://files.pythonhosted.org/packages/3c/d4/210b4b44bd9c9180ff2acb67e6d46cc4500289d492fe47d4f6649277c933/muffin_kafka-0.5.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "caab6f48f6d1353ca9ee5e03e9308f099ab01618b53be61bcbf0f6647ba4ceea",
"md5": "9c897d938766c64a4cc79b2c8f5c6652",
"sha256": "332c558cd18b322cdedaf7f0727213ea30ba65c2e2fab43943ecf3ed6cd9fb98"
},
"downloads": -1,
"filename": "muffin_kafka-0.5.2.tar.gz",
"has_sig": false,
"md5_digest": "9c897d938766c64a4cc79b2c8f5c6652",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 4412,
"upload_time": "2024-10-18T09:39:50",
"upload_time_iso_8601": "2024-10-18T09:39:50.730395Z",
"url": "https://files.pythonhosted.org/packages/ca/ab/6f48f6d1353ca9ee5e03e9308f099ab01618b53be61bcbf0f6647ba4ceea/muffin_kafka-0.5.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-18 09:39:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "klen",
"github_project": "muffin-kafka",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "muffin-kafka"
}