A database backed job scheduler for Django RQ with Django
Project description
Django RQ Scheduler
Notice: Starting v2023.1, requirement for rq_scheduler was removed and instead one of the django-rq workers should run with
--with-scheduler
parameter as mentioned here.
A database backed job scheduler for Django RQ. Based on original django-rq-scheduler - Now supports Django 4.0.
This allows remembering scheduled jobs, their parameters, etc.
Installation
-
Use pip to install:
pip install django-rq-scheduler
-
In
settings.py
, adddjango_rq
andscheduler
toINSTALLED_APPS
:INSTALLED_APPS = [ ... 'django_rq', 'scheduler', ... ]
-
Configure Django RQ. See https://github.com/ui/django-rq#installation
Add at least one Redis Queue to your
settings.py
:RQ_QUEUES = { 'default': { 'HOST': 'localhost', 'PORT': 6379, 'DB': 0, 'PASSWORD': 'some-password', 'DEFAULT_TIMEOUT': 360, }, }
-
Run migrations.
./manage.py migrate
Usage
Making a method in your code a schedulable job to be run by a worker.
See http://python-rq.org/docs/jobs/ or https://github.com/ui/django-rq#job-decorator
An example:
myapp.jobs.py
from django_rq import job
@job
def count():
return 1 + 1
Scheduling a Job
Scheduled Job
-
Sign in to the Django Admin site, http://localhost:8000/admin/ and locate the Django RQ Scheduler section.
-
Click on the Add link for Scheduled Job.
-
Enter a unique name for the job in the Name field.
-
In the Callable field, enter a Python dot notation path to the method that defines the job. For the example above, that would be
myapp.jobs.count
-
Choose your Queue. Side Note: The queues listed are defined in the Django Settings.
-
Enter the time the job is to be executed in the Scheduled time field. Side Note: Enter the date via the browser's local timezone, the time will automatically convert UTC.
-
Click the Save button to schedule the job.
Repeatable Job
-
Sign in to the Django Admin site, http://localhost:8000/admin/ and locate the Django RQ Scheduler section.
-
Click on the Add link for Repeatable Job
-
Enter a unique name for the job in the Name field.
-
In the Callable field, enter a Python dot notation path to the method that defines the job. For the example above, that would be
myapp.jobs.count
-
Choose your Queue. Side Note: The queues listed are defined in the Django Settings.
-
Enter the time the first job is to be executed in the Scheduled time field. Side Note: Enter the date via the browser's local timezone, the time will automatically convert UTC.
-
Enter an Interval, and choose the Interval unit. This will calculate the time before the function is called again.
-
In the Repeat field, enter the number of time the job is to be run. Leaving the field empty, means the job will be scheduled to run forever.
-
Click the Save button to schedule the job.
Advanced usage using jobs with args
django-rq-scheduler supports
from django_rq import job
@job
def job_args_kwargs(*args, **kwargs):
func = "test_args_kwargs({})"
args_list = [repr(arg) for arg in args]
kwargs_list = [k + '=' + repr(v) for (k, v) in kwargs.items()]
return func.format(', '.join(args_list + kwargs_list))
Schedule job with custom arguments to be calculated when scheduling
-
Sign in to the Django Admin site, http://localhost:8000/admin/ and locate the Django RQ Scheduler section.
-
Click on the Add link for Scheduled Job.
-
Enter a unique name for the job in the Name field.
-
In the Callable field, enter a Python dot notation path to the method that defines the job. For the example above, that would be
myapp.jobs.job_args_kwargs
-
Choose your Queue. Side Note: The queues listed are defined in the Django Settings.
-
Enter the time the job is to be executed in the Scheduled time field. Side Note: Enter the date via the browser's local timezone, the time will automatically convert UTC.
-
Click the Save button to schedule the job.
-
Add arguments to the job, pick argument type.
-
Add arguments with keys to the job, pick argument type and value.
Reporting issues or Features requests
Please report issues via GitHub Issues .
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django_rq_scheduler-2023.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9c1268a9508eefed811539e1c75cfeb5c075606d58d5e26d0bb81c2c97884046 |
|
MD5 | 13fbe4acd673c9083b60ecc05c3a67cc |
|
BLAKE2b-256 | 7d04f2807eb7557e2937fdc65e1892da93b489e5e81c972b4d1c61ee058e82f1 |
Hashes for django_rq_scheduler-2023.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a1f0da16a7a4d01fc95b9cc1d595c062e72a21aec3c1d953e895945dd234e647 |
|
MD5 | 618a8d6549b9676d9ddccb2c63917b91 |
|
BLAKE2b-256 | e41016d9f3f77527d72a6667e37f6cc314db53d56c12e1d92157884adffc68a4 |