Repository files navigation

IntegrateElasticsearch DSL withDjango REST framework inthe shortest way possible, with least efforts possible.

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

You are expected to usedjango-elasticsearch-dsl for defining yourElasticsearch documents.

Documentation is available onRead the Docs.

Make sure to readFAQ.

• Django 1.11, 2.0, 2.1 and 2.2.
• Python 2.7, 3.5, 3.6, 3.7.
• Elasticsearch 6.x, 7.x. For older versions usedjango-elasticsearch-dsl-drf version 0.18.

• :doc:`Dynamic serializer for Documents <basic_usage_examples>`.
• :doc:`Search filter backend <advanced_usage_examples>`.
• :doc:`Ordering filter backend <advanced_usage_examples>`.
• :doc:`Filtering filter backend <advanced_usage_examples>` (big variety ofnative- and functional- query lookups, such asgt,gte,lt,lte,endswith,contains,wildcard,exists,exclude,isnull,range,in,prefix (same asstartswith),termandterms is implemented.
• :doc:`Geo-spatial filtering filter backend <advanced_usage_examples>` (thefollowing filters implemented:geo_distance,geo_polygon andgeo_bounding_box).
• :doc:`Geo-spatial ordering filter backend <advanced_usage_examples>` (thefollowing filters implemented:geo_distance).
• :doc:`Faceted search filter backend <advanced_usage_examples>`.
• :doc:`Post-filter filter backend <advanced_usage_examples>`.
• :doc:`Nested filtering filter backend <nested_fields_usage_examples>`.
• :doc:`Highlight backend <advanced_usage_examples>`.
• :doc:`Suggester filter backend <advanced_usage_examples>`.
• :doc:`Functional suggester filter backend <advanced_usage_examples>`.
• :doc:`Pagination (Page number and limit/offset pagination) <advanced_usage_examples>`.
• :doc:`Ids filter backend <advanced_usage_examples>`.
• :doc:`Multi match search filter backend <search_backends>`.
• :doc:`Simple search query search filter backend <search_backends>`.
• :doc:`More-like-this support (detail action) <more_like_this>`.
• :doc:`Global aggregations support <global_aggregations>`.
• :doc:`Source filter backend <source_backend>`.

A frontend demo (React based) is available. See thededicated docsfor more information.

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

docker-compose up

It will set up:

• Elasticsearch onhttp://localhost:9200
• Django REST framework onhttp://localhost:8000
• React onhttp://localhost:3000

1. 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

2. Addrest_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 withdjango-elasticsearch-dsl-drfis to read the:doc:`quick start tutorial <quick_start>`.

See it as a guide of diving into integration of Elasticsearch with Djangowith 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 py37-django21

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.pytest django_elasticsearch_dsl_drf.tests.test_ordering

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

./runtests.py src/django_elasticsearch_dsl_drf/tests/test_suggesters.py::TestSuggesters

It's assumed that you have all the requirements installed. If not, firstinstall 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 theAuthor section.

Artur Barseghyan <artur.barseghyan@gmail.com>