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.
Documentation
Documentation is available on Read the Docs.
Make sure to read FAQ.
Prerequisites
Django 2.2, 3.0 and 3.1.
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.
Demos
Online demo
Check the live demo app (Django 3.1 + Django REST Framework 3.12 + Elasticsearch 7.5) hosted on Heroku and bonsai.io.
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 upIt will set up:
Elasticsearch on http://localhost:9200
Django REST framework on http://localhost:8000
React on http://localhost:3000
Installation
Install latest stable version from PyPI:
pip install django-elasticsearch-dsl-drfor latest stable version from GitHub:
pip install https://github.com/barseghyanartur/django-elasticsearch-dsl-drf/archive/stable.tar.gzAdd 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', # ... )
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.
Testing
Project is covered with tests.
To test with all supported Python/Django versions type:
toxTo test against specific environment, type:
tox -e py38-django30To test just your working environment type:
./runtests.pyTo run a single test in your working environment type:
./runtests.py src/django_elasticsearch_dsl_drf/tests/test_filtering.pyOr:
./manage.py test django_elasticsearch_dsl_drf.tests.test_orderingTo run a single test class in a given test module in your working environment type:
./runtests.py src/django_elasticsearch_dsl_drf/tests/test_suggesters.py::TestSuggestersIt’s assumed that you have all the requirements installed. If not, first install the test requirements:
pip install -r examples/requirements/test.txtWriting documentation
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
**************************License
GPL-2.0-only OR LGPL-2.1-or-later
Support
For any issues contact me at the e-mail given in the Author section.
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
Built Distribution
Hashes for django-elasticsearch-dsl-drf-0.22.1.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | bdc88c0a3ddbcf7172d932135038b8353c39270fe1ede59127572f2c4490dbd3 |
|
| MD5 | ce6c87d5329c2e7d54bb1ada1e6da48f |
|
| BLAKE2b-256 | 5116a014b220df0f872cc7245b93c864cf58048b9ab9c4b0d25005f848bb48a2 |
Hashes for django_elasticsearch_dsl_drf-0.22.1-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 644c6b97adafab19620a6025d81e153a66cacf8c306febabef264a872b03a9a5 |
|
| MD5 | 94e2a4f8e52fd428399e2ed1c193e74a |
|
| BLAKE2b-256 | 01e82264fea17c898081d6df118bef51be75db6e3f11fe98e63f4cf46611cf6e |
