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

Uploaded Source

Built Distribution

oarepo_micro_api-3.3.75-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.75.tar.gz.

File metadata

  • Download URL: oarepo-micro-api-3.3.75.tar.gz
  • Upload date:
  • Size: 14.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5

File hashes

Hashes for oarepo-micro-api-3.3.75.tar.gz
Algorithm Hash digest
SHA256 3a3071e45212b55e5af4b1a1ca59c0985dc9cf0a29e9ef8275bb68622677342f
MD5 c8680373a6a3adf0d3d46c7813506c40
BLAKE2b-256 c8a413e6dc7be79ebbcd0cc272b36b678b4e672b6bc51c3f15b629b76baa8318

See more details on using hashes here.

File details

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

File metadata

  • Download URL: oarepo_micro_api-3.3.75-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.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5

File hashes

Hashes for oarepo_micro_api-3.3.75-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 630db813e1b9273202a41d3556fd55e9624446216c59cc35209a176974099615
MD5 5c56af119aec58031349e95c6626f8b8
BLAKE2b-256 fcfd82e3dfa7794313c3565e14712ae5c2df078140db5dbf99b22bd2d2637f2b

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