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

Uploaded Source

Built Distribution

oarepo_micro_api-3.3.88-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.88.tar.gz.

File metadata

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

File hashes

Hashes for oarepo-micro-api-3.3.88.tar.gz
Algorithm Hash digest
SHA256 4a1e03a9d10b9ae9eb37ad08a184692bae8411769c2b984356ec003b2474d530
MD5 8729a3dcf416b3aedd447a8ab0ca566d
BLAKE2b-256 b07c9b019c834e5761298bf0d1a086bde9e237d68f7f786a214dfc7d8a735089

See more details on using hashes here.

File details

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

File metadata

  • Download URL: oarepo_micro_api-3.3.88-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.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.6

File hashes

Hashes for oarepo_micro_api-3.3.88-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 119069a257d7815769596b4b0e3b61b8aecc290293beb6ed96aff30bbef9184d
MD5 4914a5ca9528918f31c21f1daa594099
BLAKE2b-256 ee2c56885162e85d2c6232abfa2eb68e0a8605c0c28a0ddbecdec393606cb20c

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