Metadata-Version: 2.1
Name: oarepo-micro-api
Version: 1.0.1
Summary: OARepo REST API microservice
Home-page: https://github.com/oarepo/oarepo-micro-api
Author: Miroslav Bauer @ CESNET
Author-email: bauer@cesnet.cz
License: MIT
Description: # OARepo Micro API
        
        [![image](https://img.shields.io/travis/oarepo/oarepo-micro-api.svg)](https://travis-ci.org/oarepo/oarepo-micro-api)
        [![image](https://img.shields.io/coveralls/oarepo/oarepo-micro-api.svg)](https://coveralls.io/r/oarepo/oarepo-micro-api)
        [![image](https://img.shields.io/github/license/oarepo/oarepo-micro-api.svg)](https://github.com/oarepo/oarepo-micro-api/blob/master/LICENSE)
        
        OARepo REST API microservice module
        
        ## Getting Started
        
        This package will provide a simple UWSGI microservice that will serve
        all of the registered OArepo API apps in your repository instance under the `/api` endpoint. It also
        provides some `/.well-known` endpoints that are usable for running in k8s environments.
        
        ### Prerequisites
        
        - Python >=3.6
        - Docker
        
        ### How to use
        
        Specify this package as a dependency in your OArepo repository project's `setup.py`.
        If you're using `oarepo` as a base package for your repository, you should use the following extras:
        ```python
        # setup.py
        #...
        install_requires = [
            'oarepo[micro-api,...another-oarepo-extras]'
        ]
        #...
        ```
        otherwise:
        ```python
        # setup.py
        #...
        install_requires = [
            'oarepo-micro-api'
        ]
        #...
        ```
        
        After that, reinstall your project by:
        ```
        pip install -e .
        ```
        
        Start your repository instance and verify, that everything worked out, by running:
        ```
        curl -k https://localhost:5000/.well-known/heartbeat/readiness
        ```
        
        ## License
        
        This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
        
Keywords: oarepo-micro-api Invenio
Platform: any
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Development Status :: 3 - Alpha
Description-Content-Type: text/markdown
Provides-Extra: tests
