Metadata-Version: 2.1
Name: django-elasticsearch-debug-toolbar
Version: 3.0.2
Summary: A Django Debug Toolbar panel for Elasticsearch
Home-page: http://github.com/Benoss/django-elasticsearch-debug-toolbar
Author: Benoit Chabord
Author-email: benauf@gmail.com
License: MIT
Keywords: django,es,elastic,elasticsearch
Platform: UNKNOWN
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
License-File: LICENSE
License-File: AUTHORS

Django Elasticsearch Toolbar
============================

A Django Debug Toolbar panel for Elasticsearch
[![Build Status](https://travis-ci.org/Benoss/django-elasticsearch-debug-toolbar.svg?branch=master)](https://travis-ci.org/Benoss/django-elasticsearch-debug-toolbar)
[![PyPI version](https://badge.fury.io/py/django-elasticsearch-debug-toolbar.svg)](https://badge.fury.io/py/django-elasticsearch-debug-toolbar)

About
------------

Breaking changes:
* django-elasticsearch-debug-toolbar 3.x is compatible with Django Debug Toolbar 3.x (elasticsearch <8.0.0)
* django-elasticsearch-debug-toolbar 2.x is compatible with Django Debug Toolbar 2.x
* django-elasticsearch-debug-toolbar 1.x is compatible with Django Debug Toolbar 1.x

ElasticSearch queries using [elasticsearch python](https://github.com/elasticsearch/elasticsearch-py) official client.

You are more than welcome to participate
* Any idea and no time to code send your idea here: https://github.com/Benoss/django-elasticsearch-debug-toolbar/issues
* An idea and the code just send a pull request here: https://github.com/Benoss/django-elasticsearch-debug-toolbar/pulls



Installation
------------

Install using ``pip``::

    pip install django-elasticsearch-debug-toolbar

or install the development version from source::

    pip install git+git@github.com:Benoss/django-elasticsearch-debug-toolbar.git

* Then add ``elastic_panel`` to your ``INSTALLED_APPS`` so that we can find the templates in the panel.
* Also, add ``'elastic_panel.panel.ElasticDebugPanel'`` to your ``DEBUG_TOOLBAR_PANELS``.

Usage
------------

Just click the link in the Django Debug toolbar:

![elastic queries image](https://raw.github.com/Benoss/django-elasticsearch-debug-toolbar/master/doc/elastic_queries.png)

License
------------

Uses the `MIT` license.

* Django Debug Toolbar: https://github.com/django-debug-toolbar/django-debug-toolbar
* MIT: http://opensource.org/licenses/MIT


