preparing for first release

Author: DanielePalaia

README.md

@@ -11,8 +11,95 @@ This library is in early stages of development. It is meant to be used with Rabb
 
 ## Getting Started
 
-An example is provide in ./getting_started_main.py you can run it after starting a RabbitMQ 4.0 broker with:
+An example is provided in ./getting_started_main.py you can run it after starting a RabbitMQ 4.0 broker with:
 
 poetry run python ./examples/getting_started/main.py
 
+### Creating a connection
+
+A connection to the RabbitMQ AMQP 1.0 server can be established using the Connection object.
+
+For example:
+
+```python
+    connection = Connection("amqp://guest:guest@localhost:5672/")
+    connection.dial()
+```
+
+### Managing resources
+
+Once we have a Connection object we can get a Management object in order to submit to the server management operations
+(es: declare/delete queues and exchanges, purging queues, binding/unbinding objects ecc...)
+
+For example (this code is declaring an exchange and a queue:
+
+```python
+    management = connection.management()
+
+    print("declaring exchange and queue")
+    management.declare_exchange(ExchangeSpecification(name=exchange_name, arguments={}))
+
+    management.declare_queue(
+        QuorumQueueSpecification(name=queue_name)
+    )
+```
+
+### Publishing messages
+
+Once we have a Connection object we can get a Publisher object in order to send messages to the server (to an exchange or queue)
+
+For example:
+
+```python
+    addr_queue = AddressHelper.queue_address(queue_name)
+    publisher = connection.publisher(addr)
+
+    # publish messages
+    for i in range(messages_to_publish):
+        publisher.publish(Message(body="test"))
+
+    publisher.close()
+```
+
+### Consuming messages
+
+Once we have a Connection object we can get a Consumer object in order to consumer messages from the server (queue).
+
+Messages are received through a callback
+
+For example:
+
+Create a class which extends AMQPMessagingHandler which defines at minimum the on_consumer method, that will receive the 
+messages consumed:
+
+```python
+class MyMessageHandler(AMQPMessagingHandler):
+
+    def __init__(self):
+        super().__init__()
+        self._count = 0
+
+    def on_message(self, event: Event):
+        print("received message: " + str(event.message.body))
+
+        # accepting
+        self.delivery_context.accept(event)
+```
+
+Then from connection get a consumer object:
+
+```python
+    addr_queue = AddressHelper.queue_address(queue_name)
+    consumer = connection.consumer(addr_queue, handler=MyMessageHandler())
+
+    try:
+        consumer.run()
+    except KeyboardInterrupt:
+        pass
+```
+
+The consumer will run indefinitively waiting for messages to arrive.
+
+
+
 

examples/getting_started/main.py

@@ -20,7 +20,7 @@ def __init__(self):
         self._count = 0
 
     def on_message(self, event: Event):
-        print("received message: " + str(event.message.annotations))
+        print("received message: " + str(event.message.body))
 
         # accepting
         self.delivery_context.accept(event)

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "rabbitmq-amqp-python-client"
-version = "0.1.0"
+version = "0.1.0-alpha.0"
 description = "Python RabbitMQ client for AMQP 1.0 protocol"
 authors = ["RabbitMQ team"]
 license = "Apache-2.0 license"

rabbitmq_amqp_python_client/consumer.py

@@ -40,15 +40,18 @@ def close(self) -> None:
             self._receiver.close()
 
     def run(self) -> None:
+        logger.debug("Running the consumer: starting to consume")
         if self._receiver is not None:
             self._receiver.container.run()
 
     def stop(self) -> None:
+        logger.debug("Stopping the consumer: starting to consume")
         if self._receiver is not None:
             self._receiver.container.stop_events()
             self._receiver.container.stop()
 
     def _create_receiver(self, addr: str) -> BlockingReceiver:
+        logger.debug("Creating the receiver")
         return self._conn.create_receiver(
             addr, options=ReceiverOptionUnsettled(addr), handler=self._handler
         )