Metadata-Version: 1.0
Name: pyramid_rawes
Version: 0.2.1
Summary: Rawes binding for pyramid
Home-page: https://github.com/koenedaele/pyramid_rawes
Author: Koen Van Daele
Author-email: koen_van_daele@telenet.be
License: MIT
Description: pyramid_rawes
        =============
        
        This library helps integrate rawes_ in a pyramid application.
        
        .. image:: https://travis-ci.org/koenedaele/pyramid_rawes.png
                :target: https://travis-ci.org/koenedaele/pyramid_rawes
        
        Installation
        ------------
        
        To install pyramid_rawes, use pip
        
        .. code-block:: bash
            
            pip install pyramid_rawes
        
        Setup
        -----
        
        To activate pyramid_rawes
        
        .. code-block:: python
        
            config = Configurator()
            config.include('pyramid_rawes')
        
        
        By default, this will add an instance with all the default parameters 
        (eg. Elastic Search is assumed to run at localhost:9200). To configure your 
        rawes_ instance, you can use the pyramid settings file.
        
        .. code-block:: ini
        
            rawes.url = localhost:9500
            rawes.connection_type = http
        
        Once you have activated pyramid_rawes, a rawes_ instance is added to the registry.
        
        Usage
        -----
        
        To get a rawes_ instance, call get_rawes with the current application registry. 
        Eg. in a view:
        
        .. code-block:: python
        
            from pyramid_rawes import get_rawes
        
            def search(request):
                ES = get_rawes(request.registry)
                # execute search
                # ...
        
        You can also get a rawes_ instance by calling the get_rawes directive on the
        config.
        
        .. code-block:: python
        
            config = Configurator()
            config.include('pyramid_rawes')
            ES = config.get_rawes()
        
        .. _rawes: https://github.com/humangeo/rawes
        
        
        History
        =======
        
        0.2.1 (24-04-2013)
        ------------------
        
        - Fixed dependency on rawes < 0.4.0. Next release will upgrade to rawes 0.4.0.
        
        0.2.0 (18-01-2013)
        ------------------
        
        - Added get_rawes as a config directive
        - Renamed IRawES to IRawes
        - Pep8 fixes
        
        0.1.0 (16-01-2013)
        ------------------
        
        - Initial version
        
Keywords: pyramid elastic search rawes
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Framework :: Pyramid
Classifier: Topic :: Internet :: WWW/HTTP :: Indexing/Search
