pyastroapi.api.token

Module Contents

Functions

get_token(→ Union[str, None])	Get a user's ADS token
save_token(→ None)	Save a users ADS token
get_orcid(→ Union[str, None])	Get a user's ORCID
save_orcid(→ None)	Save a user's ORCID

pyastroapi.api.token.get_token(filename: str = '~/.ads/dev_key') → str | None

Get a user’s ADS token

First looks for the environment variable ADS_DEV_KEY then looks in filename

Parameters:

filename (str, optional) – Filename to read token from. Defaults to “~/.ads/dev_key”.

Returns:

ADS token

Return type:

t.Union[str, None]

pyastroapi.api.token.save_token(token: str, filename: str = '~/.ads/dev_key') → None

Save a users ADS token

Parameters:

filename (str, optional) – Filename to save token to. Defaults to “~/.ads/dev_key”.

pyastroapi.api.token.get_orcid(filename: str = '~/.ads/orcid') → str | None

Get a user’s ORCID

Parameters:

filename (str, optional) – Filename to read token from. Defaults to “~/.ads/orcid”.

Returns:

ORCID

Return type:

t.Union[str, None]

pyastroapi.api.token.save_orcid(token: str, filename: str = '~/.ads/orcid') → None

Save a user’s ORCID

Parameters:

filename (str, optional) – Filename to save the ORCID to. Defaults to “~/.ads/orcid”.