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

Uploaded Source

Built Distribution

oarepo_micro_api-3.5.4-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.4.tar.gz.

File metadata

  • Download URL: oarepo-micro-api-3.5.4.tar.gz
  • Upload date:
  • Size: 14.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.10

File hashes

Hashes for oarepo-micro-api-3.5.4.tar.gz
Algorithm Hash digest
SHA256 48fc563d771c75f60ae7f2808b4ffd6c9007d3eb1e04fddc8932ed0c79676471
MD5 e6dae3ffa6a3705070a9f9c213ed9ca3
BLAKE2b-256 2802a3b08cc0be3e5e20de3cd88e351e8e5a758ebe20bedb7fc66ec08f5cea0a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: oarepo_micro_api-3.5.4-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.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.10

File hashes

Hashes for oarepo_micro_api-3.5.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9033499cc19cdb21322d0301bb3a2f3d1e7e87f539b87d1963b8dbdc62776e68
MD5 b5a88fbe5f11fe18105f738557e3e9a0
BLAKE2b-256 3ef62fa11c255122d7cbccd5c861eb2ea5dd146060bf750aa0a8c9fa6d61f5b4

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