Integrate Elasticsearch DSL with Django REST framework.
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.
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
Filtering filter backend (big variety of native- and functional- query lookups, such as gt, gte, lt, lte, endswith, contains, wildcard, exists, exclude, isnull, range, in, prefix (same as startswith), term and terms is implemented.
Geo-spatial filtering filter backend (the following filters implemented: geo_distance, geo_polygon and geo_bounding_box).
Geo-spatial ordering filter backend (the following filters implemented: geo_distance).
Do you need a similar tool for GraphQL? Check graphene-elastic.
Check the live demo app (Django 3.1 + Django REST Framework 3.12 + Elasticsearch 7.5) hosted on Heroku and bonsai.io.
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.
It will set up:
Install latest stable version from PyPI:
pip install django-elasticsearch-dsl-drf
or latest stable version from GitHub:
pip install https://github.com/barseghyanartur/django-elasticsearch-dsl-drf/archive/stable.tar.gz
Add rest_framework, django_elasticsearch_dsl and django_elasticsearch_dsl_drf to INSTALLED_APPS:
INSTALLED_APPS = ( # ... # REST framework 'rest_framework', # Django Elasticsearch integration 'django_elasticsearch_dsl', # Django REST framework Elasticsearch integration (this package) 'django_elasticsearch_dsl_drf', # ... )
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:
./manage.py test django_elasticsearch_dsl_drf.tests.test_ordering
To run a single test class in a given test module in your working environment type:
It’s assumed that you have all the requirements installed. If not, first install the test requirements:
pip install -r examples/requirements/test.txt
Keep the following hierarchy.
===== title ===== header ====== sub-header ---------- sub-sub-header ~~~~~~~~~~~~~~ sub-sub-sub-header ^^^^^^^^^^^^^^^^^^ sub-sub-sub-sub-header ++++++++++++++++++++++ sub-sub-sub-sub-sub-header **************************
GPL-2.0-only OR LGPL-2.1-or-later
For any issues contact me at the e-mail given in the Author section.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for django-elasticsearch-dsl-drf-0.22.5.tar.gz
Hashes for django_elasticsearch_dsl_drf-0.22.5-py2.py3-none-any.whl