rq-scheduler 0.1.1

Provides job scheduling capabilities to RQ (Redis Queue)

RQ Scheduler

RQ Scheduler is a small package that adds job scheduling capabilities to RQ, a Redis based Python queuing library.

Requirements

• RQ

Installation

You can install RQ Scheduler via pip:

pip install rq-scheduler

Usage

Schedule a job involves doing two different things: # Putting a job in the scheduler # Running a scheduler that will move scheduled jobs into queues when the time comes

Scheduling a Job

Here’s how to put a job in the scheduler:

from rq import use_connection
from rq_scheduler import Scheduler
from datetime import datetime

use_connection() # Use RQ's default Redis connection
scheduler = Scheduler() # Get a scheduler for the "default" queue

# Puts a job into the scheduler. The API is similar
# to rq except that it takes a datetime object as first argument
scheduler.schedule(datetime(2020, 01, 01, 1, 1), func)
scheduler.schedule(datetime(2025, 10, 10, 3, 4), func, foo, bar=baz)

You can also explicitly pass in connection to use a different Redis server:

from redis import Redis
from rq_scheduler import Scheduler
from datetime import datetime

scheduler = Scheduler('default', connection=Redis())
scheduler.schedule(datetime(2020, 01, 01, 1, 1), func)

Running the scheduler

RQ Scheduler comes with a script rqscheduler that runs a scheduler process that polls Redis once every minute and move scheduled jobs to the relevant queues when they need to be executed:

# This runs a scheduler process using the default Redis connection
rqscheduler

If you want to use a different Redis server you could also do:

rqscheduler --host localhost --port 6379 --db 0

The script accepts these arguments:

• -H or --host: Redis server to connect to

• -p or --port: port to connect to

• -d or --db: Redis db to use

• -P or --password: password to connect to Redis