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

Uploaded Source

Built Distribution

oarepo_micro_api-3.5.5-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.5.tar.gz.

File metadata

  • Download URL: oarepo-micro-api-3.5.5.tar.gz
  • Upload date:
  • Size: 14.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.10

File hashes

Hashes for oarepo-micro-api-3.5.5.tar.gz
Algorithm Hash digest
SHA256 8d59b8913ce87cb792ce701213f991a059bce8650f2fc70bb157b4c27cca01b6
MD5 be26c94c2a1ee9155a37477c8b0da11e
BLAKE2b-256 97fa8ded888eb5ad5e7d5618ccf93a2decb5e7285e7d965c360ae281e679e568

See more details on using hashes here.

File details

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

File metadata

  • Download URL: oarepo_micro_api-3.5.5-py2.py3-none-any.whl
  • Upload date:
  • Size: 15.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.10

File hashes

Hashes for oarepo_micro_api-3.5.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9f488c54785cc3118734db0d9c18fc4b3f4e179de22a353188b95442afb70a1b
MD5 75dd1a4d013a0c39e7dde2d8f9b55c8d
BLAKE2b-256 1a42b1916adb01018cf9cd4b76e9b9d08adb1dcf385845b01aa8d9c243ac52b1

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