Metadata-Version: 1.1
Name: birdhousebuilder.recipe.conda
Version: 0.3.2
Summary: A Buildout recipe to install conda packages
Home-page: https://github.com/bird-house/birdhousebuilder.recipe.conda
Author: Birdhouse
Author-email: wps-dev at dkrz.de
License: Apache License 2
Description: *****************************
        birdhousebuilder.recipe.conda
        *****************************
        
        .. image:: https://travis-ci.org/bird-house/birdhousebuilder.recipe.conda.svg?branch=master
           :target: https://travis-ci.org/bird-house/birdhousebuilder.recipe.conda
           :alt: Travis Build
        
        
        Introduction
        ************
        
        ``birdhousebuilder.recipe.conda`` is a `Buildout`_ recipe to install `Anaconda`_ packages. This recipe is used by the `Birdhouse`_ project. 
        
        .. _`Buildout`: http://buildout.org/
        .. _`Anaconda`: http://www.continuum.io/
        .. _`Birdhouse`: http://bird-house.github.io/
        
        Usage
        *****
        
        The recipe requires that Anaconda is already installed. You can use the buildout option ``anaconda-home`` to set the prefix for the anaconda installation. You can also use the recipe option ``prefix`` to set the conda prefix. Otherwise the environment variable ``CONDA_PREFIX`` (variable is set when activating a conda environment) is used as conda prefix. 
        
        
        Supported options
        =================
        
        This recipe supports the following options:
        
        **anaconda-home**
           Buildout option pointing to the root folder of the Anaconda installation. Default: ``$HOME/anaconda``.
        
        **conda-channels**
           Buildout option (optional) with additional channels of conda packages. Default: defaults
        
        **prefix**
          Path to the conda prefix (optional). If not given then ``CONDA_PREFIX`` or anaconda-home will be used.
          
        **pkgs**
           A list of packages to install, separated by space.
        
        **channels**
           A list of space separated conda channels (optional). These channels are merged with conda-channels option. Default: defaults.
        
        **override-channels**
           If True then default channels from ``~/.condarc`` are ignored (optional). Default. true.
        
        **no-pin**
           If True then conda pinned file is ignored (optional). Default: false.
        
        **env**
           Name of conda environment used for installation (optional). If environment is missing then packages are installed in the active environment.
        
        **default-pkgs**
           A list of packages to install when creating a conda environment separated by space (optional). Default: ``python``
        
        **pip-pkgs**
           A list of packages which are installed by pip into the conda enviroment (optional).
        
        .. note::
        
           If buildout is run in offline mode no network connection will be establish and conda packages will not be installed.
        
        .. note::
        
           If buildout is run in ``newest=false`` mode then conda dependencies are not updated.
        
        
        Example usage
        =============
        
        The following example ``buildout.cfg`` installs the packages in the active conda environment.
        
        .. code-block:: sh
        
          [buildout]
          parts = conda
        
          [conda]
          recipe = birdhousebuilder.recipe.conda
          pkgs = lxml owslib
          channels = defaults birdhouse
        
        
        
        Authors
        *******
        
        Carsten Ehbrecht ehbrecht at dkrz.de
        
        Changes
        *******
        
        0.3.2 (2016-07-11)
        ==================
        
        * catch conda exception (#7).
        
        0.3.1 (2016-06-30)
        ==================
        
        * using ``CONDA_PREFIX``.
        
        0.3.0 (2016-06-28)
        ==================
        
        * added option no-pin and override-channels.
        * sets conda env-path and prefix in options. 
        * enabled travis build.
        * removed unused as_bool and makedirs functions.
        * using bool_option from zc.buildout.
        * using conda offline mode.
        * install pip packages.
        * added prefix option.
        * using ``CONDA_ENV_PATH``.
        
        0.2.7 (2016-04-15)
        ==================
        
        * removed default ioos conda channel.
        
        0.2.6 (2015-12-15)
        ==================
        
        * added default ioos conda channel.
        
        0.2.5 (2015-09-21)
        ==================
        
        * use buildout offline option ... don't establish internet connection when enabled.
        
        0.2.4 (2015-08-05)
        ==================
        
        * use CONDA_ENVS_DIR to overwrite base dir of conda environments. 
        
        0.2.2 (2015-02-25)
        ==================
        
        * sets buildout:prefix option as installation default directory for birdhouse.
        
        0.2.1 (2015-02-24)
        ==================
        
        * setting ``anaconda-home`` with environment variable ``$ANACONDA_HOME``.
        * separation of install prefix and anaconda-home.
        
        0.2.0 (2015-02-23)
        ==================
        
        * conda environments can be created now.
        * added channels option.
        
        0.1.4 (2015-01-09)
        ==================
        
        * added https://conda.binstar.org/birdhouse to default channels.
        
        0.1.3 (2015-01-08)
        ==================
        
        * added https://conda.binstar.org/scitools to default channels.
        
        0.1.2 (2014-12-02)
        ==================
        
        * added on on-update buildout option. 
        
        0.1.1 (2014-07-31)
        ==================
        
        * Updated documentation.
        
        0.1.0 (2014-07-10)
        ==================
        
        * Initial Release.
        
Keywords: buildout recipe conda anaconda birdhouse
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
