paper-rq 0.6.1

An administrative interface for managing RQ tasks in Paper Admin

paper-rq

An administrative interface for managing RQ tasks in Paper Admin.

⚠ Default rq.scheduler is not supported! Use rq-scheduler instead.

Compatibility

• paper-admin >= 3.0
• django-rq >= 2.4
• python >= 3.6

Installation

Install the latest release with pip:

pip install paper-rq

Add paper_rq to your INSTALLED_APPS in django's settings.py:

INSTALLED_APPS = (
    # ...
    "paper_rq",
)

Add paper_rq to your PAPER_MENU:

PAPER_MENU = [
    # ...
    dict(
        app="paper_rq",
        icon="fa fa-fw fa-lg fa-clock-o",
    ),
    # ...
]

Result

RQ Scheduler

First you need to make sure you have the rq-scheduler library installed:

pip install rq-scheduler

If you need to run multiple isolated schedulers, you can use the class paper_rq.scheduler.Scheduler. It reads the Redis keys from the RQ setting:

# settings.py

RQ = {
    "SCHEDULER_CLASS": "paper_rq.scheduler.Scheduler",
    "SCHEDULER_LOCK_KEY": "rq:scheduler-1:scheduler_lock",
    "SCHEDULER_JOBS_KEY": "rq:scheduler-1:scheduled_jobs",
}