Metadata-Version: 2.1
Name: django-redbeat
Version: 0.3
Summary: A Django app to add dynamic celery redbeat periodic tasks
Home-page: https://github.com/parad0x96/django-redbeat
Author: Karim Bourahla
Author-email: k.bourahla0x@gmail.com
License: MIT license
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 3.2
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Requires-Python: >=3.6
License-File: LICENSE

==============
Django RedBeat
==============

django-redbeat is an app based on celery-redbeat with model based celery periodic tasks.

Quick start
-----------

1. Add "django_redbeat" to your INSTALLED_APPS setting like this::

    INSTALLED_APPS = [
        ...
        'django_redbeat',
    ]


2. Run ``python manage.py migrate`` to create the PeriodicTaskeEntry model.

3. Start the development server and visit http://127.0.0.1:8000/admin/
   to create a periodic task (you'll need the Admin app enabled).

4. Visit http://127.0.0.1:8000/admin/django_redbeat/periodictasksentry/ to add periodic task.
5. Sample code to use::

     from django_redbeat import PeriodicTaskEntry

     task = PeriodicTasksEntry.objects.create(
        name="The verbose name of the task",
        task="yourapp.tasks.task_name",
        args=[arg1, arg2,],
        schedule=10# the schedule in seconds
     )
