UNKNOWN
Project description
Muffin-ElasticSearch
############
.. _description:
Muffin-ElasticSearch -- A simple ElasticSearch plugin for muffin_ framework.
.. _badges:
.. image:: http://img.shields.io/travis/drgarcia1986/muffin-elasticsearch.svg?style=flat-square
:target: http://travis-ci.org/drgarcia1986/muffin-elasticsearch
:alt: Build Status
.. _requirements:
Requirements
=============
- python >= 3.4
- muffin >= 0.5.5
- aioes >= 0.2
.. _installation:
Installation
=============
**Muffin-ElasticSearch** should be installed using pip: ::
pip install git+https://github.com/drgarcia1986/muffin-elasticsearch.git
.. _usage:
Usage
=====
Add *muffin-elasticsearch* to muffin plugin list:
.. code-block:: python
import muffin
app = muffin.Application(
'example',
PLUGINS=(
'muffin_elasticsearch',
)
)
And use *ElasticSearch* plugin:
.. code-block:: python
@app.register('/search')
class Example(muffin.Handler):
@asyncio.coroutine
def post(self, request):
body = yield from request.json()
result = yield from app.ps.elasticsearch.create(
index='my-index',
doc_type='test',
id=42,
body=body
)
return muffin.json_response(
data=result, status=201
)
@asyncio.coroutine
def get(self, request):
ret = yield from app.ps.elasticsearch.get(
index='my-index',
doc_type='test-type',
id=42
)
return muffin.json_response(data=result)
.. _options:
Options
-------
========================== ==============================================================
*ELASTICSEARCH_ENDPOINTS* List of ElasticSearch servers (``['localhost:9200']``)
========================== ==============================================================
.. _bugtracker:
Bug tracker
===========
If you have any suggestions, bug reports or
annoyances please report them to the issue tracker
at https://github.com/drgarcia1986/muffin-elasticsearch/issues
.. _contributing:
Contributing
============
Development of Muffin-ElasticSearch happens at: https://github.com/drgarcia1986/muffin-elasticsearch
Contributors
=============
* drgarcia1986_ (Diego Garcia)
.. _license:
License
=======
Licensed under a `MIT license`_.
.. _links:
.. _muffin: https://github.com/klen/muffin
.. _drgarcia1986: https://github.com/drgarcia1986
.. _MIT license: http://opensource.org/licenses/MIT
############
.. _description:
Muffin-ElasticSearch -- A simple ElasticSearch plugin for muffin_ framework.
.. _badges:
.. image:: http://img.shields.io/travis/drgarcia1986/muffin-elasticsearch.svg?style=flat-square
:target: http://travis-ci.org/drgarcia1986/muffin-elasticsearch
:alt: Build Status
.. _requirements:
Requirements
=============
- python >= 3.4
- muffin >= 0.5.5
- aioes >= 0.2
.. _installation:
Installation
=============
**Muffin-ElasticSearch** should be installed using pip: ::
pip install git+https://github.com/drgarcia1986/muffin-elasticsearch.git
.. _usage:
Usage
=====
Add *muffin-elasticsearch* to muffin plugin list:
.. code-block:: python
import muffin
app = muffin.Application(
'example',
PLUGINS=(
'muffin_elasticsearch',
)
)
And use *ElasticSearch* plugin:
.. code-block:: python
@app.register('/search')
class Example(muffin.Handler):
@asyncio.coroutine
def post(self, request):
body = yield from request.json()
result = yield from app.ps.elasticsearch.create(
index='my-index',
doc_type='test',
id=42,
body=body
)
return muffin.json_response(
data=result, status=201
)
@asyncio.coroutine
def get(self, request):
ret = yield from app.ps.elasticsearch.get(
index='my-index',
doc_type='test-type',
id=42
)
return muffin.json_response(data=result)
.. _options:
Options
-------
========================== ==============================================================
*ELASTICSEARCH_ENDPOINTS* List of ElasticSearch servers (``['localhost:9200']``)
========================== ==============================================================
.. _bugtracker:
Bug tracker
===========
If you have any suggestions, bug reports or
annoyances please report them to the issue tracker
at https://github.com/drgarcia1986/muffin-elasticsearch/issues
.. _contributing:
Contributing
============
Development of Muffin-ElasticSearch happens at: https://github.com/drgarcia1986/muffin-elasticsearch
Contributors
=============
* drgarcia1986_ (Diego Garcia)
.. _license:
License
=======
Licensed under a `MIT license`_.
.. _links:
.. _muffin: https://github.com/klen/muffin
.. _drgarcia1986: https://github.com/drgarcia1986
.. _MIT license: http://opensource.org/licenses/MIT
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 muffin-elasticsearch-0.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f89824607ba8ed59cbd611d7ef1af204436432ce291159d4a9f5c440295cf8d0 |
|
MD5 | b04b1d8830cc40d5b1d5a3b4404c8876 |
|
BLAKE2b-256 | 7c1aa6250233a185d06042facd9817bc5ea4c98449b68cf33008e3f725f088e9 |