Metadata-Version: 2.1
Name: apies
Version: 0.0.16
Summary: A flask blueprint providing an API for accessing and searching an ElasticSearch index created from source datapackages
Home-page: https://github.com/OpenBudget/apies
Author: Adam Kariv
Author-email: adam.kariv@gmail.com
License: MIT
Keywords: data
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: Flask (<2,>=1)
Requires-Dist: Flask-Cors (<4.0.0,>=3.0.7)
Requires-Dist: requests (<3.0.0,>=2.20.1)
Requires-Dist: elasticsearch (<6.0.0,>=5.0.0)
Requires-Dist: datapackage
Requires-Dist: flask-jsonpify
Requires-Dist: demjson
Provides-Extra: develop
Requires-Dist: pylama ; extra == 'develop'
Requires-Dist: tox ; extra == 'develop'

apies
=====

.. image:: https://travis-ci.org/OpenBudget/apies.svg?branch=master
    :target: https://travis-ci.org/OpenBudget/apies

.. image:: http://img.shields.io/coveralls/OpenBudget/apies.svg?branch=master
    :target: https://coveralls.io/r/OpenBudget/apies?branch=master

apies is a flask blueprint providing an API for accessing and searching an ElasticSearch index created from source datapackages.

endpoints
---------

TBD

configuration
-------------

Flask configuration for this blueprint:


.. code-block:: python

    from apies import apies_blueprint
    import elasticsearch

    app.register_blueprint(
        apies_blueprint(['path/to/datapackage.json', Package(), ...],
                        elasticsearch.Elasticsearch(...), 
                        'index-to-search-in', 
                        document_doctype='document',
                        dont_highlight=['fields', 'not.to', 'highlight']),
        url_prefix='/search/'
    )

