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-status

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

Uploaded Source

Built Distribution

sqre_uservice_metricdeviation-0.0.1-py2.py3-none-any.whl (6.2 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for sqre-uservice-metricdeviation-0.0.1.tar.gz
Algorithm Hash digest
SHA256 06abf04f60e859e3611270353cb98966c1f1852a90f83370cbb19d0a318e0a93
MD5 d048b8b701a585f04316fd6c043c3237
BLAKE2b-256 f5bdfee172536d4469929294db383f32a6c81a719c689c309d02ae01d156cea3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sqre_uservice_metricdeviation-0.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c3a0135a93289769ec57c408882d3ca1878d7136dd4befaedeea3e1b792206ad
MD5 993126e0fa66151ddc53ae3f09a08cbb
BLAKE2b-256 7e35d15a5e132e64fa47eaa1a72cf9aa0a26bd11698678f4cf613cb5c50d0e78

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