Metadata-Version: 1.0
Name: Kuyruk
Version: 0.19.2
Summary: A distributed task runner
Home-page: http://github.com/cenkalti/kuyruk
Author: Cenk Altı
Author-email: cenkalti@gmail.com
License: UNKNOWN
Description: Kuyruk
        ======
        
        .. image:: https://travis-ci.org/cenkalti/kuyruk.png
           :target: https://travis-ci.org/cenkalti/kuyruk
        
        .. image:: https://coveralls.io/repos/cenkalti/kuyruk/badge.png?branch=master
           :target: https://coveralls.io/r/cenkalti/kuyruk?branch=master
        
        Kuyruk is a simple and easy way of distributing tasks to run on servers.
        
        It uses `RabbitMQ <http://www.rabbitmq.com>`_ as message broker and depends on
        `Pika <http://pika.readthedocs.org/en/latest/>`_
        which is a pure-Python RabbitMQ client library.
        
        
        How to install?
        ---------------
        
        Kuyruk is available on `PyPI <https://pypi.python.org/pypi/Kuyruk>`_.
        
        .. code-block:: bash
        
           $ pip install kuyruk
        
        
        How to run tests?
        -----------------
        
        Normally you don't need this but it is easy.
        ``kuyruk/test`` directory contains files of both unit and integration tests.
        Make sure that RabbitMQ is running before running tests.
        Tests also run on `Travis CI <https://travis-ci.org/cenkalti/kuyruk>`_
        automatically on push.
        
        .. code-block:: bash
        
           $ git clone git://github.com/cenkalti/kuyruk.git
           $ cd kuyruk
           $ pip install -r kuyruk/test/requirements.txt
           $ nosetests
        
        
        How to define tasks?
        --------------------
        
        Instantiate a ``Kuyruk`` object somewhere.
        Then just put a ``kuyruk.task`` decorator on top of your function that you
        want to run in background. After decorating, when you call the function it
        will send the task to default queue instead of running the function.
        Since Kuyruk does not support a result backend yet you should not be
        using the return value of the function.
        
        .. code-block:: python
        
           from kuyruk import Kuyruk
        
           kuyruk = Kuyruk()
        
           @kuyruk.task
           def echo(message):
               print message
        
           # This will send a message to queue
           echo('Hello, Kuyruk.')
        
        
        How to run the worker?
        ----------------------
        
        Running the worker command with no parameters is enough for
        processing the tasks in the default queue.
        
        .. code-block:: bash
        
           $ kuyruk worker
        
        
        Where is the documentation?
        ---------------------------
        Here it is: http://kuyruk.readthedocs.org
        
Keywords: rabbitmq distributed task queue
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Software Development :: Object Brokering
Classifier: Topic :: System :: Distributed Computing
