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

Uploaded Source

Built Distribution

oarepo_micro_api-3.3.69-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.69.tar.gz.

File metadata

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

File hashes

Hashes for oarepo-micro-api-3.3.69.tar.gz
Algorithm Hash digest
SHA256 4a218c63f4354f7d7577c4cb57a94942e25facda82aea2a2220fe6a79af94e29
MD5 4c0dacbacb03c5c4032fa564e21e1296
BLAKE2b-256 54ce4bdc74091182685960f875b7dba468ef38baaee504d0d725aab7cd1b45cd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: oarepo_micro_api-3.3.69-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.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5

File hashes

Hashes for oarepo_micro_api-3.3.69-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 2ca2236be5eaa6043a1768d5f88dd1ea717f56906b85da38ec508b4ace09c208
MD5 1e75e5cc4b836e719b2c6cc41e2db2fe
BLAKE2b-256 22d73e26beebe7b1eb58e89f1d3f19bb48cea2a1cb712787ad71947a5d24a3a6

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