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

Uploaded Source

Built Distribution

oarepo_micro_api-3.5.14-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.5.14.tar.gz.

File metadata

  • Download URL: oarepo-micro-api-3.5.14.tar.gz
  • Upload date:
  • Size: 14.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for oarepo-micro-api-3.5.14.tar.gz
Algorithm Hash digest
SHA256 fcef4cf1882e4bd426336ce7ff588e595975c37f0f3417042f0544bcfb7cfdd0
MD5 de62a172284c376d641fa8bb06f409ba
BLAKE2b-256 7c1c03b2ad94b2e628962e487aa7738d9712d4d69acf9d10a646d12ec761478d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: oarepo_micro_api-3.5.14-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.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for oarepo_micro_api-3.5.14-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f83572f8cec3c497e94a241dd698f8c00e660b590d84578beaf9dcd7eb00e206
MD5 bfe823e9d88c469ed7c29f68b7bc54ed
BLAKE2b-256 74401a92eea9586c84afd05bff1770b2e960d7f53e5b6fd0ba8a85d65c5e12a9

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