spherapy
module util.credentials
Functions to fetch and store spacetrack credentials on the system.
function fetchConfigCredentials
fetchConfigCredentials(config: ConfigParser) → dict[str, str | None]
Fetch spacetrack credentials from config file.
Args:
config: ConfigParser object containing config fields
Returns: dict containing username and password
function fetchKeyringCredentials
fetchKeyringCredentials() → dict[str, str | None]
Fetch spacetrack credentials from system keyring.
Returns: dict containing username and password
Raises:
ValueError: If no system keyring exists
function storeCredentials
storeCredentials(user: None | str = None, passwd: None | str = None) → bool
Store spacetrack credentials in system keyring.
Can set either username or password, but can’t set a password without a username
Args:
user: [optional] username stringpasswd: [optional] password string
Returns: True if successfully stored
Raises:
KeyError: raised if trying to store a password without a username
function createCredentials
createCredentials()
Script helper function to create and store credentials.
Called by command line script. Requires user input.
This file was automatically generated via lazydocs.