pyrediq 0.2.0

Priority message queue with Redis

pyrediq

pyrediq (py-re-ddi-ck) is a Python (2.7) library providing an implementation of priority messaging queue using Redis. The message payload is serialized by MessagePack.

pyrediq is licensed under the MIT License (MIT).

Basic Usage

import redis
from pyrediq import PriorityQueue, QueueEmpty

redis_conn = redis.StrictRedis()

# create a queue
queue = PriorityQueue('myqueue', redis_conn)

# enqueue a message to the queue
queue.put({'mykey': 'myvalue'}, priority=-1)

# create a consumer
with queue.consumer() as consumer:
    try:
        msg = consumer.get(block=False)
    except QueueEmpty:
        raise

    success = do_task(msg.payload)

    # the message is either acked or rejected after task is done.
    # a rejected message can optionally be requeued
    if success:
        consumer.ack(msg)
    else:
        consumer.reject(msg, requeue=True)

To remove all message from a queue and remove the queue itself, run PriorityQueue.purge method:

queue.purge()

Installation

To install pyrediq using pip, run this command on the shell:

pip install pyrediq

To use pyrediq, Redis needs to be installed and running on the computer. For example, on a Debian box, running this command should suffice:

sudo apt-get install redis-server

Consult the official Redis distribution site for the install procedure.