OARepo REST API microservice
Project description
OARepo Micro API
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:
# setup.py
#...
install_requires = [
'oarepo[micro-api,...another-oarepo-extras]'
]
#...
otherwise:
# 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 file for details
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for oarepo_micro_api-3.3.19-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1f3ef5fefd6876e2f46f7bfd822d46dbafb806802646cfcb17e9f8ba2ef0a0e0 |
|
MD5 | 386b308d27c07a1f3396a66dc0d18e68 |
|
BLAKE2b-256 | 0ea987d8b006e5b9b91173e3dce16f875fbb26a6b36b17ea6d55915e3e7cf49f |