Metadata-Version: 1.1
Name: birdhousebuilder.recipe.pycsw
Version: 0.2.3
Summary: A Buildout recipe to install and configure pycsw Catalog Service (CSW) with Anaconda.
Home-page: https://github.com/bird-house/birdhousebuilder.recipe.pycsw
Author: Birdhouse
Author-email: UNKNOWN
License: BSD
Description: *****************************
        birdhousebuilder.recipe.pycsw
        *****************************
        
        .. contents::
        
        Introduction
        ************
        
        ``birdhousebuilder.recipe.pycsw`` is a `Buildout`_ recipe to install and configure `pycsw`_ with `Anaconda`_. `pycsw`_ is a Python implementation of a `Catalog Service for the Web`_ (CSW). ``pycsw`` will be deployed as a `Supervisor`_ service and is available on a `Nginx`_ web server. 
        
        This recipe is used by the `Birdhouse`_ project. 
        
        .. _`Buildout`: http://buildout.org/
        .. _`Anaconda`: http://continuum.io/
        .. _`Supervisor`: http://supervisord.org/
        .. _`Nginx`: http://nginx.org/
        .. _`pycsw`: http://pycsw.org/
        .. _`Catalog Service for the Web`: https://en.wikipedia.org/wiki/Catalog_Service_for_the_Web
        .. _`Birdhouse`: http://bird-house.github.io/
        
        
        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 ``pycsw`` package from a conda channel in a conda environment named ``birdhouse``. The location of the birdhouse environment is ``.conda/envs/birdhouse``. It setups a `pycsw`_ database (``sqlite``) in ``~/.conda/envs/birdhouse/var/lib/pycsw``. It deploys a `Supervisor`_ configuration for ``pycsw`` in ``~/.conda/envs/birdhouse/etc/supervisor/conf.d/pycsw.conf``. Supervisor can be started with ``~/.conda/envs/birdhouse/etc/init.d/supervisor start``.
        
        The recipe will install the ``nginx`` package from a conda channel and deploy a Nginx site configuration for ``pycsw``. The configuration will be deployed in ``~/.conda/envs/birdhouse/etc/nginx/conf.d/pycsw.conf``. Nginx can be started with ``~/.conda/envs/birdhouse/etc/init.d/nginx start``.
        
        By default ``pycsw`` will be available on http://localhost:8082/csw?service=CSW&version=2.0.2&request=GetCapabilities.
        
        The recipe depends on ``birdhousebuilder.recipe.conda``, ``birdhousebuilder.recipe.supervisor`` and ``birdhousebuilder.recipe.nginx``.
        
        Supported options
        =================
        
        The 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``
        
        **hostname**
           The hostname of the pycsw service (nginx). Default: ``localhost``
        
        **port**
           The port of the pycsw service (nginx). Default: ``8082``   
        
        
        Example usage
        =============
        
        The following example ``buildout.cfg`` installs ``pycsw`` with Anaconda::
        
        .. code-block:: ini
        
          [buildout]
          parts = pycsw
        
          anaconda-home = /opt/anaconda
        
          [pycsw]
          recipe = birdhousebuilder.recipe.pycsw
          hostname = localhost
          port = 8082
        
        After installing with Buildout start the ``pycsw`` service with::
        
          $ cd /home/myself/.conda/envs/birdhouse
          $ etc/init.d/supervisord start  # start|stop|restart
          $ etc/init.d/nginx start        # start|stop|restart
          $ bin/supervisorctl status      # check that pycsw is running
          $ less var/log/pycsw/pycsw.log  # check log file
        
        Open your browser with the following URL:
        
        .. code-block:: sh 
        
          http://localhost:8082/csw?service=CSW&version=2.0.2&request=GetCapabilities
        
        
        
        
        
        
        Authors
        *******
        
        Carsten Ehbrecht ehbrecht at dkrz.de
        
        Change History
        **************
        
        0.2.3 (2015-12-15)
        ==================
        
        * using ioos conda channel.
        
        0.2.2 (2015-06-25)
        ==================
        
        * added user option.
        
        0.2.1 (2015-05-11)
        ==================
        
        * merged https://github.com/bird-house/birdhousebuilder.recipe.pycsw/pull/1
        add check for PYCSW_CONFIG variable in os.environ
        
        0.2.0 (2015-02-24)
        ==================
        
        * installing in conda enviroment ``birdhouse``.
        * using ``$ANACONDA_HOME`` environment variable.
        * separation of anaconda-home and installation prefix.
        
        0.1.3 (2014-08-26)
        ==================
        
        * Fixed proxy configuration.
        
        0.1.2 (2014-08-13)
        ==================
        
        Changed gunicorn template for gunicorn 19.0.
        
        0.1.1 (2014-08-01)
        ==================
        
        Updated documentation.
        
        0.1.0 (2014-07-29)
        ==================
        
        Initial Release.
        
Keywords: buildout recipe birdhouse pycsw geopython anaconda
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
