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

Uploaded Source

Built Distribution

oarepo_micro_api-3.3.76-py2.py3-none-any.whl (15.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for oarepo-micro-api-3.3.76.tar.gz
Algorithm Hash digest
SHA256 6df52e569af9f8a91f92722c957f444b89a1ce7a9431779d65cb397a7f93479b
MD5 78d73013c1e9f775bd8a6ea32e96ab32
BLAKE2b-256 83e57fac7d5a426c9cbd09c73b060aedc66e7538ad90cc0873a136039899c29b

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for oarepo_micro_api-3.3.76-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 fea8667cf6beb4ba5969c1ddca1b9c8efb04eb5a2204942cb79f7d0a05e45714
MD5 fce9e13eccfb0ec35f18b408adcf1026
BLAKE2b-256 aa4f5aeda73e5e4e33700f2a2948e5c455d9e93463b384ee9a76c8efe6456fb7

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