Metadata-Version: 1.1
Name: birdhousebuilder.recipe.redis
Version: 0.1.0
Summary: A Buildout recipe to install and configure Redis for Birdhouse.
Home-page: https://github.com/bird-house/birdhousebuilder.recipe.redis
Author: Birdhouse
Author-email: UNKNOWN
License: Apache License 2.0
Description: *****************************
        birdhousebuilder.recipe.redis
        *****************************
        
        .. image:: https://travis-ci.org/bird-house/birdhousebuilder.recipe.redis.svg?branch=master
           :target: https://travis-ci.org/bird-house/birdhousebuilder.recipe.redis
           :alt: Travis Build
        
        .. contents::
        
        Introduction
        ************
        
        ``birdhousebuilder.recipe.redis`` is a `Buildout <http://buildout.org/>`_ recipe to install and configure `Redis <http://redis.io//>`_ in-memory datastore with `Anaconda <http://www.continuum.io/>`_.
        This recipe is used by the `Birdhouse <http://bird-house.github.io/>`_ project. 
        
        
        Usage
        *****
        
        The recipe requires that Anaconda is already installed. It assumes that the default Anaconda location is in your home directory ``~/anaconda``. Otherwise you need to set the ``ANACONDA_HOME`` environment variable or the Buildout option ``anaconda-home``.
        
        It installs the ``redis`` package from a conda channel in a conda enviroment named ``birdhouse``. The location of the birdhouse environment is ``.conda/envs/birdhouse``. It deploys a `Supervisor <http://supervisord.org/>`_ configuration for Redis in ``~/.conda/envs/birdhouse/etc/supervisor/conf.d/redis.conf``. Supervisor can be started with ``~/.conda/envs/birdhouse/etc/init.d/supervisord start``.
        
        The recipe depends on ``birdhousebuilder.recipe.conda`` and ``birdhousebuilder.recipe.supervisor``.
        
        Supported options
        =================
        
        This recipe supports the following options:
        
        **anaconda-home**
           Buildout option with the root folder of the Anaconda installation. Default: ``$HOME/anaconda``.
           The default location can also be set with the environment variable ``ANACONDA_HOME``. Example:
        
        .. code-block:: sh
        
             export ANACONDA_HOME=/opt/anaconda
        
           Search priority is:
        
           1. ``anaconda-home`` in ``buildout.cfg``
           2. ``$ANACONDA_HOME``
           3. ``$HOME/anaconda``
        
        **port**
           Accept connections on the specified port. Default: 6379.
        
        **loglevel**
           Specify the server verbosity level (debug, verbose, notice, warning). Default: warning.
        
        
        Example usage
        =============
        
        The following example ``buildout.cfg`` installs Redis with Anaconda and default options:
        
        .. code-block:: ini 
        
          [buildout]
          parts = redis
        
          anaconda-home = /home/myself/anaconda
        
          [redis]
          recipe = birdhousebuilder.recipe.redis
        
        
        Authors
        *******
        
        Carsten Ehbrecht ehbrecht at dkrz.de
        
        Changes
        *******
        
        0.1.0 (2015-12-10)
        ==================
        
        * Initial Release.
        
Keywords: buildout recipe birdhouse conda celery redis
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 :: Apache Software License
