docs: minor updates

This commit is contained in:
Ilan Steemers
2015-09-06 16:54:20 +02:00
parent 87c3b7c9ce
commit 73d15c3608
4 changed files with 22 additions and 21 deletions
+8 -2
View File
@@ -34,6 +34,13 @@ Requirements
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
~~~~~~~~~~~~
@@ -54,8 +61,7 @@ Installation
$ python manage.py migrate
- Make sure you have a `Redis <http://redis.io/>`__ server running
somewhere or configure one of the other `brokers <https://django-q.readthedocs.org/en/latest/brokers.html>`__.
- Choose a `broker <https://django-q.readthedocs.org/en/latest/brokers.html>`__ and install the appropriate client library.
Read the full documentation at `https://django-q.readthedocs.org <https://django-q.readthedocs.org>`__
+1 -1
View File
@@ -74,7 +74,7 @@ class Conf(object):
TIMEOUT = conf.get('timeout', None)
# 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)
# The Django Admin label for this app
+8 -12
View File
@@ -2,24 +2,21 @@ Brokers
=======
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.
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.
Currently we only support `Redis <http://redis.io/>`__ and `Disque <https://github.com/antirez/disque>`__, but support for other brokers is being worked on.
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
-----
The default broker for Django Q clusters is `Redis <http://redis.io/>`__.
The default broker for Django Q clusters.
* Atomic
* 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
Can be configured with :ref:`redis_configuration` configuration settings or :ref:`django_redis`.
* Requires `Redis-py <https://github.com/andymccurdy/redis-py>`__ client library: ``pip install redis``
* Can use existing :ref:`django_redis` connections.
* Configure with :ref:`redis_configuration`-py compatible configuration
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
* Compatible with `Tynd <https://disque.tynd.co/>`__ Disque addon on `Heroku <https://heroku.com>`__
* Still considered Alpha software
* Requires `Redis-py <https://github.com/andymccurdy/redis-py>`__
See the :ref:`disque_configuration` configuration section for more info.
* Requires `Redis-py <https://github.com/andymccurdy/redis-py>`__ client library: ``pip install redis``
* See the :ref:`disque_configuration` configuration section for more info.
Reference
---------
+5 -6
View File
@@ -18,8 +18,7 @@ Installation
$ python manage.py migrate
- Make sure you have a `Redis <http://redis.io/>`__ server running
somewhere and know how to connect to it or configure one of the alternative :doc:`brokers`.
- Choose a :doc:`broker<brokers>` and install the appropriate client library.
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.
- `Redis-py <https://github.com/andymccurdy/redis-py>`__
Andy McCurdy's excellent Redis python client.
- `Arrow <https://github.com/crsmithdev/arrow>`__
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
~~~~~~~~
- `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 <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::