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

Uploaded Source

Built Distribution

oarepo_micro_api-3.3.91-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.91.tar.gz.

File metadata

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

File hashes

Hashes for oarepo-micro-api-3.3.91.tar.gz
Algorithm Hash digest
SHA256 78292d2e5bc07fbf38b74fdaba36289fe3054089d86ab79b1e24051567cf086a
MD5 7592b5919869d87b6df5e6ec5e1ed8f4
BLAKE2b-256 c1e816dfbce618c9cd48f9398f044719607f7b1fd8e55d961419fc070ac66c1d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: oarepo_micro_api-3.3.91-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.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.1 CPython/3.9.6

File hashes

Hashes for oarepo_micro_api-3.3.91-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 025d4504665f1c3b2c7e034f54d2a367820238f6aa7a891a5d9c1473e742de31
MD5 08dbd99db3c817fab283fc7c96c66891
BLAKE2b-256 9816ac068c79991d8fd8465ccb2903fdeac83c935c1a1c4cb060a116f28a2c7b

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