Eve-Elastic
Eve-Elastic is elastic data layer for eve REST framework.
Features
fulltext search
filtering via elasticsearch filter dsl
facets support
aggregations support
elasticsearch mapping generator for schema
License
Eve-Elastic is GPLv3 licensed.
Supported elastic versions
It supports elastic 7 versions.
Install
$ pip install Eve-ElasticUsage
Set elastic as your eve data layer.
import eve
from eve_elastic import Elastic
app = eve.Eve(data=Elastic)
app.run()Config
There are 2 options for Eve-Elastic taken from app.config:
ELASTICSEARCH_URL (default: 'http://localhost:9200/') - this can be either single url or list of urls
ELASTICSEARCH_INDEX - (default: 'eve')
ELASTICSEARCH_INDEXES - (default: {}) - resource to index mapping
ELASTICSEARCH_FORCE_REFRESH - (default: True) - force index refresh after every modification
ELASTICSEARCH_AUTO_AGGREGATIONS - (default: True) - return aggregates on every search if configured for resource
Query params
Eve-Elastic supports eve like queries via where param which work as term filter.
On top of this, there is a predefined query_string query which does fulltext search.
$ curl http://localhost:5000/items?q=foo&df=nameq - query (default: *)
df - default field (default: _all)
Filtering
For more sophisticated filtering, you can use filter query param which will be used as filter for the query, using elastic filter dsl.
Facets
To add a facets support for specific resource, add facets into its datasource:
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.
1 maintainer
Metadata
1 maintainer
Release files for Eve-Elastic 7.4.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| eve_elastic-7.4.3.tar.gz | 61.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| Eve_Elastic-7.4.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 99.9 kB
Release files / eve_elastic-7.4.3.tar.gz
| Download URL | eve_elastic-7.4.3.tar.gz |
|---|---|
| Size | 61.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
01f86dbadd189ec1a4bfa59957f4a7929769dcfe2d7c5f821c538a06254559d1
|
|
BLAKE2b-256 checksum How to use checksums |
1990932b5605095a14e1e14976950bf4d42f27b4cce48ea1554e904e61706b4f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.0.1 CPython/3.12.8
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Dec 20, 2024.
Transparency logRelease files / Eve_Elastic-7.4.3-py3-none-any.whl
| Download URL | Eve_Elastic-7.4.3-py3-none-any.whl |
|---|---|
| Size | 38.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9e396fd653b041ba87f62f9c6c9d54d7f7db752a2a2ae831659950e417d80b7e
|
|
BLAKE2b-256 checksum How to use checksums |
975a39f7d90657be9a3a450c433d43f11a658ca0270cd546df3c8dad723be1dd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.0.1 CPython/3.12.8
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Dec 20, 2024.
Transparency log
