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

Uploaded Source

Built Distribution

oarepo_micro_api-3.3.62-py2.py3-none-any.whl (14.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file oarepo-micro-api-3.3.62.tar.gz.

File metadata

  • Download URL: oarepo-micro-api-3.3.62.tar.gz
  • Upload date:
  • Size: 14.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4

File hashes

Hashes for oarepo-micro-api-3.3.62.tar.gz
Algorithm Hash digest
SHA256 a35287075b8de3cf1105c871501e0a7bccee617a965cac7485698ab3cde2365b
MD5 f383922e08fbf0cd30c6cec7bf328609
BLAKE2b-256 963c5fe39f509a6813c75d9ddacc63ab709ea3a432d23a0c35e0c92674bc8011

See more details on using hashes here.

File details

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

File metadata

  • Download URL: oarepo_micro_api-3.3.62-py2.py3-none-any.whl
  • Upload date:
  • Size: 14.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4

File hashes

Hashes for oarepo_micro_api-3.3.62-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 2a98cc73c5bb8e608eec50d9d2c45d7eaa303a9637175c0dffc59a06b7abc3f9
MD5 41d5f31a1f0f9c330f04baa1fd1959c0
BLAKE2b-256 6ec5678acdf735419ec74e2a40266cff30d1b062c5ce0f261671f25c4ea29950

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