Integrate Elasticsearch DSL with Django REST framework.

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for delusionalinsanity from gravatar.com delusionalinsanity

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: GNU General Public License v2 (GPLv2), GNU Lesser General Public License v2 or later (LGPLv2+) (GPL 2.0/LGPL 2.1)
  • Author: Artur Barseghyan
  • Tags django
Classifiers

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, 1.11 and 2.0.

  • Python 2.7, 3.4, 3.5, 3.6

  • Elasticsearch 2.x, 5.x, 6.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

Verified details

These details have been verified by PyPI
Maintainers
Avatar for delusionalinsanity from gravatar.com delusionalinsanity

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: GNU General Public License v2 (GPLv2), GNU Lesser General Public License v2 or later (LGPLv2+) (GPL 2.0/LGPL 2.1)
  • Author: Artur Barseghyan
  • Tags django
Classifiers

Release history Release notifications | RSS feed

0.22.5

0.22.4

0.22.3

0.22.2

0.22.1

0.22

0.21

0.20.9

0.20.8

0.20.7

0.20.6

0.20.5

0.20.4

0.20.3

0.20.2

0.20.1

0.20

0.19

0.18

0.17.7

0.17.6

0.17.5

0.17.4

0.17.3

0.17.2

0.17.1

0.17

0.16.3

0.16.2

0.16.1

0.16

0.15.1

0.15

0.14

0.13.2

0.13.1

This version

0.13

0.12

0.11

0.10

0.9

0.8.4

0.8.3

0.8.2

0.8.1

0.8

0.7.2

0.7.1

0.7

0.6.4

0.6.3

0.6.2

0.6.1

0.6

0.5.1

0.5

0.4.4

0.4.3

0.4.2

0.4.1

0.4

0.3.12

0.3.11

0.3.10

0.3.9

0.3.8

0.3.7

0.3.6

0.3.5

0.3.4

0.3.3

0.3.2

0.3.1

0.3

0.2.6

0.2.5

0.2.4

0.2.3

0.2.2

0.2.1

0.2

0.1.8

0.1.7

0.1.6

0.1.5

0.1.4

0.1.3

0.1.2

0.1.1

0.1

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

Uploaded Source

Built Distribution

django_elasticsearch_dsl_drf-0.13-py2.py3-none-any.whl (116.3 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for django-elasticsearch-dsl-drf-0.13.tar.gz
Algorithm Hash digest
SHA256 3f821f64cb62e26e8a5da88c2db91be274a07f72202c68c07c30118015eed43e
MD5 956290c92bf17b88486a8e0d573e8dc3
BLAKE2b-256 27b3a52c512adc880de9c946ff85a32970c7e226a0c99544babfd9e3d76270dc

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for django_elasticsearch_dsl_drf-0.13-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b02f5f270e75c3eeda650c201d24007b06ee83a3f6b44e521eaee36ca448cc65
MD5 b4df93f98f624952f1dbd84822db5c6b
BLAKE2b-256 a6cafeb7d130a66c9708a0370e55f0167c91f52f00bdaf1a8f3946a9ce114be5

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