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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

oarepo_micro_api-3.3.39-py2.py3-none-any.whl (8.8 kB view details)

Uploaded Python 2Python 3

File details

Details for the file oarepo-micro-api-3.3.39.tar.gz.

File metadata

  • Download URL: oarepo-micro-api-3.3.39.tar.gz
  • Upload date:
  • Size: 12.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/51.1.2 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7

File hashes

Hashes for oarepo-micro-api-3.3.39.tar.gz
Algorithm Hash digest
SHA256 4337b326fb476bbd9f0951a58579786d3dbebcd3e3f491bf99383bcacaf4a4fb
MD5 84ca9206fabfd0dfecc3000baf2fb5bb
BLAKE2b-256 d4c28199f1ffc2d494155277433b95f6ed9d9bf4be2fb40cd45d5e003c78d5e9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: oarepo_micro_api-3.3.39-py2.py3-none-any.whl
  • Upload date:
  • Size: 8.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/51.1.2 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7

File hashes

Hashes for oarepo_micro_api-3.3.39-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1c334ec2b09749f96ba06707a68f5237a4dcade9a18e493012dee02f1054247a
MD5 98cd9bc6523c3158fa5572dbe06a546a
BLAKE2b-256 6ccb6c4d7e01fdfc7dfefa9b7fce58c570f73384864af585b0f41b7b737ca2c0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page