NotebookAuth#

class lsst_efd_client.NotebookAuth(service_endpoint='https://roundtable.lsst.codes/segwarides/', *, token=None, discovery_v1_path=None)#

Class to help keep authentication credentials secret.

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

Parameters:

service_endpoint (str, optional) – Endopint of the service to use for credentials. (https://roundtable.lsst.codes/segwarides/ by default)
token (str, optional) – If provided, a Gafaelfawr token to use when requesting InfluxDB credentials. This need not be provided when running inside a Nublado container, where the notebook token will be used, but may be needed in other contexts.
discovery_v1_path (pathlib.Path, optional) – If provided, override the path to the Repertoire discovery information. This argument is only for testing and should not normally be used. The default behavior uses the normal Nublado path for this information.

Raises:

RuntimeError – Raised if the 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

Methods Documentation

get_auth(alias)#

Return the credentials as a tuple

Parameters:: alias (str) – Name of the authenticator.
Returns:: credentials – A tuple containing the host name, schema registry, port, username, password and path.
Return type:: tuple

list_auth()#

Return a list of possible credential aliases

Returns:: aliases – A tuple of str that indicate valid aliases to use to retrieve credentials.
Return type:: list