Skip to main content

OARepo REST API microservice

Project description

OARepo Micro API

image image image

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

oarepo-micro-api-3.3.99.tar.gz (14.5 kB view details)

Uploaded Source

Built Distribution

oarepo_micro_api-3.3.99-py2.py3-none-any.whl (15.1 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file oarepo-micro-api-3.3.99.tar.gz.

File metadata

  • Download URL: oarepo-micro-api-3.3.99.tar.gz
  • Upload date:
  • Size: 14.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for oarepo-micro-api-3.3.99.tar.gz
Algorithm Hash digest
SHA256 1fa98c78da188b90954957362069657867c824fcb0eb2070518461f957ee8504
MD5 74de169a03ea62ae14a255c86f236ef1
BLAKE2b-256 8d99cc4063e2658b58df4fa36c083574b74912526a84e840fee258ce6e952efc

See more details on using hashes here.

File details

Details for the file oarepo_micro_api-3.3.99-py2.py3-none-any.whl.

File metadata

  • Download URL: oarepo_micro_api-3.3.99-py2.py3-none-any.whl
  • Upload date:
  • Size: 15.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for oarepo_micro_api-3.3.99-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1948cea32a8bd360269766111603361e74fec5ccb26ca6404c2c827c9d426630
MD5 ccc9bfe47a216ec35b86d8fdcdf96a2c
BLAKE2b-256 57b27f9760aa3eacdbe1a8f156bca8f7debcaf316be6fd5a77d6d9b3ca58d0cf

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page