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

Uploaded Source

Built Distribution

sqre_uservice_metricdeviation-0.0.2-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.2.tar.gz.

File metadata

File hashes

Hashes for sqre-uservice-metricdeviation-0.0.2.tar.gz
Algorithm Hash digest
SHA256 998ef45041f2954ea0d60b7324db05d916605e1f36d2d97d48e5b0079542f44d
MD5 7114825f0a5efe4dfe99bc77232ac40e
BLAKE2b-256 0d0437b91a0646c145ae1e58a5fc7c0fe2fbfdfc76fce5b823468412a3a543ef

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sqre_uservice_metricdeviation-0.0.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b912a4c3ccf542f856935d28d05e6c4ebbc39396184adaea03b3d43c323d9948
MD5 d0f718992fec4924fc1ac800f12bf12b
BLAKE2b-256 aeced930fccdd1d93814be26bfdc57f5a03714d2388a99eefe692db90a01dc1b

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