oarepo-micro-api


Nameoarepo-micro-api JSON
Version 3.3.62 PyPI version JSON
download
home_pagehttps://github.com/oarepo/oarepo-micro-api
SummaryOARepo REST API microservice
upload_time2021-04-10 08:04:48
maintainer
docs_urlNone
authorMiroslav Bauer @ CESNET
requires_python
licenseMIT
keywords oarepo-micro-api invenio
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/oarepo/oarepo-micro-api",
    "name": "oarepo-micro-api",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "oarepo-micro-api Invenio",
    "author": "Miroslav Bauer @ CESNET",
    "author_email": "bauer@cesnet.cz",
    "download_url": "https://files.pythonhosted.org/packages/96/3c/5fe39f509a6813c75d9ddacc63ab709ea3a432d23a0c35e0c92674bc8011/oarepo-micro-api-3.3.62.tar.gz",
    "platform": "any",
    "description": "# OARepo Micro API\n\n[![image](https://img.shields.io/travis/oarepo/oarepo-micro-api.svg)](https://travis-ci.org/oarepo/oarepo-micro-api)\n[![image](https://img.shields.io/coveralls/oarepo/oarepo-micro-api.svg)](https://coveralls.io/r/oarepo/oarepo-micro-api)\n[![image](https://img.shields.io/github/license/oarepo/oarepo-micro-api.svg)](https://github.com/oarepo/oarepo-micro-api/blob/master/LICENSE)\n\nOARepo REST API microservice module\n\n## Getting Started\n\nThis package will provide a simple UWSGI microservice that will serve\nall of the registered OArepo API apps in your repository instance under the `/api` endpoint. It also\nprovides some `/.well-known` endpoints that are usable for running in k8s environments.\n\n### Prerequisites\n\n- Python >=3.6\n- Docker\n\n### How to use\n\nSpecify this package as a dependency in your OArepo repository project's `setup.py`.\nIf you're using `oarepo` as a base package for your repository, you should use the following extras:\n```python\n# setup.py\n#...\ninstall_requires = [\n    'oarepo[micro-api,...another-oarepo-extras]'\n]\n#...\n```\notherwise:\n```python\n# setup.py\n#...\ninstall_requires = [\n    'oarepo-micro-api'\n]\n#...\n```\n\nAfter that, reinstall your project by:\n```\npip install -e .\n```\n\nStart your repository instance and verify, that everything worked out, by running:\n```\ncurl -k https://localhost:5000/.well-known/heartbeat/readiness\n```\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "OARepo REST API microservice",
    "version": "3.3.62",
    "split_keywords": [
        "oarepo-micro-api",
        "invenio"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "41d5f31a1f0f9c330f04baa1fd1959c0",
                "sha256": "2a98cc73c5bb8e608eec50d9d2c45d7eaa303a9637175c0dffc59a06b7abc3f9"
            },
            "downloads": -1,
            "filename": "oarepo_micro_api-3.3.62-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "41d5f31a1f0f9c330f04baa1fd1959c0",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 14918,
            "upload_time": "2021-04-10T08:04:47",
            "upload_time_iso_8601": "2021-04-10T08:04:47.826278Z",
            "url": "https://files.pythonhosted.org/packages/6e/c5/678acdf735419ec74e2a40266cff30d1b062c5ce0f261671f25c4ea29950/oarepo_micro_api-3.3.62-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "f383922e08fbf0cd30c6cec7bf328609",
                "sha256": "a35287075b8de3cf1105c871501e0a7bccee617a965cac7485698ab3cde2365b"
            },
            "downloads": -1,
            "filename": "oarepo-micro-api-3.3.62.tar.gz",
            "has_sig": false,
            "md5_digest": "f383922e08fbf0cd30c6cec7bf328609",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 14477,
            "upload_time": "2021-04-10T08:04:48",
            "upload_time_iso_8601": "2021-04-10T08:04:48.749322Z",
            "url": "https://files.pythonhosted.org/packages/96/3c/5fe39f509a6813c75d9ddacc63ab709ea3a432d23a0c35e0c92674bc8011/oarepo-micro-api-3.3.62.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-04-10 08:04:48",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": null,
    "github_project": "oarepo",
    "error": "Could not fetch GitHub repository",
    "lcname": "oarepo-micro-api"
}
        
Elapsed time: 0.29699s