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

Uploaded Source

Built Distribution

oarepo_micro_api-3.3.135-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.135.tar.gz.

File metadata

  • Download URL: oarepo-micro-api-3.3.135.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/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 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.135.tar.gz
Algorithm Hash digest
SHA256 db358ded2dcf0a782ecdc0c33ea02c304bd10699c8d0994bcbc9744820a0106c
MD5 63055e7ba45c46305d31ee30cea361c4
BLAKE2b-256 35f997f47fa9e85bad0800bd055b39299a520ea839741d19d3eba0fcd2484869

See more details on using hashes here.

File details

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

File metadata

  • Download URL: oarepo_micro_api-3.3.135-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/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 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.135-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 db4a53aa19d0d2869ecdbd5716ed8094b6acc510bb5027a88d48f2761bcb81b4
MD5 a235b3e5ef07c3cf9d3b8116b4b34745
BLAKE2b-256 16bbd7439a215912cbf15a7631edfdff7324db4a7508bded1bbe51b778167e28

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