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

Uploaded Source

Built Distribution

oarepo_micro_api-3.3.113-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.113.tar.gz.

File metadata

  • Download URL: oarepo-micro-api-3.3.113.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.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.8

File hashes

Hashes for oarepo-micro-api-3.3.113.tar.gz
Algorithm Hash digest
SHA256 33079ce9589bf03e52103f833e0c2ed563e1f0f927453dffed4762b40d519362
MD5 ca91c6307d5cdb7ffa5d5f6460577ed5
BLAKE2b-256 4f8dbbaee30120d1c167eabf5140383438a40b05244734e81f26ed74398fcad2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: oarepo_micro_api-3.3.113-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.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.8

File hashes

Hashes for oarepo_micro_api-3.3.113-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 53007ec788d9174f8a5c52006e548126aa032e7dc476e33aadde9a69fd746fbb
MD5 93c013775b0f30ffd1022cfed82a0fa3
BLAKE2b-256 0a04fe25836c4396bab7c59754c452f1a353ae9c6fc93fdf0413e213ffcc899e

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