fork/django-q2
1
0
Fork 0
mirror of https://github.com/django-q2/django-q2.git synced 2026-10-09 04:38:11 +08:00
Code Issues Packages Projects Releases Wiki Activity

fixing README some typos

Browse Source
This commit is contained in:
Ilan Steemers
2015-06-24 22:48:35 +02:00
parent 06791005c9
commit a44ad57b7a
2 changed files with 21 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.rst
+13 -13
View File
@@ -4,12 +4,9 @@ Django Q
A multiprocessing task queue application for Django
---------------------------------------------------
Status
~~~~~~
In Alpha and Python 3 only (for now). Everything should work, but the
basic structure can still change. Main focus will be put on creating
tests now.
|image0| ### Status In Alpha. Everything should work, but the basic
structure can still change. Main focus is on creating more tests, better
coverage and stability.
Architecture
~~~~~~~~~~~~
@@ -21,7 +18,7 @@ Architecture
Usage
~~~~~
Schedule the asynchronous exectution of a function by calling ``async``
Schedule the asynchronous execution of a function by calling ``async``
from within your Django project.
.. code:: python
@@ -57,8 +54,8 @@ Admin integration
~~~~~~~~~~~~~~~~~
Django Q registers itself with the admin page to show failed and
succesful tasks. From there task results can be read or deleted. If
neccesary, failed tasks can be reintroduced to the queue.
successful tasks. From there task results can be read or deleted. If
necessary, failed tasks can be reintroduced to the queue.
Signed Tasks
~~~~~~~~~~~~
@@ -74,7 +71,7 @@ Optionally, packages can be compressed before transport by setting
Pusher
~~~~~~
The pusher process continously checks the Redis list for new task
The pusher process continuously checks the Redis list for new task
packages and pushes them on the Task Queue.
Worker
@@ -86,15 +83,15 @@ any of these steps, the package is then pushed onto the Result Queue.
By default Django Q spawns a worker for each detected CPU on the host
system. This can be overridden by setting ``Q_WORKERS = n``. With *n*
being the numbe of desired worker processes.
being the number of desired worker processes.
Monitor
~~~~~~~
The result monitor checks the Result Queue for processed packages and
saves both failed and succesful packages to the Django database.
saves both failed and successful packages to the Django database.
By default only the last 100 succesful packages are kept in the
By default only the last 100 successful packages are kept in the
database. This can be increased or decreased at will by settings
``Q_SAVE_LIMIT = n``. With *n* being the desired number of records. Set
``Q_SAVE_LIMIT = 0`` to save all results to the database. Failed
@@ -119,3 +116,6 @@ Todo
~~~~
I'll add to this README while I'm developing the various parts.
.. |image0| image:: https://travis-ci.org/Koed00/django-q.svg?branch=master
:target: https://travis-ci.org/Koed00/django-q