mirror of
https://github.com/django-q2/django-q2.git
synced 2026-10-05 21:38:12 +08:00
docs: minor updates
This commit is contained in:
+8
-2
@@ -34,6 +34,13 @@ Requirements
|
|||||||
|
|
||||||
Tested with: Python 2.7 & 3.4. Django 1.7.10 & 1.8.4
|
Tested with: Python 2.7 & 3.4. Django 1.7.10 & 1.8.4
|
||||||
|
|
||||||
|
Brokers
|
||||||
|
~~~~~~~
|
||||||
|
- `Redis <http://redis.io/>`__
|
||||||
|
- `Disque <https://github.com/antirez/disque>`__
|
||||||
|
- `Amazon SQS <https://aws.amazon.com/sqs/>`__ TBA
|
||||||
|
- `IronMQ <http://www.iron.io/mq/>`__ TBA
|
||||||
|
|
||||||
|
|
||||||
Installation
|
Installation
|
||||||
~~~~~~~~~~~~
|
~~~~~~~~~~~~
|
||||||
@@ -54,8 +61,7 @@ Installation
|
|||||||
|
|
||||||
$ python manage.py migrate
|
$ python manage.py migrate
|
||||||
|
|
||||||
- Make sure you have a `Redis <http://redis.io/>`__ server running
|
- Choose a `broker <https://django-q.readthedocs.org/en/latest/brokers.html>`__ and install the appropriate client library.
|
||||||
somewhere or configure one of the other `brokers <https://django-q.readthedocs.org/en/latest/brokers.html>`__.
|
|
||||||
|
|
||||||
Read the full documentation at `https://django-q.readthedocs.org <https://django-q.readthedocs.org>`__
|
Read the full documentation at `https://django-q.readthedocs.org <https://django-q.readthedocs.org>`__
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -74,7 +74,7 @@ class Conf(object):
|
|||||||
TIMEOUT = conf.get('timeout', None)
|
TIMEOUT = conf.get('timeout', None)
|
||||||
|
|
||||||
# Number of seconds to wait for acknowledgement before retrying a task
|
# Number of seconds to wait for acknowledgement before retrying a task
|
||||||
# Only works with brokers that guarantee delivery. Defaults to 0. Meaning no retries.
|
# Only works with brokers that guarantee delivery. Defaults to 60 seconds.
|
||||||
RETRY = conf.get('retry', 60)
|
RETRY = conf.get('retry', 60)
|
||||||
|
|
||||||
# The Django Admin label for this app
|
# The Django Admin label for this app
|
||||||
|
|||||||
+8
-12
@@ -2,24 +2,21 @@ Brokers
|
|||||||
=======
|
=======
|
||||||
|
|
||||||
The broker sits between your Django instances and your Django Q cluster instances, accepting and delivering task packages.
|
The broker sits between your Django instances and your Django Q cluster instances, accepting and delivering task packages.
|
||||||
Currently we only support Redis and Disque, but support for other brokers is being worked on.
|
Currently we only support `Redis <http://redis.io/>`__ and `Disque <https://github.com/antirez/disque>`__, but support for other brokers is being worked on.
|
||||||
Even though `Disque <https://github.com/antirez/disque>`__ is still considered to be in alpha, it's been gathering a lot of support and test results are positive.
|
|
||||||
|
|
||||||
Clients for `Amazon SQS <https://aws.amazon.com/sqs/>`__ and `IronMQ <http://www.iron.io/mq/>`__ are being tested.
|
Clients for `Amazon SQS <https://aws.amazon.com/sqs/>`__ and `IronMQ <http://www.iron.io/mq/>`__ are TBA.
|
||||||
|
|
||||||
|
|
||||||
Redis
|
Redis
|
||||||
-----
|
-----
|
||||||
The default broker for Django Q clusters is `Redis <http://redis.io/>`__.
|
The default broker for Django Q clusters.
|
||||||
|
|
||||||
* Atomic
|
* Atomic
|
||||||
* Does not need separate cache framework for monitoring
|
* Does not need separate cache framework for monitoring
|
||||||
* Can use existing `Django-Redis <https://github.com/niwinz/django-redis>`__ connections through the :ref:`django_redis` setting
|
|
||||||
* Requires `Redis-py <https://github.com/andymccurdy/redis-py>`__
|
|
||||||
* Does not support receipts
|
* Does not support receipts
|
||||||
|
* Requires `Redis-py <https://github.com/andymccurdy/redis-py>`__ client library: ``pip install redis``
|
||||||
Can be configured with :ref:`redis_configuration` configuration settings or :ref:`django_redis`.
|
* Can use existing :ref:`django_redis` connections.
|
||||||
|
* Configure with :ref:`redis_configuration`-py compatible configuration
|
||||||
|
|
||||||
Disque
|
Disque
|
||||||
------
|
------
|
||||||
@@ -31,9 +28,8 @@ You can control the amount of time Disque should wait for completion of a task b
|
|||||||
* Needs Django's `Cache framework <https://docs.djangoproject.com/en/1.8/topics/cache/#setting-up-the-cache>`__ configured for monitoring
|
* Needs Django's `Cache framework <https://docs.djangoproject.com/en/1.8/topics/cache/#setting-up-the-cache>`__ configured for monitoring
|
||||||
* Compatible with `Tynd <https://disque.tynd.co/>`__ Disque addon on `Heroku <https://heroku.com>`__
|
* Compatible with `Tynd <https://disque.tynd.co/>`__ Disque addon on `Heroku <https://heroku.com>`__
|
||||||
* Still considered Alpha software
|
* Still considered Alpha software
|
||||||
* Requires `Redis-py <https://github.com/andymccurdy/redis-py>`__
|
* Requires `Redis-py <https://github.com/andymccurdy/redis-py>`__ client library: ``pip install redis``
|
||||||
|
* See the :ref:`disque_configuration` configuration section for more info.
|
||||||
See the :ref:`disque_configuration` configuration section for more info.
|
|
||||||
|
|
||||||
Reference
|
Reference
|
||||||
---------
|
---------
|
||||||
|
|||||||
+5
-6
@@ -18,8 +18,7 @@ Installation
|
|||||||
|
|
||||||
$ python manage.py migrate
|
$ python manage.py migrate
|
||||||
|
|
||||||
- Make sure you have a `Redis <http://redis.io/>`__ server running
|
- Choose a :doc:`broker<brokers>` and install the appropriate client library.
|
||||||
somewhere and know how to connect to it or configure one of the alternative :doc:`brokers`.
|
|
||||||
|
|
||||||
|
|
||||||
Requirements
|
Requirements
|
||||||
@@ -36,10 +35,6 @@ Django Q is tested for Python 2.7 and 3.4
|
|||||||
|
|
||||||
Used to store args, kwargs and result objects in the database.
|
Used to store args, kwargs and result objects in the database.
|
||||||
|
|
||||||
- `Redis-py <https://github.com/andymccurdy/redis-py>`__
|
|
||||||
|
|
||||||
Andy McCurdy's excellent Redis python client.
|
|
||||||
|
|
||||||
- `Arrow <https://github.com/crsmithdev/arrow>`__
|
- `Arrow <https://github.com/crsmithdev/arrow>`__
|
||||||
|
|
||||||
The scheduler uses Chris Smith's wonderful project to determine correct dates in the future.
|
The scheduler uses Chris Smith's wonderful project to determine correct dates in the future.
|
||||||
@@ -51,6 +46,10 @@ Django Q is tested for Python 2.7 and 3.4
|
|||||||
|
|
||||||
Optional
|
Optional
|
||||||
~~~~~~~~
|
~~~~~~~~
|
||||||
|
- `Redis-py <https://github.com/andymccurdy/redis-py>`__
|
||||||
|
|
||||||
|
Andy McCurdy's excellent Redis python client is used to interface with both the Redis and Disque brokers.
|
||||||
|
|
||||||
.. _psutil:
|
.. _psutil:
|
||||||
|
|
||||||
- `Psutil <https://github.com/giampaolo/psutil>`__ python system and process utilities module by Giampaolo Rodola', is an optional requirement and adds cpu affinity settings to the cluster::
|
- `Psutil <https://github.com/giampaolo/psutil>`__ python system and process utilities module by Giampaolo Rodola', is an optional requirement and adds cpu affinity settings to the cluster::
|
||||||
|
|||||||
Reference in New Issue
Block a user