A Django app to register Django Q tasks.
Project description
django-q-registry
A Django app that provides a registry for Django Q2 periodic tasks.
Requirements
- Python 3.8, 3.9, 3.10, 3.11, or 3.12
- Django 3.2, 4.2, or 5.0
- Django Q2 1.4.3 or later
- This package has only been tested with the Django ORM broker. The other's may work, but they have not been tested.
Getting Started
- Install the package from PyPI:
python -m pip install django-q-registry
- Add the app to your Django project's
INSTALLED_APPS
:
INSTALLED_APPS = [
...,
"django_q_registry",
...,
]
Usage
Registering Periodic Tasks
There are three supported ways to register periodic tasks:
- In a
tasks.py
file in a Django app, using the@register_task
decorator:
# tasks.py
from django.core.mail import send_mail
from django_q.models import Schedule
from django_q_registry import register_task
@register_task(
name="Send periodic test email",
schedule_type=Schedule.CRON,
# https://crontab.guru/#*/5_*_*_*_*
cron="*/5 * * * *",
)
def send_test_email():
send_mail(
subject="Test email",
message="This is a test email.",
from_email="noreply@example.com",
recipient_list=["johndoe@example.com"],
)
- In a
tasks.py
file in a Django app, using theregistry.register
function directly:
# tasks.py
from django.core.mail import send_mail
from django_q.models import Schedule
from django_q_registry.registry import registry
registry.register(
send_mail,
name="Send periodic test email",
kwargs={
"subject": "Test email",
"message": "This is a test email.",
"from_email": "noreply@example.com",
"recipient_list": ["janedoe@example.com"],
},
schedule_type=Schedule.CRON,
# https://crontab.guru/#*/5_*_*_*_*
cron="*/5 * * * *",
)
- In a Django project's
settings.py
file, using theQ_REGISTRY["TASKS"]
setting:
# settings.py
from django_q.models import Schedule
Q_REGISTRY = {
"TASKS": [
{
"name": "Send periodic test email",
"func": "django.core.mail.send_mail",
"kwargs": {
"subject": "Test email",
"message": "This is a test email.",
"from_email": "noreply@example.com",
"recipient_list": ["janedoe@example.com"],
},
"schedule_type": Schedule.CRON,
# https://crontab.guru/#*/5_*_*_*_*
"cron": "*/5 * * * *",
},
],
}
Setting up Periodic Tasks in Production
At some point in your project's deployment process, run the setup_periodic_tasks
management command:
python manage.py migrate
python manage.py setup_periodic_tasks
This command automatically registers periodic tasks from tasks.py
files in Django apps, and from the Q_REGISTRY["TASKS"]
setting. It also cleans up any periodic tasks that are no longer registered.
License
django-q-registry
is licensed under the MIT license. See the LICENSE
file for more information.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
django_q_registry-0.1.0.tar.gz
(14.5 kB
view hashes)
Built Distribution
Close
Hashes for django_q_registry-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3d15973da36c0e2843f63d7d514919fabeee33d3a05c7a8e6fc2bd524915c057 |
|
MD5 | 7f70123ead2eeca3d58126d078046f56 |
|
BLAKE2b-256 | 91190d1eca7874ae195b90f96dab36770be9e986c6e9a3c0f60ca046879418d2 |