esq

Install - Init - Usage - Documentation

A python package that provides GraphQL API for Elasticsearch and makes it easier to query data without writing complex queries.

Install

pip install esq

Init

>>> from esq import Esq
>>> from elasticsearch import Elasticsearch

# init your Elasticsearch client object here
>>> ELASTICSEARCH_URI = "http://localhost:9200"
>>> es_client = Elasticsearch([ELASTICSEARCH_URI])

# init your Esq object here
>>> esq = Esq(es_client)

# now you can start making queries

Usage

# to get aggregation on sentiment field on your twitter index, you can simply do:
>>> sentiments = esq.get_aggr_data(index='twitter',
                        data_type='keyword/text', #data_type is an enum('keyword/text', 'coordinates', 'timeseries')
                        data_field='sentiment')

>>> print(sentiments)
[{'label': 'positive', 'value': 9}, {'label': 'neutral', 'value': 7}, {'label': 'negative', 'value': 1}]

Documentation

Read the full usage documentation here

History

1.0.3 (10-10-2022)

• Added full usage detailed documentation.

1.0.2 (04-09-2022)

• Add Github Actions workflow for version bumping and release to PyPI.

1.0.1 (30-08-2022)

• Fix Docs and add content README.

1.0.0 (30-08-2022)

• First release on PyPI.