fouriermourier/py_rmq_client repository overview

⁠Flexible RabbitMQ Client written in Python

Publish and consume messages with customizable flow. Ideal for testing or experimenting with RabbitMQ configurations. Configurable via CLI arguments and environment variables.

Source code is available on GitHub⁠.

⁠Usage

⁠CLI Arguments

When running the RabbitMQ client, you can specify options through CLI arguments to customize its behavior. Here's a summary of available CLI options:

⁠Environment Variables

Alternatively, you can configure RabbitMQ using environment variables. Here's the list of supported variables and their default values:

⁠Running with Docker

In the docker-compose.yml, you can customize the entrypoint to control how the client runs. Below are two examples to configure the entrypoint.

1. Publisher mode:

   services:
     rmq:
       image: fouriermourier/py_rmq_client:latest
       ## if you need to build from scratch: 
       # build:
       #   context: ./
       #   dockerfile: Dockerfile
       env_file:
         - .env
       entrypoint:
         - rmq
         - --mode=publisher
         - --message="hello there"
         - --delay=0.6
         - --count=10
         - --log-level=warning
         - --verbose=True
   

   Copy

2. Consumer mode:

   services:
     rmq:
       image: fouriermourier/py_rmq_client:latest
       ## if you need to build from scratch:
       # build:
       #   context: ./
       #   dockerfile: Dockerfile
       env_file:
         - .env
       entrypoint:
         - rmq
         - --mode=consumer
         - --delay=0.3
         - --log-level=warning
         - --verbose=True
   

   Copy

⁠Examples

⁠Running the publisher

You can run the publisher mode with a custom message, delay, and count of messages to send:

docker-compose -f docker-compose.yaml run consumer --mode=publisher --message="hello world" --delay=1 --count=5 --log-level=warning

The client will publish "hello world" 5 times with a 1-second delay between each message.

⁠Running the consumer

To run the consumer:

docker-compose -f docker-compose.yaml run consumer --mode=publisher --message="hello world" --delay=1 --count=5 --log-level=warning

The consumer will process messages with a 1.5-second delay between each one.

⁠RabbitMQ client configuration

By default, the client uses the values below:

• port: 5672
• exchange name: ""
• exchange type: direct
• host: localhost
• username: guest
• password: guest
• queue name: my_queue
• ssl enabled: False
• ssl CA certificates: None
• routing key: value of RABBITMQ_QUEUE_NAME if specified, otherwise - value of the my_queue parameter

Feel free to adjust .env file or ConfigMap in case of running in k8s to your specific credentials.