A base library module imported to Python that provides the elementary functionality that isn’t bound to a specific class of the UP42 structure.
View repositoryMethods
Authenticates with the 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. |
region | [Literal[“sa”]] The region used for SDK operations. |
# Authenticate directly in the codeup42.authenticate( username="<your-email-address>", password="<your-password>",)
# Authenticate in a configuration fileup42.authenticate(cfg_file="config.json")# Authenticate directly in the codeup42.authenticate( username="<your-email-address>", password="<your-password>", region="sa",)
# Authenticate in a configuration fileup42.authenticate(cfg_file="config.json")Methods
This method is deprecated and will be removed in
3.0.0. Retrieves your account balance, in UP42 credits. Returns dict.
up42.get_credits_balance()