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.9-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3e3a4719d92afabbc09c3c8f77267b116b84a35b0b6b27333234727ff89ceaf9 |
|
MD5 | 672a19fce9f8df4a32e5d3d17fa2a4eb |
|
BLAKE2b-256 | d07d20aeb32a5bc1720adf2c279f9a4ecc3c6541eb468f454bbb4e966e9348f7 |