Franz library init

.gitignore

@@ -0,0 +1,107 @@
+# Created by .ignore support plugin (hsz.mobi)
+### Python template
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+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/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+.static_storage/
+.media/
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Carta, Inc.
+
+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.

Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = franz
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

README.md

@@ -0,0 +1,79 @@
+# Franz
+
+A lite wrapper around [Kafka](https://kafka.apache.org/) and [RabbitMQ](https://www.rabbitmq.com/).
+
+# Usage
+
+## Installation
+- `pip -e [email protected]:eshares/franz.git@master#egg=franz`
+  - Change `@master` to a version or commit if required.
+
+## RabbitMQ
+### Sending a message
+```python
+import random
+import time
+
+import franz
+
+
+class FranzData(franz.FranzEvent):
+    def serialize(self):
+        return {'data': time.time()}
+
+
+with franz.RabbitProducer(exchange='topic_link') as p:
+    while True:
+        key = random.choice(['hello.world', 'hello.bob'])
+        p.send_message(key, FranzData())
+        time.sleep(1)
+```
+
+### Consuming messages
+```python
+import franz
+
+def callback(ch, method, properties, body):
+    print('[+] {} from {}'.format(body, method.routing_key))
+
+with franz.RabbitConsumer('hello.*', exchange='topic_link') as c:
+    c.consume_messages(callback)
+```
+
+
+## Kafka
+### Sending a message
+```python
+import franz
+from myapp.models import SomeModel  # SomeModel must inherit `franz.FranzEvent`
+
+instance = SomeModel.objects.get(pk=1)
+producer = franz.KafkaProducer()
+producer.send_message('TopicA', instance)
+```
+
+### Consuming messages
+```python
+import franz
+
+consumer = franz.KafkaConsumer('TopicA')
+for message in consumer:
+    print(message.value)
+```
+
+### Kafka/Docker Resources
+
+- [Docker image](https://github.com/spotify/docker-kafka)
+- [Helpful article](https://howtoprogram.xyz/2016/07/21/using-apache-kafka-docker/)
+- Create topic
+```
+./kafka-topics.sh --create --topic test --replication-factor 1 --partitions 1 --zookeeper 0.0.0.0:2181
+```
+- Consuming
+```
+./kafka-console-consumer.sh --topic test --from-beginning --zookeeper 0.0.0.0:2181
+```
+- Producing
+```
+./kafka-console-producer.sh --topic test --broker-list 0.0.0.0:9092
+```