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.

PyPI Version Supported Python versions Build Status Documentation Status GPL-2.0-only OR LGPL-2.1-or-later Coverage


Documentation is available on Read the Docs.

Make sure to read FAQ.


  • Django 2.2, 3.1 and 3.2.

  • Python 3.6, 3.7, 3.8 and 3.9.

  • Elasticsearch 6.x, 7.x. For older versions use django-elasticsearch-dsl-drf version 0.18.

Main features and highlights

Do you need a similar tool for GraphQL? Check graphene-elastic.


Online demo

Check the live demo app (Django 3.1 + Django REST Framework 3.12 + Elasticsearch 7.5) hosted on Heroku and

Local demo

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:


  1. Install latest stable version from PyPI:

    pip install django-elasticsearch-dsl-drf

    or latest stable version from GitHub:

    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 py38-django30

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-only OR LGPL-2.1-or-later


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


Artur Barseghyan <>

Project details

Release history Release notifications | RSS feed

Download files

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

Source Distribution

django-elasticsearch-dsl-drf-0.22.5.tar.gz (99.1 kB view hashes)

Uploaded source

Built Distribution

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