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

Uploaded Source

Built Distribution

oarepo_micro_api-3.3.53-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.53.tar.gz.

File metadata

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

File hashes

Hashes for oarepo-micro-api-3.3.53.tar.gz
Algorithm Hash digest
SHA256 48e8817daeee6eb06ed5858662d71b27491f25193a1696b344a02d0ef854e11c
MD5 83dad7e65c56cdfb441f21c5b30fd216
BLAKE2b-256 a17cf176fc62922735e4395987f12bf4e5e7f4358a51a6564906621c2ff51bb3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: oarepo_micro_api-3.3.53-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/53.0.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for oarepo_micro_api-3.3.53-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 7ec62afd1601199a4f62305a3546358cb7b6fe189cc10a652e9e3a0a5c1f2e1c
MD5 25edc294299b02aabd62db507c99b0c4
BLAKE2b-256 f53be06a76ff118044107eff8d48e33609410731979a78fe7a3fb765f983b655

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