This release is a pre-release and may not be stable for production use.
===========
.. image:: https://travis-ci.org/petrjasek/eve-elastic.png?branch=master
:target: https://travis-ci.org/petrjasek/eve-elastic
Eve-Elastic is `elasticsearch <http://www.elasticsearch.org>`_ data layer for `eve REST framework <http://python-eve.org>`_.
Features
--------
- fulltext search
- filtering via elasticsearch filter dsl
- facets support
- elasticsearch mapping generator for schema
License
-------
Eve-Elastic is `GPLv3 <http://www.gnu.org/licenses/gpl-3.0.txt>`_ licensed.
Install
-------
.. code-block:: bash
$ pip install Eve-Elastic
Usage
-----
Set elastic as your eve data layer.
.. code-block:: python
import eve
form eve_elastic import Elastic
app = eve.Eve(data=Elastic)
Config
------
There are 2 options for Eve-Elastic taken from ``app.config``:
- ``ELASTICSEARCH_URL`` (default: ``'http://localhost:9200/'``)
- ``ELASTICSEARCH_INDEX`` - (default: ``'eve'``)
Filter DSL
~~~~~~~~~~
For more sophisticated filtering, you can use ``filter`` query param which will be used as filter for the query, using elastic `filter dsl <http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-filters.html>`_.
Facets
------
To add a facets support for specific resource, add ``facets`` into its ``datasource``:
.. code-block:: python
DOMAIN = {
'contacts': {
'datasource':
'facets': {
'urgency': {'terms': {'field': 'urgency'}},
'versioncreated': {'date_histogram': {'field': 'versioncreated', 'interval': 'hour'}}
}
}
}
You will find `more info about facets in elasticsearch docs <http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-facets.html>`_.
.. :changelog:
Changelog
---------
0.1.3 (2014-01-31)
++++++++++++++++++
- Allow filtering via elasticsearch filter dsl
0.1.2 (2014-01-30)
++++++++++++++++++
- Fix pip install (add missing MANIFEST file)
0.1.1 (2014-01-30)
++++++++++++++++++
- Add changelog ;)
- Migrate readme to rst and use it for ``long_description``
0.1.0 (2014-01-28)
++++++++++++++++++
- Initial release
1 maintainer
Metadata
1 maintainer
Release files for Eve-Elastic 0.1.3b2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| Eve-Elastic-0.1.3b2.tar.gz | 41.0 kB | Without provenance | Details |
Release files / Eve-Elastic-0.1.3b2.tar.gz
| Download URL | Eve-Elastic-0.1.3b2.tar.gz |
|---|---|
| Size | 41.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9e854c752a33bf9653751a8db5a66bbfff05aea9f23d5c68fbb077e4e7c0fbff
|
|
BLAKE2b-256 checksum How to use checksums |
1027fc7bf1abe18f8014acb545acd81b4aab535cc10a74ea8de826b3cd6d30a7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for Eve-Elastic 0.1.3b2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
