1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
===============================================
django-celery - Celery Integration for Django
===============================================
.. image:: http://cloud.github.com/downloads/celery/celery/celery_128.png
:Version: 3.1.1
:Web: http://celeryproject.org/
:Download: http://pypi.python.org/pypi/django-celery/
:Source: http://github.com/celery/django-celery/
:Keywords: celery, task queue, job queue, asynchronous, rabbitmq, amqp, redis,
python, django, webhooks, queue, distributed
--
.. adminition:: This library is no longer necessary
Since Celery 3.1 you can now use Celery with Django directly,
so new users should not be using this library for integration.
Django-celery may still be used for the database result backend,
and the Django periodic task admin, but these are optional features.
See the new Django tutorial at:
https://docs.celeryproject.org/en/latest/django/first-steps-with-django.html
The old README follows below.
Using django-celery
===================
To enable ``django-celery`` for your project you need to add ``djcelery`` to
``INSTALLED_APPS``::
INSTALLED_APPS += ("djcelery", )
then add the following lines to your ``settings.py``::
import djcelery
djcelery.setup_loader()
Everything works the same as described in the `Celery User Manual`_, except you
need to invoke the programs through ``manage.py``:
===================================== =====================================
**Program** **Replace with**
===================================== =====================================
``celery`` ``python manage.py celery``
``celery worker`` ``python manage.py celery worker``
``celery beat`` ``python manage.py celery beat``
``celery ...`` ``python manage.py celery ...``
===================================== =====================================
The other main difference is that configuration values are stored in
your Django projects' ``settings.py`` module rather than in
``celeryconfig.py``.
If you're trying celery for the first time you should start by reading
`Getting started with django-celery`_
Special note for mod_wsgi users
-------------------------------
If you're using ``mod_wsgi`` to deploy your Django application you need to
include the following in your ``.wsgi`` module::
import djcelery
djcelery.setup_loader()
Documentation
=============
The `Celery User Manual`_ contains user guides, tutorials and an API
reference. Also the `django-celery documentation`_, contains information
about the Django integration.
.. _`django-celery documentation`: http://django-celery.readthedocs.org/
.. _`Celery User Manual`: http://docs.celeryproject.org/
.. _`Getting started with django-celery`:
http://docs.celeryproject.org/en/latest/django/first-steps-with-django.html
Installation
=============
You can install ``django-celery`` either via the Python Package Index (PyPI)
or from source.
To install using ``pip``,::
$ pip install django-celery
To install using ``easy_install``,::
$ easy_install django-celery
You will then want to create the necessary tables. If you are using south_
for schema migrations, you'll want to::
$ python manage.py migrate djcelery
For those who are not using south, a normal ``syncdb`` will work::
$ python manage.py syncdb
.. _south: http://pypi.python.org/pypi/South/
Downloading and installing from source
--------------------------------------
Download the latest version of ``django-celery`` from
http://pypi.python.org/pypi/django-celery/
You can install it by doing the following,::
$ tar xvfz django-celery-0.0.0.tar.gz
$ cd django-celery-0.0.0
# python setup.py install # as root
Using the development version
------------------------------
You can clone the git repository by doing the following::
$ git clone git://github.com/celery/django-celery.git
Getting Help
============
Mailing list
------------
For discussions about the usage, development, and future of celery,
please join the `celery-users`_ mailing list.
.. _`celery-users`: http://groups.google.com/group/celery-users/
IRC
---
Come chat with us on IRC. The **#celery** channel is located at the `Freenode`_
network.
.. _`Freenode`: http://freenode.net
Bug tracker
===========
If you have any suggestions, bug reports or annoyances please report them
to our issue tracker at http://github.com/celery/django-celery/issues/
Wiki
====
http://wiki.github.com/celery/celery/
Contributing
============
Development of ``django-celery`` happens at Github:
http://github.com/celery/django-celery
You are highly encouraged to participate in the development.
If you don't like Github (for some reason) you're welcome
to send regular patches.
License
=======
This software is licensed under the ``New BSD License``. See the ``LICENSE``
file in the top distribution directory for the full license text.
.. # vim: syntax=rst expandtab tabstop=4 shiftwidth=4 shiftround
|