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

Uploaded Source

Built Distribution

oarepo_micro_api-3.3.73-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.73.tar.gz.

File metadata

  • Download URL: oarepo-micro-api-3.3.73.tar.gz
  • Upload date:
  • Size: 14.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.3.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5

File hashes

Hashes for oarepo-micro-api-3.3.73.tar.gz
Algorithm Hash digest
SHA256 0efc30b51bfd25857c33dd015372e5198e3845f02717e3ad7950b7135c52d702
MD5 bf9cab910cb88f978048f79b3d11927b
BLAKE2b-256 fa8039fd27d4708d6953c88498355466150d592889d4361f6cb435899210281c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: oarepo_micro_api-3.3.73-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.3.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5

File hashes

Hashes for oarepo_micro_api-3.3.73-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9289e562a960a008bfc637cbfbc590cc5ee60e9a51c02aa3abbe59f40174e436
MD5 a9823df73aea9c90fbf708f6bb0322f5
BLAKE2b-256 666a2c06f162b010841d7f8af6d6eee7ebcd1e168c9bdb0966682943602ec799

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