Metadata-Version: 1.1
Name: birdhousebuilder.recipe.supervisor
Version: 0.1.5
Summary: A Buildout recipe to install and configure supervisor for Anaconda.
Home-page: https://github.com/bird-house/birdhousebuilder.recipe.supervisor.git
Author: Carsten Ehbrecht
Author-email: ehbrecht at dkrz.de
License: BSD
Description: **********************************
        birdhousebuilder.recipe.supervisor
        **********************************
        
        .. contents::
        
        Introduction
        ************
        
        ``birdhousebuilder.recipe.supervisor`` is a `Buildout`_ recipe to configure `Supervisor`_ services with `Anaconda`_.
        
        Birdhousebuilder recipes are used to build Web Processing Service components (Phoenix, Malleefowl, Nighthawk, FlyingPigeon, ...) of the ClimDaPs project. All Birdhousebuilder recipes need an existing `Anaconda`_ installation.  
        
        
        .. _`Buildout`: http://buildout.org/
        .. _`Anaconda`: http://continuum.io/
        .. _`Supervisor`: http://supervisord.org/
        
        Usage
        *****
        
        The recipe requires that Anaconda is already installed. It assumes that Anaconda is installed at the default location in your home directory ``~/anaconda``. Otherwise you need to set the Buildout option ``anaconda-home``.
        
        The recipe will install the ``supervisor`` package from a conda channel and deploy a supervisor configuration of a given service. The configuration will be deployed in ``~/anaconda/etc/supervisor/conf.d/myapp.conf``. Supervisor can be started with ``~/anaconda/etc/init.d/supervisord start``.
        
        The recipe depends on ``birdhousebuilder.recipe.conda``.
        
        Supported options
        =================
        
        This recipe supports the following options:
        
        ``anaconda-home``
           Buildout option with the root folder of the Anaconda installation. Default: ``$HOME/anaconda``.
        
        ``supervisor-port``
           Buildout option (optional) to set the supervisor port. Default is 9001 (http://localhost:9001).
        
        ``program``
           The name of the supervisor service.
        
        ``command``
           The command to start the service.
        
        ``directory``
           The directory where the command is started.
        
        Example usage
        =============
        
        The following example ``buildout.cfg`` installs a Supervisor configuration for ``myapp`` web application::
        
          [buildout]
          parts = myapp
        
          anaconda-home = /home/myself/anaconda
          supervisor-port = 9001
        
          [myapp]
          recipe = birdhousebuilder.recipe.supervisor
          program = myapp
          command = ${buildout:bin-directory}/gunicorn -b unix:///tmp/myapp.socket myapp:app 
          directory = /tmp
        
        
        
        
        
        Authors
        *******
        
        Carsten Ehbrecht ehbrecht at dkrz.de
        
        Changes
        *******
        
        0.1.5 (2015-01-22)
        ==================
        
        * bugfix: var/log/supervisor directory is now created.
        
        0.1.4 (2014-12-06)
        ==================
        
        * Don't update conda on buildout update.
        
        0.1.3 (2014-07-31)
        ==================
        
        * Updated documentation.
        
        0.1.2 (2014-07-24)
        ==================
        
        * Removed workaround "kill nginx".
        
        0.1.1 (2014-07-22)
        ==================
        
        * Not using supervisor-host option.
        
        0.1.0 (2014-07-10)
        ==================
        
        * Initial Release.
        
Keywords: buildout recipe
Platform: UNKNOWN
Classifier: Framework :: Buildout
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: BSD License
