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

Uploaded Source

Built Distribution

oarepo_micro_api-3.5.6-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.6.tar.gz.

File metadata

  • Download URL: oarepo-micro-api-3.5.6.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.6.tar.gz
Algorithm Hash digest
SHA256 b112468d5c10ef6d88fa8e1364b8d42ef9e028b4488724a6f7687b89efda349b
MD5 3b8343f399148661c123cf806ebcf682
BLAKE2b-256 4d1087f880c6d512c0bffb7ad6fc21e42d6a63455cf0ec6de66aebe96966736e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: oarepo_micro_api-3.5.6-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.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6479596b6d4c54c6edba75bc3e60ded31a37ed7d227f60bf1b2ecf34f23313cd
MD5 ce1a617c860a08a5cf940d3d2314c26b
BLAKE2b-256 c90d4fd66872407e681c9dd9eac72b55e87a896167ed6a119300b0477e363d0f

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