RabbitMQ Pika Flask

RabbitMQs pika library adapter for Flask. It's developed with the goal to make it easier to integrate the recommended RabbitMQ library with Flask.

For now our attention is focused on the topic exchange type.

Installing

Install and update using pip:

    pip install rabbitmq-pika-flask

Set the following environment variables or set them in your Flask app config:

• MQ_EXCHANGE=Your exchange name
• MQ_URL=Your MQ URL following this format

Development mode

• Set the FLASK_ENV environment variable or the ENV config key of your Flask app to development (Flask < v2.0)
• Set the FLASK_DEBUG environment variable or the DEBUG config key of your Flask app to True (Flask >= v2.0)
• Or pass 'development=True' to init() or init_app()

Basic Example

  from flask import Flask
  from rabbitmq_pika_flask import RabbitMQ

  # init app
  app = Flask(__name__)

  # init rabbit mq
  rabbit = RabbitMQ(app, 'example')

  # send message
  @app.route('ping', methods=['GET'])
  def ping():
    rabbit.send(body='ping', routing_key='ping.message')
    return 'pong'

  # listen to messages
  @rabbit.queue(routing_key='ping.message')
  def ping_event(routing_key, body):
    app.logger.info('Message received:')
    app.logger.info('\tKey: {}'.format(routing_key))
    app.logger.info('\tBody: {}'.format(body))

Check examples in the examples folder

Contributing

Still learning how to make a good open source project. Any ideas would be great. But feel free to open an issue or pull request if you have any problems or ideas.

Author

Aylton Almeida