Skip to main content
[![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.


Metadata

Release files for sqre-uservice-status 0.0.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sqre-uservice-status 0.0.8
File Size Uploaded
sqre-uservice-status-0.0.8.tar.gz 3.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for sqre-uservice-status 0.0.8
File Interpreter ABI Platform
sqre_uservice_status-0.0.8-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 8.4 kB

Release files / sqre-uservice-status-0.0.8.tar.gz

Download URL sqre-uservice-status-0.0.8.tar.gz
Size 3.5 kB
Tags Source
SHA-256 checksum
How to use checksums
d0c92f6be4ed38abe6077931fef8ee4bb1664d5267164a869eb64ad837436869
BLAKE2b-256 checksum
How to use checksums
9354e2215c4c3235f6b0e1c4ec57b76ea50ff63a87c0cd05a406667f699800e8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / sqre_uservice_status-0.0.8-py2.py3-none-any.whl

Download URL sqre_uservice_status-0.0.8-py2.py3-none-any.whl
Size 4.9 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
c184fbbb5b05db5650462db33fcd42e6d424a72354c54727607b75ff0ba8f242
BLAKE2b-256 checksum
How to use checksums
65a521c7c143155cbfcb62580a49d72507b4f6e5db2c615858e10e1081b90890
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.0.8 This release

2 release files

0.0.7

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page