toro 0.1

====
toro
====

.. image:: https://raw.github.com/ajdavis/toro/master/doc/images/toro.png

:Info: Synchronization primitives for Tornado coroutines.
:Author: A. Jesse Jiryu Davis

Documentation: http://toro.readthedocs.org/

About
=====
A set of locking and synchronizing primitives analogous to those in Python's
`threading module`_ or Gevent's `coros`_, for use with Tornado's `gen.engine`_.

.. _threading module: http://docs.python.org/library/threading.html

.. _coros: http://www.gevent.org/gevent.coros.html

.. _gen.engine: http://www.tornadoweb.org/documentation/gen.html

Dependencies
============
Tornado_ >= version 2.3.

.. _Tornado: http://www.tornadoweb.org/

Examples
========
Here's a basic example (for more see the *examples* section of the docs):

.. todo:: maybe the producer-consumer example gets included here, whole

Documentation
=============

You will need sphinx_ installed to generate the
documentation. Documentation can be generated by running **python
setup.py doc**. Generated documentation can be found in the
*doc/build/html/* directory.

.. todo:: update, and include GraphViz instructions

.. _sphinx: http://sphinx.pocoo.org/


Testing
=======

``pip install nose`` and run ``nosetests`` in the root directory. Toro boasts
100% code coverage, including branch-coverage!