Skip to main content

Minimal SQuaRE API wrapper for status.lsst.codes

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 `status.lsst.codes`; 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-status-0.0.8.tar.gz (3.5 kB view details)

Uploaded Source

Built Distribution

sqre_uservice_status-0.0.8-py2.py3-none-any.whl (4.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file sqre-uservice-status-0.0.8.tar.gz.

File metadata

File hashes

Hashes for sqre-uservice-status-0.0.8.tar.gz
Algorithm Hash digest
SHA256 d0c92f6be4ed38abe6077931fef8ee4bb1664d5267164a869eb64ad837436869
MD5 622e91c3d2c6a00acdbc901bdb4b083b
BLAKE2b-256 9354e2215c4c3235f6b0e1c4ec57b76ea50ff63a87c0cd05a406667f699800e8

See more details on using hashes here.

File details

Details for the file sqre_uservice_status-0.0.8-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for sqre_uservice_status-0.0.8-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c184fbbb5b05db5650462db33fcd42e6d424a72354c54727607b75ff0ba8f242
MD5 bf92cfcb5a51bcf57394250238085692
BLAKE2b-256 65a521c7c143155cbfcb62580a49d72507b4f6e5db2c615858e10e1081b90890

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