docs: rabbitmq example added (#546)

docs/examples.md

@@ -32,3 +32,13 @@ Minimal redis [example](https://github.com/marcosschroh/dataclasses-avroschema/t
 ```
 
 *(This script is complete, it should run "as is")*
+
+## RabbitMQ examples
+
+Minimal rabbitmq [example](https://github.com/marcosschroh/dataclasses-avroschema/blob/master/examples/rabbitmq-examples/rabbitmq-pika/rabbitmq_pika/app.py) with [pika](https://github.com/pika/pika) driver.
+
+```python title="rabbitmq example"
+--8<-- "examples/rabbitmq-examples/rabbitmq-pika/rabbitmq_pika/app.py"
+```
+
+*(This script is complete, it should run "as is")*

examples/rabbitmq-examples/README.md

@@ -0,0 +1,48 @@
+# Examples of dataclasses-avroschema with RabbitMQ
+
+You will find an example of how to use [dataclasses-avroschema](https://github.com/marcosschroh/dataclasses-avroschema) and the integration with the python drivers [pika](https://github.com/pika/pika)
+
+## Requirements
+
+`python 3.8+ poetry docker docker-compose`
+
+### Cluster setup
+
+1. `cd rabbitmq-examples`
+1. `docker-compose up` to start the rabbitmq cluster
+
+## Examples
+
+As examples you will find how to serialize/deserialize python dataclasses using the `AvroModel` provided by `dataclasses-avroschema` and how to produce/consume events using specifics python kafka drivers.
+
+The model is for the examples is the following:
+
+```python
+class FavoriteColor(enum.Enum):
+    BLUE = "BLUE"
+    YELLOW = "YELLOW"
+    GREEN = "GREEN"
+
+
+@dataclass
+class UserModel(AvroModel):
+    "An User"
+    name: str
+    age: int
+    favorite_colors: FavoriteColor = FavoriteColor.BLUE
+    country: str = "Argentina"
+    address: Optional[str] = None
+
+    class Meta:
+        namespace = "User.v1"
+        aliases = ["user-v1", "super user"]
+```
+
+### dataclasses-avroschema and redis streams with walrus
+
+In the file [app.py](https://github.com/marcosschroh/dataclasses-avroschema/blob/master/examples/rabbitmq-examples/rabbitmq-pika/rabbitmq_pika/app.py) you will find a the simplest use case of `rabbitmq streams` using the driver `pike`.
+
+1. `cd rabbitmq-examples/rabbitmq-pika`
+1. `poetry install`
+1. `poetry run app`
+1. To stop the producer/consumer use `Ctrl + c`

examples/rabbitmq-examples/docker-compose.yaml

@@ -0,0 +1,9 @@
+version: '3'
+services:
+  rabbitmq:
+    image: "rabbitmq:3.10"
+    hostname: rabbitmq
+    container_name: rabbitmq
+    ports:
+      - 5672:5672
+

examples/rabbitmq-examples/rabbitmq-pika/pyproject.toml

@@ -0,0 +1,20 @@
+[tool.poetry]
+name = "rabbitmq-pika"
+version = "0.1.0"
+description = ""
+authors = ["marcosschroh <schrohm@gmail.com>"]
+packages = [{include = "rabbitmq_pika"}]
+
+[tool.poetry.dependencies]
+python = "^3.8"
+dataclasses-avroschema = { path = "../../../.", develop = true }
+pika = "^1.3.2"
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.scripts]
+app = "rabbitmq_pika.app:main"
+

examples/rabbitmq-examples/rabbitmq-pika/rabbitmq_pika/app.py

@@ -0,0 +1,79 @@
+import enum
+import random
+from dataclasses import dataclass
+from typing import Optional
+
+import pika
+
+from dataclasses_avroschema import AvroModel
+
+
+class FavoriteColor(enum.Enum):
+    BLUE = "BLUE"
+    YELLOW = "YELLOW"
+    GREEN = "GREEN"
+
+
+@dataclass
+class UserModel(AvroModel):
+    "An User"
+
+    name: str
+    age: int
+    favorite_colors: FavoriteColor = FavoriteColor.BLUE
+    country: str = "Argentina"
+    address: Optional[str] = None
+
+    class Meta:
+        namespace = "User.v1"
+        aliases = ["user-v1", "super user"]
+
+
+def consume(*, channel, queue_name: str):
+    def callback(channel: str, method, properties, body):
+        print(f"Message received with body: {body} in channel {method} \n")
+        user = UserModel.deserialize(body)
+        print(f"Message deserialized: {user} \n")
+
+    channel.basic_consume(on_message_callback=callback, queue=queue_name)
+    channel.start_consuming()
+
+
+def produce(*, channel, queue_name: str, total_events: int = 10):
+    for event_number in range(1, total_events + 1):
+        # Produce message
+        print(f"Sending event number {event_number}")
+
+        user = UserModel(
+            name=random.choice(
+                [
+                    "Juan",
+                    "Peter",
+                    "Michael",
+                    "Moby",
+                    "Kim",
+                ]
+            ),
+            age=random.randint(1, 50),
+        )
+
+        # create the message
+        message = user.serialize()
+
+        # publish
+        channel.basic_publish(exchange="", routing_key=queue_name, body=message)
+
+
+def main():
+    rabbitmq_url = "amqp://guest:guest@localhost:5672/%2f"
+    queue_name = "test-stream"
+    params = pika.URLParameters(rabbitmq_url)
+
+    connection = pika.BlockingConnection(params)
+    channel = connection.channel()
+    channel.queue_declare(queue=queue_name, durable=True)
+
+    produce(channel=channel, queue_name=queue_name)
+    consume(channel=channel, queue_name=queue_name)
+
+    connection.close()

examples/redis-examples/README.md

@@ -9,7 +9,7 @@ You will find an example of how to use [dataclasses-avroschema](https://github.c
 ### Cluster setup
 
 1. `cd redis-examples`
-1. `make redis-cluster` to start the kafka cluster (kafka and zookeeper)
+1. `make redis-cluster` to start the redis cluster
 
 ## Examples