rabbit-manager 0.2.0

Lightweight RabbitMQ manager built on top of pika

Rabbit Manager

Rabbit Manager is a simple, Python-based utility for managing RabbitMQ message queues. It provides an easy-to-use interface for sending, receiving, and processing messages from RabbitMQ queues, with built-in support for automatic reconnections and error handling.

Key Features:

• Send messages to RabbitMQ queues.
• Receive messages from queues with automatic acknowledgement.
• Automatically reconnect on connection loss.
• Easily handle multiple messages and batch operations.
• Supports queue size inspection.
• Iterable interface for message consumption.

This tool is ideal for developers looking to integrate RabbitMQ into their Python applications with minimal overhead.

Requirements

• Python >= 3.10
• Pika (installed via project dependencies)

Install from PyPI (package name: rabbit-manager):

uv add rabbit-manager

or

pip install rabbit-manager

Install for local development with uv (recommended):

uv sync --dev

Alternatively, using pip for editable dev install:

pip install -e ".[dev]"

Quick Start (RabbitManager)

from rabbit_manager import RabbitManager

# Create a manager for a RabbitMQ queue
manager = RabbitManager(
    "my_queue",              # queue_name (positional argument, required)
    username="guest",        # keyword-only (required)
    password="guest",        # keyword-only (required)
    host="localhost",        # optional, defaults to "localhost"
    port=5672,               # optional, defaults to 5672
    queue_durable=True,      # optional, defaults to True
    message_ttl_minutes=10,  # optional, defaults to 0
    confirm_delivery=True,   # optional, defaults to True
    max_priority=10,         # optional, defaults to 0
)

# Use as a context manager to auto-open/close connection
with manager as q:
    # Add a message
    delivered = q.add("hello world")
    print("Delivered:", delivered)

    # Add a message with priority (requires max_priority > 0)
    delivered_priority = q.add("priority message", priority=5)
    print("Delivered with priority:", delivered_priority)

    # Check queue size
    print("Queue size:", q.size())

    # Get one message (non-blocking)
    msg = q.get()
    print("Got:", msg)

    # Block and wait for a message (with optional timeout)
    msg2 = q.consume(timeout=5)
    print("Consumed:", msg2)

# Manual open/close usage
manager.open()
manager.add("another message")
print("Size:", manager.size())
print("Get:", manager.get())
manager.close()

Notes:

• The example assumes a local RabbitMQ instance on localhost:5672 with guest/guest credentials.
• When confirm_delivery=True, publishing raises on delivery issues (e.g., unroutable or NACK).
• message_ttl_minutes>0 sets per-queue message TTL.
• Message priority works only when max_priority>0, and can be set per message via add(..., priority=...).

Testing

Before running tests, activate the virtual environment:

source .venv/bin/activate

Run the test suite:

pytest test.py -v

See more options in TEST_README.md.