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

Uploaded Source

Built Distribution

oarepo_micro_api-3.3.139-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.139.tar.gz.

File metadata

  • Download URL: oarepo-micro-api-3.3.139.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.8 tqdm/4.63.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for oarepo-micro-api-3.3.139.tar.gz
Algorithm Hash digest
SHA256 5772c3f5a516d919063aecae42be82df9c3adcc4e065c660c60d7248793cee21
MD5 2fb15bcee3f13d8c93a789ca8fcd6261
BLAKE2b-256 5a281c677db66f744c461f45b5ff844cfa186a6abb705f2c8c7fe8e7b307ee03

See more details on using hashes here.

File details

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

File metadata

  • Download URL: oarepo_micro_api-3.3.139-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.8 tqdm/4.63.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for oarepo_micro_api-3.3.139-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d513754cea2cd3232eef4fc23c35b6b637183bf0d2750a5984618618d9a5e0a0
MD5 6378b0958449efd7193a0ebfe0a57e1e
BLAKE2b-256 836d113980762b93375e3327d3db4b124d7272311e4158b04e14fc103d2098f3

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