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

Uploaded Source

Built Distribution

oarepo_micro_api-3.3.114-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.114.tar.gz.

File metadata

  • Download URL: oarepo-micro-api-3.3.114.tar.gz
  • Upload date:
  • Size: 14.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for oarepo-micro-api-3.3.114.tar.gz
Algorithm Hash digest
SHA256 0eebecf43a494d758f05624d29d211d89eb4a88e4d98fcb2a36a381e73e8e07d
MD5 d19e1cf799bf6e712ace0bad4c52bbc3
BLAKE2b-256 3c1f2d07f3b49241f622a0f8002275cf460d78dbb9687af48758a8b2b74a7dc5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: oarepo_micro_api-3.3.114-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.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for oarepo_micro_api-3.3.114-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4abde9d3fbc57bf65b5f7749e3ad7666a5cf10d76520aeecd123bca9ef0e10f9
MD5 be469651d0a22e16d7b70c36e5076eb1
BLAKE2b-256 d2c3075d07887a84c2504fd2dcf2d1e9a3e87c309b27b8c2127607b5984741f2

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