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

Uploaded Source

Built Distribution

oarepo_micro_api-3.3.93-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.93.tar.gz.

File metadata

  • Download URL: oarepo-micro-api-3.3.93.tar.gz
  • Upload date:
  • Size: 14.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.7

File hashes

Hashes for oarepo-micro-api-3.3.93.tar.gz
Algorithm Hash digest
SHA256 a3065b8ce790583803da35a8e268ea2fba77c21b3dd25807ca4ca735418bd10b
MD5 164ca126468254f003ab7cdc5b6220d7
BLAKE2b-256 5e7a8685421b4e6b3468ae6554ffa02b83a7e8e3e5eec7d5f5dcbdc220ec5f1e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: oarepo_micro_api-3.3.93-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.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.7

File hashes

Hashes for oarepo_micro_api-3.3.93-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4bc6cf2a2fe20e644998264eddb790d7dad5ea398412359bd411a61937062998
MD5 60e5e8eb86bfaaeb4c6d6574acedc534
BLAKE2b-256 454da161a622ea69b5c4db639c83727d6bf96b7532640aa1f694c4cc0772c0e5

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