# 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/a4/e5/7e0d722577be48f7c14ffaf4b53a46dea3e81e5655238763e7d65e1653bb/oarepo-micro-api-3.5.67.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",
"bugtrack_url": null,
"license": "MIT",
"summary": "OARepo REST API microservice",
"version": "3.5.67",
"split_keywords": [
"oarepo-micro-api",
"invenio"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ed244e56c52dd85aae06a8224cc60b33cb2328c892d7ced00304c92bcd300ead",
"md5": "cfb7221b6da10342a2de135ac39673fe",
"sha256": "d4a098a37c270164cce62435b7d1c232fcd35652af3870afb4a3f066aac67970"
},
"downloads": -1,
"filename": "oarepo_micro_api-3.5.67-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "cfb7221b6da10342a2de135ac39673fe",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 15185,
"upload_time": "2023-01-28T08:07:58",
"upload_time_iso_8601": "2023-01-28T08:07:58.303995Z",
"url": "https://files.pythonhosted.org/packages/ed/24/4e56c52dd85aae06a8224cc60b33cb2328c892d7ced00304c92bcd300ead/oarepo_micro_api-3.5.67-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a4e57e0d722577be48f7c14ffaf4b53a46dea3e81e5655238763e7d65e1653bb",
"md5": "a8449c81fdd10b64a2c6ed5169702b70",
"sha256": "d4bc86eb4bdadd2f5752e04adf37d590f89e7e8e25b2ac7823bdf0550b0f5adf"
},
"downloads": -1,
"filename": "oarepo-micro-api-3.5.67.tar.gz",
"has_sig": false,
"md5_digest": "a8449c81fdd10b64a2c6ed5169702b70",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 14704,
"upload_time": "2023-01-28T08:08:01",
"upload_time_iso_8601": "2023-01-28T08:08:01.192911Z",
"url": "https://files.pythonhosted.org/packages/a4/e5/7e0d722577be48f7c14ffaf4b53a46dea3e81e5655238763e7d65e1653bb/oarepo-micro-api-3.5.67.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-28 08:08:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "oarepo",
"github_project": "oarepo-micro-api",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"lcname": "oarepo-micro-api"
}
JSON
