Metadata-Version: 2.1
Name: django-elasticsearch
Version: 7.0.2
Summary: Wrapper around elasticsearch-dsl for django models
License: Apache-2.0
Keywords: django,elasticsearch,elasticsearch-dsl
Author: Sabricot
Requires-Python: >=3.6,<4.0
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.11
Classifier: Framework :: Django :: 2.2
Classifier: Framework :: Django :: 3.0
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Dist: django (>=1.11)
Requires-Dist: elasticsearch-dsl (>=7.0.0,<8.0.0)
Description-Content-Type: text/markdown

![PyPI](https://img.shields.io/pypi/v/django_elasticsearch)
![python version](https://img.shields.io/badge/python-3.6+-blue.svg)
![PyPI - Django Version](https://img.shields.io/pypi/djversions/django-elasticsearch)
![ElasticSearch Version](https://img.shields.io/badge/elasticsearch-7.0%2B-blue)
![Travis (.com)](https://img.shields.io/travis/com/django-elasticsearch/django-elasticsearch)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
# Django-Elasticsearch

Django-Elasticsearch is a package that allows indexing of django models in elasticsearch.
It utilizes [elasticsearch-dsl](https://github.com/elastic/elasticsearch-dsl-py)
so you can use all the features developed by the elasticsearch-dsl-py team.

## Installation

```bash
pip install django_elasticsearch
# or, you know... 
poetry add django_elasticsearch
```

## Usage

At the moment, follow https://django-elasticsearch-dsl.readthedocs.io/
but replace `django_elasticsearch_dsl` with `django_elasticsearch`

## Features

- Based on [elasticsearch-dsl](https://github.com/elastic/elasticsearch-dsl-py) so you can make queries with the [Search](http://elasticsearch-dsl.readthedocs.io/en/stable/search_dsl.html) class.
- Django signal receivers on save and delete for keeping Elasticsearch in sync.
- Management commands for creating, deleting, rebuilding and populating indices.
- Elasticsearch auto mapping from django models fields.
- Complex field type support (ObjectField, NestedField).
- Index fast using `parallel` indexing.

### Elasticsearch Compatibility
The library is currently **only** compatible with Elasticsearch 7

