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

Uploaded Source

Built Distribution

oarepo_micro_api-3.3.141-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.3.141.tar.gz.

File metadata

  • Download URL: oarepo-micro-api-3.3.141.tar.gz
  • Upload date:
  • Size: 14.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.1 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.12

File hashes

Hashes for oarepo-micro-api-3.3.141.tar.gz
Algorithm Hash digest
SHA256 c207642b8ecf0daa2d39976b86613e81aa6ed0c176611f3c268a0419c2cf0540
MD5 c34707a0fa5a1279587ec7e5b6576b5a
BLAKE2b-256 4a16f71fdff1d0dde3c68a2abc9f21a4907ec7eafc5c713160ec190cc89d66ce

See more details on using hashes here.

File details

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

File metadata

  • Download URL: oarepo_micro_api-3.3.141-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.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.1 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.12

File hashes

Hashes for oarepo_micro_api-3.3.141-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d8650bc88019e6b13fea1bfc656db2b9c72cfa4f37722af9606ca32a6b0123a9
MD5 15595f18c7fe2ced4fcac527bfe1cb6e
BLAKE2b-256 65929dc45e3b60e8b18230449b2e211a6f25c3fe2b3e9bde8776019870c756c2

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