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

Uploaded Source

Built Distribution

oarepo_micro_api-3.3.86-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.86.tar.gz.

File metadata

  • Download URL: oarepo-micro-api-3.3.86.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.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.6

File hashes

Hashes for oarepo-micro-api-3.3.86.tar.gz
Algorithm Hash digest
SHA256 ec2eaef59ed6997b5dc0ed2a8585c4bc9fd5c3aff6790e27b241df763e384f79
MD5 248581c045b9c2274ac5235e4eae0519
BLAKE2b-256 c2d188bc980aaeeca9fa8123131480fd8095ba6e81093bb7731e9fd92b0aa4f0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: oarepo_micro_api-3.3.86-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.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.6

File hashes

Hashes for oarepo_micro_api-3.3.86-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6df87d8d9493cbaaf236780a217357d5fbef9fce1f53ef974d2ae6950b891758
MD5 5d6f53a39f78f4567ab09ca76bcf66fb
BLAKE2b-256 143a8d961c5d2b51665432f64159bdc5f4f61fa7a3182c82167597d359f790d2

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