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

Uploaded Source

Built Distribution

sqre_uservice_metricdeviation-0.0.5-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.5.tar.gz.

File metadata

File hashes

Hashes for sqre-uservice-metricdeviation-0.0.5.tar.gz
Algorithm Hash digest
SHA256 50815dd7c744f87936121b888710178bd2a6bbd97fd232ca8c1185babed83414
MD5 7b49ae739ff2771f6ee56ca8d4d86517
BLAKE2b-256 8a67bc070c6e32f0b35133666154dc4d439e8a7f95ebdc3efd9af2204fdaf891

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sqre_uservice_metricdeviation-0.0.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 bebb11470b376ab649522bd3baaad43c0dea316e46731e45b1c5998ae2ab7c45
MD5 880b3751cf8ad67958fa6b56b71568c1
BLAKE2b-256 afb4e056ed9d2e5bc98a3027233c49f81cf15e8939a4ed5de23daeb2d897b1c3

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