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

Uploaded Source

Built Distribution

oarepo_micro_api-3.3.52-py2.py3-none-any.whl (13.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: oarepo-micro-api-3.3.52.tar.gz
  • Upload date:
  • Size: 13.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for oarepo-micro-api-3.3.52.tar.gz
Algorithm Hash digest
SHA256 96dc65fb20c84fea4f1d3d8e7ea7e3cd01ad15fa426789b999763b7c64d5d865
MD5 892b035ed9eb2324037e954cb613a5a8
BLAKE2b-256 e467c3bb2c88193fc6d897ba88c63f0e5888b7ab656c5a7a821282747cc12f94

See more details on using hashes here.

File details

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

File metadata

  • Download URL: oarepo_micro_api-3.3.52-py2.py3-none-any.whl
  • Upload date:
  • Size: 13.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for oarepo_micro_api-3.3.52-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 81e04a6b9da443a979718c9e2726d77a8bfa971771d743feba711f30646020e1
MD5 f04ce8f1c10a36babdebb4a066a4032e
BLAKE2b-256 40a8dc0bb3c81492838ce79d962798bf396cc04abb225fe8f965c173ae526ef1

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