Skip to content

Commit

Permalink
correct beginning of docs
Browse files Browse the repository at this point in the history
  • Loading branch information
samuelcolvin committed Sep 15, 2016
1 parent ba85f53 commit c751e51
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,13 @@ Current Version: |version|

Job queues and RPC in python with asyncio, redis and msgpack.

arq was conceived as a simplified and more performant success to `rq`_
*arq* was conceived as a simple, modern and performant successor to `rq`_.

Why use *arq*?

**non-blocking**
arq is built using python's `asyncio`_ allowing
non-blocking job enqueuing and execution. Multiple jobs (potentially hundres) can be run simultaneously
*arq* is built using python 3's `asyncio`_ allowing
non-blocking job enqueuing and execution. Multiple jobs (potentially hundreds) can be run simultaneously
using a pool of *asyncio* ``Tasks``.

**pre-forked**
Expand All @@ -23,18 +25,18 @@ arq was conceived as a simplified and more performant success to `rq`_

**fast**
Asyncio, pre-forking and use of `msgpack`_ for job encoding make
arq around 7x faster (see `benchmarks`_) than
*arq* around 7x faster (see `benchmarks`_) than
*rq* for short jobs with no io. With io that might increase to around 40x
faster. (TODO)

**elegant**
arq uses a novel approach to variable scope with the ``@concurrent`` decorator being applied to bound
*arq* uses a novel approach to variable scope with the ``@concurrent`` decorator being applied to bound
methods of ``Actor`` classes which hold the connection pool. This works well with `aiohttp`_, allows for easier
testing and avoids extended head scratching over how variables like connections are defined (is this attached
to the request? or thread local? or truly global? where am I, hell, what does global even mean?).

**small**
and easy to reason with - currently arq is only about 500 lines, that won't change significantly.
and easy to reason with - currently *arq* is only about 500 lines, that won't change significantly.

Dependencies
------------
Expand Down

0 comments on commit c751e51

Please sign in to comment.