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

Uploaded Source

Built Distribution

sqre_uservice_metricdeviation-0.0.4-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.4.tar.gz.

File metadata

File hashes

Hashes for sqre-uservice-metricdeviation-0.0.4.tar.gz
Algorithm Hash digest
SHA256 24fee4d31ed7991201818ea53a153c91091395eff9f6ef9e273b3cf48c84610e
MD5 e893f06586b264b51724c928821c45fb
BLAKE2b-256 0fed9439e5e41cefb1bfd3c51073c11e25b539d307f2c8ed99b103dc62a36cf5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sqre_uservice_metricdeviation-0.0.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1ae4a2c15ace33f496a5c7b8cd3d885f3c03e10e39c5f0ed01dffdac8f5f6775
MD5 31c3b105667271c724fd693474135289
BLAKE2b-256 9a1235e2445fbb4e653677e7d0a82833955613edd48626511d70ff00d90ab259

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