Metadata-Version: 1.1
Name: elasticsearch-tornado
Version: 2.0.2
Summary: Tornado HTTP client for Elasticsearch
Home-page: https://github.com/hodgesds/elasticsearch_tornado
Author: Daniel Hodges
Author-email: hodges.daniel.scott@gmail.com
License: Apache License, Version 2.0
Description: Tornado Elasticsearch Client
        ----------------------------
        
        Tornado http client for Elasticsearch. Its goal is to provide common
        ground for all Elasticsearch-related code in tornado and provide a
        similar api to the official elasticsearch python client (elasticsearch-py).
        However, this client only works for HTTP (no thrift or memcache) and doesn't
        support connection pooling at this time (one client per instance). This
        allows for you to design your own pooling/handling of callbacks.
        
        
        Elasticsearch Compatibility
        ---------------------------
        
        The library is compatible with Elasticsearch 2.X
        
        
        Installation
        ------------
        
        .. code-block:: bash
        
            pip install elasticsearch_tornado
        
        
        Documentation
        -------------
        http://elasticsearch-tornado.readthedocs.org/en/latest/
        
        
        CLI
        ---
        Elasticsearch Tornado also provides a handy cli for interacting with
        Elasticsearch clusters. Here are a few handy commands:
        
        .. code-block:: bash
        
            $ et cat master
            127.0.0.1 127.0.0.1 8 20 0.05 d * Randall Shire
        
            $ et cat nodes
            127.0.0.1 127.0.0.1 8 20 0.05 d * Randall Shire
        
            $ et cat shards
            index    2 p STARTED    0  131b 127.0.0.1 Randall Shire
            index    2 r UNASSIGNED
            index    4 p STARTED    1 3.7kb 127.0.0.1 Randall Shire
            index    4 r UNASSIGNED
            index    3 p STARTED    0  131b 127.0.0.1 Randall Shire
            index    3 r UNASSIGNED
            index    1 p STARTED    0  131b 127.0.0.1 Randall Shire
            index    1 r UNASSIGNED
            index    0 p STARTED    0  131b 127.0.0.1 Randall Shire
            index    0 r UNASSIGNED
            test     0 p STARTED    0  159b 127.0.0.1 Randall Shire
            test     0 r UNASSIGNED
            .scripts 0 p STARTED    1 2.7kb 127.0.0.1 Randall Shire
        
        
        Example use
        -----------
        
        Simple use-case:
        
        .. code-block:: python
        
            from __future__            import print_function
            from elasticsearch_tornado import EsClient, serialize
            from functools             import partial
            from tornado               import ioloop, gen
            import json
        
        
            c = EsClient()
        
        
            @gen.coroutine
            def index(doc):
                p = partial(
                   c.index,
                   'test_index',
                   'test_doctype',
                   serialize(doc),
                )
                res = yield gen.Task(p)
                raise gen.Return(res)
        
        
            @gen.coroutine
            def get(doc_id):
                p = partial(
                   c.get,
                   'test_index',
                    doc_id,
                )
                res = yield gen.Task(p)
                raise gen.Return(res)
        
        
            @gen.coroutine
            def main_coro():
                res = yield index({"user": "foo", "age": 100})
                doc_id = json.loads(res.body).get('_id', '')
                res = yield get(doc_id)
                print(res.body)
        
        
        .. code-block:: bash
        
            {"_index":"test_index","_type":"test_doctype","_id":"AVQmGdzo66UC-UgKXqlX","_version":1,"found":true,"_source":{"age": 100, "user": "foo"}
            }
        
        
        Features
        --------
        The client's features include:
         * Non blocking requests with callbacks/coroutines
         * DYOS- Do You Own Serialization- (remember those trailing \n's)
        
        
        Python Compatibility
        --------------------
        
        Tested with python:
        2.6, 2.7, 3.2, 3.3, 3.4 and pypy
        
        
        License
        -------
        
        Copyright 2014-2016 Daniel Hodges
        
        Licensed under the Apache License, Version 2.0 (the "License");
        you may not use this file except in compliance with the License.
        You may obtain a copy of the License at
        
            http://www.apache.org/licenses/LICENSE-2.0
        
        Unless required by applicable law or agreed to in writing, software
        distributed under the License is distributed on an "AS IS" BASIS,
        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
        See the License for the specific language governing permissions and
        limitations under the License.
        
        
        Requirements
        ------------
        
        .. image:: https://requires.io/github/hodgesds/elasticsearch_tornado/requirements.svg?branch=master
            :target: https://requires.io/github/hodgesds/elasticsearch_tornado/requirements/?branch=master
            :alt: Requirements Status
        
        
        Build status
        ------------
        
        .. image:: https://travis-ci.org/hodgesds/elasticsearch_tornado.svg?branch=master
            :target: https://travis-ci.org/hodgesds/elasticsearch_tornado
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
