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

Uploaded Source

Built Distribution

oarepo_micro_api-3.3.117-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.117.tar.gz.

File metadata

  • Download URL: oarepo-micro-api-3.3.117.tar.gz
  • Upload date:
  • Size: 14.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for oarepo-micro-api-3.3.117.tar.gz
Algorithm Hash digest
SHA256 3777a1475c31a80e0ab3fff4e6da9f6cf8f0613e415e93417b6db7d92a70ad1e
MD5 13e247f20beb17f9d7762bb6a49c0707
BLAKE2b-256 a47bd78faab693c9857a161bdfac5dd014813a1491dc3b920c02732e2c78ac81

See more details on using hashes here.

File details

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

File metadata

  • Download URL: oarepo_micro_api-3.3.117-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.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for oarepo_micro_api-3.3.117-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9229fdc32d1236643be41a03a241e07e755225035bd6a9618b1a5efab0c27301
MD5 8d5291ea739f2eea34e976239e9dd06c
BLAKE2b-256 e0997335956c564fb17f808d1ec7ccd38eafe17391d810c1721463bd3c38cbb3

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