semvec/pypi-packages huggingface dataset:
pyramid_rawes 0.5.1
Rawes bindings for pyramid
License: MIT
Keywords: pyramid elastic search rawes

pyramid_rawes
=============

This library helps integrate rawes_ in a pyramid application.

.. image:: https://travis-ci.org/koenedaele/pyramid_rawes.png?branch=master
        :target: https://travis-ci.org/koenedaele/pyramid_rawes
.. image:: https://coveralls.io/repos/koenedaele/pyramid_rawes/badge.png?branch=master
        :target: https://coveralls.io/r/koenedaele/pyramid_rawes
.. image:: https://badge.fury.io/py/pyramid_rawes.png
        :target: http://badge.fury.io/py/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 = http://localhost:9500

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.5.1 (26-09-2014)
------------------

- If only one url is specified, don't pass a list to rawes, but a string. This
  allows rawes to autodetect paths. (#2)

0.5.0 (27-08-2014)
------------------

- Switch to py.test for unit tests.
- Add ability to specify several ES hosts in the url setting.

0.4.1 (15-04-2014)
------------------

- Restore compatibility with zope.interface 4.1.x
- Add Coveralls

0.4.0 (27-09-2013)
------------------

- Make pyramid_rawes compatible with rawes 0.5.x
- Introduce unit test support for py3k (requires rawes 0.5.1)
- Ability to specify json_encoder and json_decoder as dotted python name.
- Dropped support for py26.

0.3.0 (29-04-2013)
------------------

- Make pyramid_rawes compatible with rawes 0.4.0.

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