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.

Prerequisites

  • Django 1.8, 1.9, 1.10 and 1.11.

  • Python 2.7, 3.4, 3.5, 3.6

  • Elasticsearch 2.x, 5.x

Dependencies

Documentation

Documentation is available on Read the Docs.

Main features and highlights

Installation

  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. 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',
        # ...
    )

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:

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

Writing 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/LGPL 2.1

Support

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

Author

Artur Barseghyan <artur.barseghyan@gmail.com>

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.3.10.tar.gz (44.9 kB view details)

Uploaded Source

Built Distribution

django_elasticsearch_dsl_drf-0.3.10-py2.py3-none-any.whl (45.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-elasticsearch-dsl-drf-0.3.10.tar.gz.

File metadata

File hashes

Hashes for django-elasticsearch-dsl-drf-0.3.10.tar.gz
Algorithm Hash digest
SHA256 e3f3180f2e54f23af0d9f796ea8384cf584fea078a754b9d4138bc944d0f0919
MD5 54d45b6572b21fa9d660db08e990dde2
BLAKE2b-256 a989aa936a7bd8e1b84a0b1fbb98fd8ec6184933a5e4a86e5261410d1ec32bc6

See more details on using hashes here.

Provenance

File details

Details for the file django_elasticsearch_dsl_drf-0.3.10-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_elasticsearch_dsl_drf-0.3.10-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f02069a999d75ad19e46ac24fbfee622b879e16f9cf9ccd381e33ba9a86970ba
MD5 99935ba918d48d799944f019090dacfe
BLAKE2b-256 ab01ffa75a96dc8ad365a03ba6fd4f0842091cf652a7846156c76890d2291eae

See more details on using hashes here.

Provenance

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