introduction user-guide advanced-usage Tutorial dataset <IMDB> API reference <reference/pandagg> Contributing <CONTRIBUTING>
pandagg is a Python package providing a simple interface to manipulate ElasticSearch queries and aggregations. It brings the following features:
- flexible aggregation and search queries declaration
- query validation based on provided mapping
- parsing of aggregation results in handy format: interactive bucket tree, normalized tree or tabular breakdown
- mapping interactive navigation
pandagg can be installed with pip:
$ pip install pandagg
Alternatively, you can grab the latest source code from GitHub:
$ git clone git://github.com/alkemics/pandagg.git
$ python setup.py install
The user-guide
is the place to go to learn how to use the library and accomplish common tasks. The more in-depth advanced-usage
guide is the place to go for deeply nested queries.
An example based on publicly available IMDB data is documented in repository examples/imdb directory, with a jupyter notebook to showcase some of pandagg functionalities: here it is.
The reference/pandagg
documentation provides API-level documentation.
pandagg is made available under the MIT License. For more details, see LICENSE.txt.
We happily welcome contributions, please see CONTRIBUTING
for details.