NotebookAuth

class lsst_efd_client.NotebookAuth(service_endpoint='https://roundtable.lsst.codes/segwarides/')

Bases: object

Class to help keep authentication credentials secret.

Credentials can be retrieved either from a service endopint or from a file on disk. The credential location is checked in that order.

Parameters
service_endpointstr, optional

Endopint of the service to use for credentials. (https://roundtable.lsst.codes/segwarides/ by default)

Raises
RuntimeError

Raised if teh service returns a non-200 status code.

Methods Summary

get_auth(alias)

Return the credentials as a tuple

list_auth()

Return a list of possible credential aliases Returns ------- aliases : list A tuple of str that indicate valid aliases to use to retrieve credentials.

Methods Documentation

get_auth(alias)

Return the credentials as a tuple

Parameters
aliasstr

Name of the authenticator.

Returns
credentialstuple

A tuple containing the host name, user name, and password.

list_auth()

Return a list of possible credential aliases Returns ——- aliases : list

A tuple of str that indicate valid aliases to use to retrieve credentials.