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

Uploaded Source

Built Distribution

oarepo_micro_api-3.3.82-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.82.tar.gz.

File metadata

  • Download URL: oarepo-micro-api-3.3.82.tar.gz
  • Upload date:
  • Size: 14.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for oarepo-micro-api-3.3.82.tar.gz
Algorithm Hash digest
SHA256 01f9c8daa45a2c2a37e0a032ceab34ddfe1a85f2bc700e1dfe4625b3c5573e9a
MD5 5eca3150f678e6bbc26262f57b493cae
BLAKE2b-256 489eccd6805b25a0cd60aff0879b452c9d02e5b04135c4dfd415ce9153d649bb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: oarepo_micro_api-3.3.82-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.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for oarepo_micro_api-3.3.82-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e84cd59550a33553b8243327e27289fc9761e6820993a5e1fba9222e2bfa7c47
MD5 ae9f2037a0e4f53c768d41557a6d920d
BLAKE2b-256 013029ee1afc0dc310ba0e1b46bce94b2e652e16d6a0db6abf4d12201e06cb7c

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