========
README
========
ElasticUtils is a convenient Django QuerySet-like API for querying
Elasticsearch.
Project details
===============
:Code: https://github.com/mozilla/elasticutils
:Documentation: http://elasticutils.rtfd.org
:Issue tracker: https://github.com/mozilla/elasticutils/issues
:IRC: ``#elasticutils`` on irc.mozilla.org
:License: BSD 3-clause; see LICENSE file
Our unit tests are run by Travis CI every time we commit to the
master branch.
.. image:: https://secure.travis-ci.org/mozilla/elasticutils.png?branch=master
:target: http://travis-ci.org/mozilla/elasticutils
Quick install
=============
Latest released version::
$ pip install elasticutils
Run the dev version (which is master tip)::
$ pip install elasticutils==dev
That corresponds with
`<http://github.com/mozilla/elasticutils/tarball/master#egg=elasticutils-dev>`_.
Quick start
===========
See https://elasticutils.readthedocs.org/ for the quick start.