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

Uploaded Source

Built Distribution

oarepo_micro_api-3.3.83-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.83.tar.gz.

File metadata

  • Download URL: oarepo-micro-api-3.3.83.tar.gz
  • Upload date:
  • Size: 14.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for oarepo-micro-api-3.3.83.tar.gz
Algorithm Hash digest
SHA256 9b609fe0a17b4f1bbe2bbfe466d5611a755eb062379da0df4e90c751d1399c80
MD5 bf7e6022ab2c64a5a9f0491f8f37b5f2
BLAKE2b-256 6707779c762944dd4e8631c8b65055fb4e064699affb9d56bf0ee66ffed71f16

See more details on using hashes here.

File details

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

File metadata

  • Download URL: oarepo_micro_api-3.3.83-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.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for oarepo_micro_api-3.3.83-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6d01f94eff75968a375dc701f9ce7f949e9914f21d7a3db692d2afeeb02a0d4c
MD5 43b677c0fdbb9667fcd767ce39ea1866
BLAKE2b-256 56fc3a8b3580f0dfaf0d7380f08566a7e49a2daf9988f78e19a501fd94d12935

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