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 and 2.0.
- Python 2.7, 3.4, 3.5, 3.6
- Elasticsearch 2.x, 5.x, 6.x
Documentation is available on Read the Docs.
Dynamic serializer for Documents <basic_usage_examples>
.Search filter backend <advanced_usage_examples>
.Ordering filter backend <advanced_usage_examples>
.Filtering filter backend <advanced_usage_examples>
(big variety of native- and functional- query lookups, such asgt
,gte
,lt
,lte
,endswith
,contains
,wildcard
,exists
,exclude
,isnull
,range
,in
,prefix
(same asstartswith
),term
andterms
is implemented.Geo-spatial filtering filter backend <advanced_usage_examples>
(the following filters implemented:geo_distance
,geo_polygon
andgeo_bounding_box
).Geo-spatial ordering filter backend <advanced_usage_examples>
(the following filters implemented:geo_distance
).Faceted search filter backend <advanced_usage_examples>
.Post-filter filter backend <advanced_usage_examples>
.Nested filtering filter backend <nested_fields_usage_examples>
.Highlight backend <advanced_usage_examples>
.Suggester filter backend <advanced_usage_examples>
.Functional suggester filter backend <advanced_usage_examples>
.Pagination (Page number and limit/offset pagination) <advanced_usage_examples>
.Ids filter backend <advanced_usage_examples>
.
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
or latest stable version from BitBucket:
pip install https://bitbucket.org/barseghyanartur/django-elasticsearch-dsl-drf/get/stable.tar.gz
Add
rest_framework
,django_elasticsearch_dsl
anddjango_elasticsearch_dsl_drf
toINSTALLED_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 <quick_start>
.
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:
tox
To test against specific environment, type:
tox -e py36-django110
To test just your working environment type:
./runtests.py
To run a single test in your working environment type:
./runtests.py src/django_elasticsearch_dsl_drf/tests/test_filtering.py
Or:
./manage.py test django_elasticsearch_dsl_drf.tests.test_ordering
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/LGPL 2.1
For any issues contact me at the e-mail given in the Author section.
Artur Barseghyan <artur.barseghyan@gmail.com>