Metadata-Version: 1.1
Name: kitconcept.recipe.solr
Version: 1.0.0a3
Summary: Buildout recipe for Solr.
Home-page: https://github.com/kitconcept/kitconcept.recipe.solr
Author: kitconcept GmbH
Author-email: info@kitconcept.com
License: gpl
Description: Introduction
        ============
        
        .. image:: https://travis-ci.org/kitconcept/kitconcept.recipe.solr.svg?branch=master
            :target: https://travis-ci.org/kitconcept/kitconcept.recipe.solr
        
        |
        
        .. image:: https://raw.githubusercontent.com/kitconcept/kitconcept.recipe.solr/master/kitconcept.png
           :alt: kitconcept
           :target: https://kitconcept.com/
        
        
        Buildout recipe for Solr.
        
        Supported options
        =================
        
        The recipe supports the following options:
        
        src (required)
            Source of the Solr download (e.g. "http://archive.apache.org/dist/lucene/solr/7.2.1/solr-7.2.1.tgz").
        
        port (default: 8983)
            Solr port
        
        solr-config
            Path to a Solr configuration directory that contains a "core.properties" file and a "data" and "conf" directory.
        
        solr-core-name (default: plone)
            Name of the Solr core. Default is 'plone'.
        
        Example usage
        =============
        
        Minimal Buildout
        ----------------
        
        We'll start by creating a minimal buildout that uses the recipe::
        
            >>> write('buildout.cfg',
            ... """
            ... [buildout]
            ... parts = solr
            ...
            ... [solr]
            ... recipe = kitconcept.recipe.solr
            ... src = %(src)s
            ... """ % {
            ...     'src' : 'http://archive.apache.org/dist/lucene/solr/7.2.1/solr-7.2.1.tgz',
            ... })
        
        The only required attribute is `src` that contains a URL of the Solr tgz file.
        
        Running the buildout gives us::
        
            >>> buildout_output_lower = system(buildout).lower()
            >>> "installing solr" in buildout_output_lower
            True
            >>> import os
            >>> current_path = os.path.dirname(os.path.realpath(__file__))
            >>> full_path = os.path.join(current_path, 'parts/solr/bin/solr')
            >>> os.path.exists(full_path)
            True
        
            >>> full_path = os.path.join(current_path, 'parts/solr/server/solr/plone')
            >>> os.path.exists(full_path)
            True
        
        
        Complete Buildout
        -----------------
        
        We'll start by creating a buildout that uses the recipe::
        
            >>> write('buildout.cfg',
            ... """
            ... [buildout]
            ... parts = solr
            ...
            ... [solr]
            ... recipe = kitconcept.recipe.solr
            ... src = %(src)s
            ... port = %(port)s
            ... solr-config = %(solr-config)s
            ... solr-core-name = %(solr-core-name)s
            ... """ % {
            ...     'src' : 'http://archive.apache.org/dist/lucene/solr/7.2.1/solr-7.2.1.tgz',
            ...     'port' : '8983',
            ...     'solr-config': 'config',
            ...     'solr-core-name': 'solr-core-plone',
            ... })
        
        Running the buildout gives us::
        
            >>> buildout_output_lower = system(buildout).lower()
            >>> "installing solr" in buildout_output_lower
            True
            >>> import os
            >>> current_path = os.path.dirname(os.path.realpath(__file__))
            >>> full_path = os.path.join(current_path, 'parts/solr/bin/solr')
            >>> os.path.exists(full_path)
            True
        
            >>> full_path = os.path.join(current_path, 'parts/solr/server/solr/plone')
            >>> os.path.exists(full_path)
            True
        Detailed Documentation
        ======================
        
        Contributors
        ============
        
        Note:  place names and roles of the people who contribute to this package
               in this file, one to a line, like so:
        
        - Timo Stollenwerk (kitconcept GmbH)
        
        Change history
        ==============
        
        Changelog
        =========
        
        1.0.0a3 (2019-03-23)
        --------------------
        
        - Fix README.rst.
          [kitconcept]
        
        
        1.0.0a2 (2019-03-23)
        --------------------
        
        - Make config variable optional.
          [kitconcept]
        
        
        1.0.0a1 (2019-02-07)
        --------------------
        
        - Initial release.
          [kitconcept]
        
        Download
        ========
        
Keywords: plone buildout solr
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Buildout
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
