Skip to main content

Minimal SQuaRE API wrapper for QA metrics

Project description

[![Build Status](https://travis-ci.org/lsst-sqre/sqre-apikit.svg?branch=master)](https://travis-ci.org/lsst-sqre/sqre-apikit)

# sqre-uservice-metricdeviation

LSST DM SQuaRE microservice wrapper for QA metrics; more
generally, a minimal viable example for how to use the `apikit`
interfaces to create a SQuaRE-compliant microservice.

## Usage

Create a Flask app (preferably using :class:`apikit.APIFlask`). If you
have used `APIFlask`, it will already have a metadata route (but if you
are using Kubernetes ingress, you will want to specify the additional
route behind api.lsst.codes (or wherever) as one of the arguments to
route.

Hook your app up with whatever authenticator to Github it needs (if
any), and whatever secrets the authenticator requires.

If you're planning on hosting in a container via Kubernetes, create a
service and a deployment for it (look in `kubernetes`), and then if you
are standing up the front end too, set up an ingress with TLS
certificate and key. If one already exists (e.g. `api.lsst.codes`) you
just need to add a path to the existing ingress.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sqre-uservice-metricdeviation-0.0.3.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

sqre_uservice_metricdeviation-0.0.3-py2.py3-none-any.whl (6.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file sqre-uservice-metricdeviation-0.0.3.tar.gz.

File metadata

File hashes

Hashes for sqre-uservice-metricdeviation-0.0.3.tar.gz
Algorithm Hash digest
SHA256 005f841ce461e6981ae408f7a21cbe2e36ad904a137183cc1923a3a1c81ea994
MD5 14a04babc5fbc10660ec7b731437c896
BLAKE2b-256 1656c48711874dca6f4b0c7a310f184e60348d04d3f200ab4dd4033dee0a625d

See more details on using hashes here.

File details

Details for the file sqre_uservice_metricdeviation-0.0.3-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for sqre_uservice_metricdeviation-0.0.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f1898f80980401192f50ef1c789a2715abb4a00914212b310968555f094d6ae6
MD5 cb2d43b3441f89d3a72e7a9ebcebf435
BLAKE2b-256 a536788d37d9712bd7548512399f92eeea685f5b3c885d6ccaabe0081ead0c94

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