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

Uploaded Source

Built Distribution

oarepo_micro_api-3.3.54-py2.py3-none-any.whl (13.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: oarepo-micro-api-3.3.54.tar.gz
  • Upload date:
  • Size: 13.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/54.1.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for oarepo-micro-api-3.3.54.tar.gz
Algorithm Hash digest
SHA256 c3222c1c0d04137147840c8c56a9547b11a3b30f3457c664644f176f59a54af6
MD5 a6a2da0dd58ed9d6886fb0416f9fd21e
BLAKE2b-256 5bb21e5dbf145be05ff782015d16343240c904c5ddf093fe30a1fe93d1ba4482

See more details on using hashes here.

File details

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

File metadata

  • Download URL: oarepo_micro_api-3.3.54-py2.py3-none-any.whl
  • Upload date:
  • Size: 13.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/54.1.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for oarepo_micro_api-3.3.54-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 2c94506df94d58361cbd25ff9f79ef025b82fed35f471fcae33d5d6ce8c7b82c
MD5 4cde99e068f4e6662950a25a25283acb
BLAKE2b-256 1276ba6a650a585f2aae0597eb91c5405d1a407b19bb7ed27581f7b4dc1d285d

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