# OARepo Micro API
[](https://travis-ci.org/oarepo/oarepo-micro-api)
[](https://coveralls.io/r/oarepo/oarepo-micro-api)
[](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/81/d8/be0c66be67d7c793356481a1be9a77d09c7fd5a3591e9f268a36828575d1/oarepo-micro-api-3.3.34.tar.gz",
"platform": "any",
"description": "# OARepo Micro API\n\n[](https://travis-ci.org/oarepo/oarepo-micro-api)\n[](https://coveralls.io/r/oarepo/oarepo-micro-api)\n[](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.34",
"split_keywords": [
"oarepo-micro-api",
"invenio"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "71c7d1e7c14a7744cf2ee663146213a2",
"sha256": "59b0bae806b023775b9d1f359bebafd0467a06b95e17faffb67cbaa437a47d24"
},
"downloads": -1,
"filename": "oarepo_micro_api-3.3.34-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "71c7d1e7c14a7744cf2ee663146213a2",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 8068,
"upload_time": "2021-01-09T08:22:05",
"upload_time_iso_8601": "2021-01-09T08:22:05.533165Z",
"url": "https://files.pythonhosted.org/packages/56/b4/566f6ab49c5cb4b3c8003732e4930098df5578146ace4f59ef0cc9101122/oarepo_micro_api-3.3.34-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "1200bc9756ac4ec5169884d484609d99",
"sha256": "dbd183761dd346d1cf4ba0513231f88e563ef750a8128eff759330fd949c0f2e"
},
"downloads": -1,
"filename": "oarepo-micro-api-3.3.34.tar.gz",
"has_sig": false,
"md5_digest": "1200bc9756ac4ec5169884d484609d99",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 11779,
"upload_time": "2021-01-09T08:22:06",
"upload_time_iso_8601": "2021-01-09T08:22:06.673936Z",
"url": "https://files.pythonhosted.org/packages/81/d8/be0c66be67d7c793356481a1be9a77d09c7fd5a3591e9f268a36828575d1/oarepo-micro-api-3.3.34.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2021-01-09 08:22:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": null,
"github_project": "oarepo",
"error": "Could not fetch GitHub repository",
"lcname": "oarepo-micro-api"
}
JSON
