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.5.43.tar.gz (14.7 kB view details)

Uploaded Source

Built Distribution

oarepo_micro_api-3.5.43-py2.py3-none-any.whl (15.2 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: oarepo-micro-api-3.5.43.tar.gz
  • Upload date:
  • Size: 14.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for oarepo-micro-api-3.5.43.tar.gz
Algorithm Hash digest
SHA256 d6370be0036b3bbce1aaf657c69f6c9c4b1b5dbe2c9c0c94c92b2e33e92313a5
MD5 db6f6a48e5d0fffaab8d6442af9b5ff9
BLAKE2b-256 abe628f9732e62356b04fcfca15c63b4bd1ba2565aeb77bf0cd3862fe91cab54

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for oarepo_micro_api-3.5.43-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 966e495d5d1cb16fbdf9a3146882335cd3d4c077a806b141256cf03a914d80ce
MD5 6ada33e28d9432f651339c964084a337
BLAKE2b-256 abbce0e72c4a7203571c8a434f2057cc7f3167209a980856c3dc47eb5b6c4c12

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