Skip to main content

Integrate Elasticsearch DSL with Django REST framework.

Project description

Integrate Elasticsearch DSL with Django REST framework in the shortest way possible, with least efforts possible.

Package provides views, serializers, filter backends, pagination and other handy add-ons.

You are expected to use django-elasticsearch-dsl for defining your Elasticsearch documents.


  • Django 1.8, 1.9, 1.10, 1.11, 2.0 and 2.1.
  • Python 2.7, 3.4, 3.5, 3.6, 3.7
  • Elasticsearch 2.x, 5.x, 6.x


elasticsearch and elasticsearch-dsl

Depending on your Elasticsearch version (either 2.x, 5.x or 6.x) you should use 2.x, 5.x or 6.x versions of the elasticsearch and elasticsearch-dsl packages accordingly.


You are advised to use the latest version of django-elasticsearch-dsl.


Initial version of this package was written for djangorestframework 3.6.2.


A frontend demo (React based) is available. See the dedicated docs for more information.

To bootstrap evaluation, clone the repository locally and run docker-compose.

docker-compose up

It will set up:


Documentation is available on Read the Docs.

Main features and highlights


  1. Install latest stable version from PyPI:

    pip install django-elasticsearch-dsl-drf

    or latest stable version from GitHub:

    pip install

    or latest stable version from BitBucket:

    pip install
  2. Add rest_framework, django_elasticsearch_dsl and django_elasticsearch_dsl_drf to INSTALLED_APPS:

        # ...
        # REST framework
        # Django Elasticsearch integration
        # Django REST framework Elasticsearch integration (this package)
        # ...

Quick start

Perhaps the easiest way to get acquainted with django-elasticsearch-dsl-drf is to read the quick start tutorial.

See it as a guide of diving into integration of Elasticsearch with Django with very low knowledge entry level.


Project is covered with tests.

To test with all supported Python/Django versions type:


To test against specific environment, type:

tox -e py37-django21

To test just your working environment type:


To run a single test in your working environment type:

./ src/django_elasticsearch_dsl_drf/tests/


./ test django_elasticsearch_dsl_drf.tests.test_ordering

To run a single test class in a given test module in your working environment type:

./ src/django_elasticsearch_dsl_drf/tests/

It’s assumed that you have all the requirements installed. If not, first install the test requirements:

pip install -r examples/requirements/test.txt

Writing documentation

Keep the following hierarchy.









GPL 2.0/LGPL 2.1


For any issues contact me at the e-mail given in the Author section.


Artur Barseghyan <>

Project details

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
django_elasticsearch_dsl_drf-0.17.2-py2.py3-none-any.whl (222.7 kB) Copy SHA256 hash SHA256 Wheel 3.6
django-elasticsearch-dsl-drf-0.17.2.tar.gz (136.8 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page