Metadata-Version: 2.1
Name: django_periodiq
Version: 0.1.0
Summary: A Django app for Periodiq.
Home-page: https://github.com/q0w/django-periodiq/
Author: q0w
License: MIT
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.2
Classifier: Framework :: Django :: 3.2
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.6.1
Description-Content-Type: text/markdown
License-File: LICENSE

# django_periodiq
**django_periodiq** is a Django app that integrates with [Periodiq][periodiq].


## Requirements
* [Django][django] 2.2+
* [Periodiq][periodiq] 0.12.1+


## Installation
    pip install django-periodiq
Add `django_periodiq` to installed apps *before* any of your custom
apps and *after* `django_dramatiq`:
``` python
import os

INSTALLED_APPS = [
    "django_dramatiq",
    "django_periodiq",
    "myprojectapp1",
    "myprojectapp2",
    # etc...
]
```
Add `periodiq.PeriodiqMiddleware` to `DRAMATIQ_BROKER` middlewares:
``` python
DRAMATIQ_BROKER = {
    "MIDDLEWARE": [
            ...
        "periodiq.PeriodiqMiddleware",
    ],
}
```
Run periodiq:
```shell
python manage.py runperiodiq
```

[periodiq]: https://gitlab.com/bersace/periodiq
[django]: http://djangoproject.com/


