Metadata-Version: 2.4
Name: django-elasticsearch-debug-toolbar
Version: 3.1.0
Summary: A Django Debug Toolbar panel for Elasticsearch
Author-email: Benoit Chabord <benauf@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/Benoss/django-elasticsearch-debug-toolbar
Project-URL: Changelog, https://github.com/Benoss/django-elasticsearch-debug-toolbar/blob/master/CHANGES
Keywords: django,es,elastic,elasticsearch
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
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
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: AUTHORS
Dynamic: license-file

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

A Django Debug Toolbar panel for Elasticsearch
[![PyPI version](https://badge.fury.io/py/django-elasticsearch-debug-toolbar.svg)](https://badge.fury.io/py/django-elasticsearch-debug-toolbar)
[![Tests](https://github.com/Benoss/django-elasticsearch-debug-toolbar/actions/workflows/tests.yml/badge.svg)](https://github.com/Benoss/django-elasticsearch-debug-toolbar/actions/workflows/tests.yml)

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

Supported versions (tested in CI):
* django-elasticsearch-debug-toolbar 3.1+: Django 2.2 to 6.x, Django Debug Toolbar 3.8 to 7.x, Python 3.9 to 3.14, elasticsearch 7.x, 8.x and 9.x
* django-elasticsearch-debug-toolbar 3.0: Django Debug Toolbar 3.x (elasticsearch <8.0.0)
* django-elasticsearch-debug-toolbar 2.x: Django Debug Toolbar 2.x
* django-elasticsearch-debug-toolbar 1.x: 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
