Simple ElasticSearch indexing integration for Django.
Project description
===========================
Django Simple Elasticsearch
===========================
.. image:: https://badge.fury.io/py/django-simple-elasticsearch.png
:target: http://badge.fury.io/py/django-simple-elasticsearch
.. image:: https://travis-ci.org/jaddison/django-simple-elasticsearch.png?branch=master
:target: https://travis-ci.org/jaddison/django-simple-elasticsearch
.. image:: https://coveralls.io/repos/jaddison/django-simple-elasticsearch/badge.png
:target: https://coveralls.io/r/jaddison/django-simple-elasticsearch
.. image:: https://pypip.in/d/django-simple-elasticsearch/badge.png
:target: https://pypi.python.org/pypi/django-simple-elasticsearch
This package provides a simple method of creating Elasticsearch indexes for
Django models.
**Using a version older than 0.9.0? Please be aware that as of v0.9.0, this package
has changed in a backwards-incompatible manner. Version 0.5 is deprecated and no
longer maintained.**
-----
Documentation
-------------
Visit the `django-simple-elasticsearch documentation on ReadTheDocs <http://django-simple-elasticsearch.readthedocs.org/>`_.
Features
--------
* class mixin with a set of :code:`@classmethods` used to handle:
* type mapping definition
* individual object indexing and deletion
* bulk object indexing
* model signal handlers for pre/post_save and pre/post_delete (optional)
* management command to handle index/type mapping initialization and bulk indexing
* uses Elasticsearch aliases to ease the burden of re-indexing
* small set of Django classes and functions to help deal with Elasticsearch querying
* base search form class to handle input validation, query preparation and response handling
* multi-search processor class to batch multiple Elasticsearch queries via :code:`_msearch`
* 'get' shortcut functions
Installation
------------
At the command line::
$ easy_install django-simple-elasticsearch
Or::
$ pip install django-simple-elasticsearch
License
-------
**django-simple-elasticsearch** is licensed as free software under the BSD license.
Todo
----
* Review search classes - simplify functionality where possible. This may cause breaking changes.
* Tests. Write them.
* Documentation. Write it.
History
-------
0.9.6 (2014-11-16)
---------------------
* Python 3.3+ support, modified (no new) testcases.
0.9.5 (2014-11-15)
---------------------
* Added in tox support, initial set of test cases and verified travis-ci is working.
0.9.2 (2014-11-12)
---------------------
* Fixed broken management command.
0.9.1 (2014-11-10)
---------------------
* Added missing management command module.
0.9.0 (2014-11-10)
---------------------
* In what will become version 1.0, this 0.9.x codebase is a revamp of the
original codebase (v0.5.x). Completely breaking over previous versions.
0.5.0 (2014-03-05)
---------------------
Final release in 0.x codebase - this old codebase is now unmaintained.
Django Simple Elasticsearch
===========================
.. image:: https://badge.fury.io/py/django-simple-elasticsearch.png
:target: http://badge.fury.io/py/django-simple-elasticsearch
.. image:: https://travis-ci.org/jaddison/django-simple-elasticsearch.png?branch=master
:target: https://travis-ci.org/jaddison/django-simple-elasticsearch
.. image:: https://coveralls.io/repos/jaddison/django-simple-elasticsearch/badge.png
:target: https://coveralls.io/r/jaddison/django-simple-elasticsearch
.. image:: https://pypip.in/d/django-simple-elasticsearch/badge.png
:target: https://pypi.python.org/pypi/django-simple-elasticsearch
This package provides a simple method of creating Elasticsearch indexes for
Django models.
**Using a version older than 0.9.0? Please be aware that as of v0.9.0, this package
has changed in a backwards-incompatible manner. Version 0.5 is deprecated and no
longer maintained.**
-----
Documentation
-------------
Visit the `django-simple-elasticsearch documentation on ReadTheDocs <http://django-simple-elasticsearch.readthedocs.org/>`_.
Features
--------
* class mixin with a set of :code:`@classmethods` used to handle:
* type mapping definition
* individual object indexing and deletion
* bulk object indexing
* model signal handlers for pre/post_save and pre/post_delete (optional)
* management command to handle index/type mapping initialization and bulk indexing
* uses Elasticsearch aliases to ease the burden of re-indexing
* small set of Django classes and functions to help deal with Elasticsearch querying
* base search form class to handle input validation, query preparation and response handling
* multi-search processor class to batch multiple Elasticsearch queries via :code:`_msearch`
* 'get' shortcut functions
Installation
------------
At the command line::
$ easy_install django-simple-elasticsearch
Or::
$ pip install django-simple-elasticsearch
License
-------
**django-simple-elasticsearch** is licensed as free software under the BSD license.
Todo
----
* Review search classes - simplify functionality where possible. This may cause breaking changes.
* Tests. Write them.
* Documentation. Write it.
History
-------
0.9.6 (2014-11-16)
---------------------
* Python 3.3+ support, modified (no new) testcases.
0.9.5 (2014-11-15)
---------------------
* Added in tox support, initial set of test cases and verified travis-ci is working.
0.9.2 (2014-11-12)
---------------------
* Fixed broken management command.
0.9.1 (2014-11-10)
---------------------
* Added missing management command module.
0.9.0 (2014-11-10)
---------------------
* In what will become version 1.0, this 0.9.x codebase is a revamp of the
original codebase (v0.5.x). Completely breaking over previous versions.
0.5.0 (2014-03-05)
---------------------
Final release in 0.x codebase - this old codebase is now unmaintained.
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
Close
Hashes for django-simple-elasticsearch-0.9.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | aabed1d242814b195f9a4a3a01ae5a43d2fba01c776351d43005b376684c24ea |
|
MD5 | 3a0dc4d7974191769001db9f52884345 |
|
BLAKE2b-256 | 6b53552d4fa1555223a7b7fd7e117d7213d90dcfae6265a1c3b8912e2d21c713 |