Skip to main content

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

Project description

esq

Build Status [pypi] Documentation Status

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

esq-1.0.3.tar.gz (11.9 kB view hashes)

Uploaded Source

Built Distribution

esq-1.0.3-py2.py3-none-any.whl (5.7 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page