mirror of https://github.com/peter4431/rq.git
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
95 lines
2.3 KiB
Markdown
95 lines
2.3 KiB
Markdown
# WARNING: DON'T USE THIS IN PRODUCTION (yet)
|
|
|
|
RQ (_Redis Queue_) is a lightweight<sup>*</sup> Python library for queueing
|
|
jobs and processing them in the background with workers. It is backed by Redis
|
|
and it is extremely simple to use.
|
|
|
|
<p style="font-size: 80%; text-align: right; font-style: italic">
|
|
<sup>*</sup> It is under 20 kB in size and under 500 lines of code.</p>
|
|
|
|
|
|
## Getting started
|
|
|
|
First, run a Redis server, of course:
|
|
|
|
{% highlight console %}
|
|
$ redis-server
|
|
{% endhighlight %}
|
|
|
|
To put jobs on queues, you don't have to do anything special, just define
|
|
your typically lengthy or blocking function:
|
|
|
|
{% highlight python %}
|
|
import urllib2
|
|
|
|
def count_words_at_url(url):
|
|
f = urllib2.urlopen(url)
|
|
count = 0
|
|
while True:
|
|
line = f.readline()
|
|
if not line:
|
|
break
|
|
count += len(line.split())
|
|
return count
|
|
{% endhighlight %}
|
|
|
|
Then, create a RQ queue:
|
|
|
|
{% highlight python %}
|
|
import rq import *
|
|
use_redis()
|
|
q = Queue()
|
|
{% endhighlight %}
|
|
|
|
And enqueue the function call:
|
|
|
|
{% highlight python %}
|
|
from my_module import count_words_at_url
|
|
result = q.enqueue(
|
|
count_words_at_url, 'http://nvie.com')
|
|
{% endhighlight %}
|
|
|
|
For a more complete example, refer to the [docs][d]. But this is the essence.
|
|
|
|
[d]: {{site.baseurl}}docs/
|
|
|
|
|
|
### The worker
|
|
|
|
To start executing enqueued function calls in the background, start a worker
|
|
from your project's directory:
|
|
|
|
{% highlight console %}
|
|
$ rqworker
|
|
*** Listening for work on default
|
|
Got count_words_at_url('http://nvie.com') from default
|
|
Job result = 818
|
|
*** Listening for work on default
|
|
{% endhighlight %}
|
|
|
|
That's about it.
|
|
|
|
|
|
## Installation
|
|
|
|
Simply use the following command to install the latest released version:
|
|
|
|
pip install rq
|
|
|
|
If you want the cutting edge version (that may well be broken), use this:
|
|
|
|
pip install -e git+git@github.com:nvie/rq.git@master#egg=rq
|
|
|
|
|
|
## Project history
|
|
|
|
This project has been inspired by the good parts of [Celery][1], [Resque][2]
|
|
and [this snippet][3], and has been created as a lightweight alternative to the
|
|
heaviness of Celery or other AMQP-based queueing implementations.
|
|
|
|
[m]: http://pypi.python.org/pypi/mailer
|
|
[p]: http://docs.python.org/library/pickle.html
|
|
[1]: http://www.celeryproject.org/
|
|
[2]: https://github.com/defunkt/resque
|
|
[3]: http://flask.pocoo.org/snippets/73/
|