A base library module imported to Python that provides the elementary functionality that isn’t bound to a specific class of the UP42 structure.
Examples
Python
# Authenticate directly in the code
up42.authenticate(
username="<your-email-address>",
password="<your-password>",
)
# Authenticate in a configuration file
up42.authenticate(cfg_file="config.json")
Functions
authenticate
Authenticates with the UP42 SDK.
| Parameter | Description |
|---|---|
cfg_file | Optional[Union[str, pathlib.Path]]] The file path to the JSON file containing the username and password. |
username | Optional[str] The email address used for logging into the console. |
password | Optional[str] The password used for logging into the console. |
Examples
Python
# Get account balance, in UP42 credits
up42.get_credits_balance()
Functions
get_credits_balance
Retrieves your account balance, in UP42 credits. Returns dict.