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

Uploaded Source

Built Distribution

oarepo_micro_api-3.3.104-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.3.104.tar.gz.

File metadata

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

File hashes

Hashes for oarepo-micro-api-3.3.104.tar.gz
Algorithm Hash digest
SHA256 5b31737cf150106e0c076e98436d5217e524118a546e0b779eb7304636e03b21
MD5 5b6de6a6ad7978f3a24edb8d5b2fff4f
BLAKE2b-256 c05573d56543b896972291604d76837849abe3203b3e293558fb0b191e1c110d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: oarepo_micro_api-3.3.104-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.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for oarepo_micro_api-3.3.104-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0ef2f10e9d90a89b4c633f50192fd5265109dd3bfaf846ae636b45905f37cf30
MD5 711449d7f5eeccb768b8f182fef1c812
BLAKE2b-256 ba57e455df2e68e2afece8c2308fd95b80a5f67b1e9a3fdcbf9c6bd3d627ef0a

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