Metadata-Version: 1.1
Name: cadasta-workertoolbox
Version: 0.1.5
Summary: Cadasta Worker Toolbox
Home-page: https://github.com/Cadasta/cadasta-workertoolbox
Author: Anthony Lukach
Author-email: alukach@cadasta.org
License: GNU Affero General Public License v3.0
Description: Cadasta Worker Toolbox
        ======================
        
        |PyPI version| |Build Status| |Requirements Status|
        
        A collection of helpers to assist in quickly building asynchronous
        workers for the Cadasta system.
        
        Architecture
        ------------
        
        The Cadasta asynchronous system is designed so that both the scheduled
        tasks and the task results can be tracked by the central `Cadasta
        Platform <https://github.com/Cadasta/cadasta-platform>`__. To ensure
        that this takes place, all Celery workers must be correctly configured
        to support these features.
        
        Tracking Scheduled Tasks
        ~~~~~~~~~~~~~~~~~~~~~~~~
        
        To keep our system aware of all tasks being scheduled, the Cadasta
        Platform has a process running to consume task messages off of a
        task-monitor queue and insert those messages into our database. To
        support this design, all task producers (including worker nodes) must
        publish their task messages to both the normal destination queues and
        the task-monitor queue. This is acheived by registering all queues with
        a `Topic
        Exchange <http://docs.celeryproject.org/en/latest/userguide/routing.html#topic-exchanges>`__,
        setting the task-monitor queue to subscribe to all messages sent to the
        exchange, and setting standard work queues to subscribe to messages with
        a matching ``routing_key``. Being that the Cadasta Platform is designed
        to work with Amazon SQS and the `SQS backend only keeps exchange/queue
        declarations in
        memory <http://docs.celeryproject.org/projects/kombu/en/v4.0.2/introduction.html#f1>`__,
        each message producer must have this set up within their configuration.
        
        Tracking Task Results
        ~~~~~~~~~~~~~~~~~~~~~
        
        *TODO*
        
        Library
        -------
        
        ``cadasta.workertoolbox.conf.Config``
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        The ``Config`` class was built to simplify configuring Celery settings,
        helping to ensure that all workers adhere to the architecture
        requirements of the Cadasta asynchronous system. An instance of the
        ``Config`` should come configured with all Celery settings that are
        required by our system. It is the aim of the class to not require much
        customization on the part of the developer. However, some customization
        may be needed when altering configuration between environments (e.g. if
        dev settings vary greatly from prod settings).
        
        Required Arguments
        ^^^^^^^^^^^^^^^^^^
        
        ``queues``
        ''''''''''
        
        The only required argument is the ``queues`` array. This should contain
        an array of names for queues that are to be used by the given worker.
        This includes queues from which the node processes tasks and queues into
        which the node will schedule tasks. It is not necessary to include the
        ``'celery'`` or ``'platform.fifo'`` queues, as these will be added
        automatically. The input of the ``queues`` variable will be stored as
        ``QUEUES`` on the ``Config`` instance.
        
        Optional Arguments
        ^^^^^^^^^^^^^^^^^^
        
        Any `Celery
        setting <http://docs.celeryproject.org/en/v4.0.2/userguide/configuration.html#new-lowercase-settings>`__
        may be submitted. It is internal convention that we use the lowercase
        Celery settings rather than their older upper-case counterparts. This
        will ensure that they are displayed when calling ``repr`` on the
        ``Conf`` instance.
        
        ``result_backend``
        ''''''''''''''''''
        
        *TODO*
        
        ``task_queues``
        '''''''''''''''
        
        *TODO*
        
        *Note: It is recommended that developers not alter this setting.*
        
        ``task_routes``
        '''''''''''''''
        
        *TODO*
        
        *Note: It is recommended that developers not alter this setting.*
        
        Internal Variables
        ^^^^^^^^^^^^^^^^^^
        
        By convention, all variables pertinent to only the ``Config`` class
        (i.e. not used by Celery) should be written entirely uppercase.
        
        ``RESULT_DB_USER``
        ''''''''''''''''''
        
        Variable used to populate the default ``result_backend`` template.
        
        ``RESULT_DB_PASS``
        ''''''''''''''''''
        
        Variable used to populate the default ``result_backend`` template.
        
        ``RESULT_DB_HOST``
        ''''''''''''''''''
        
        Variable used to populate the default ``result_backend`` template.
        
        ``RESULT_DB_NAME``
        ''''''''''''''''''
        
        Variable used to populate the default ``result_backend`` template.
        
        ``PLATFORM_QUEUE_NAME``
        '''''''''''''''''''''''
        
        Defaults to ``'platform.fifo'``.
        
        *Note: It is recommended that developers not alter this setting.*
        
        ``cadasta.workertoolbox.tests.build_functional_tests``
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        When provided with a Celery app instance, this function generates a
        suite of functional tests to ensure that the provided application's
        configuration and functionality conforms with the architecture of the
        Cadasta asynchronous system.
        
        An example, where an instanciated and configured ``Celery()`` app
        instance exists in a parallel ``celery`` module:
        
        .. code:: python
        
            from cadasta.workertoolbox.tests import build_functional_tests
        
            from .celery import app
        
            FunctionalTests = build_functional_tests(app)
        
        To run these tests, use your standard test runner (e.g. ``pytest``) or
        call manually from the command-line:
        
        .. code:: bash
        
            python -m unittest path/to/tests.py
        
        Development
        -----------
        
        Testing
        ~~~~~~~
        
        .. code:: bash
        
            pip install -r requirements-test.txt
            ./runtests
        
        Deploying
        ~~~~~~~~~
        
        .. code:: bash
        
            pip install -r requirements-deploy.txt
            python setup.py clean build publish tag
        
        .. |PyPI version| image:: https://badge.fury.io/py/cadasta-workertoolbox.svg
           :target: https://badge.fury.io/py/cadasta-workertoolbox
        .. |Build Status| image:: https://travis-ci.org/Cadasta/cadasta-workertoolbox.svg?branch=master
           :target: https://travis-ci.org/Cadasta/cadasta-workertoolbox
        .. |Requirements Status| image:: https://requires.io/github/Cadasta/cadasta-workertoolbox/requirements.svg?branch=master
           :target: https://requires.io/github/Cadasta/cadasta-workertoolbox/requirements/?branch=master
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
