Base

Use elementary functionalities of the SDK.


Overview

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 repository

Authentication

Functions

authenticate

Authenticates with the UP42 SDK.

ParameterDescription
cfg_fileOptional[Union[str, pathlib.Path]]]
The file path to the JSON file containing the username and password.
usernameOptional[str]
The email address used for logging into the console.
passwordOptional[str]
The password used for logging into the console.

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")

  

Credit balance

Functions

get_credits_balance

Retrieves your account balance, in UP42 credits. Returns dict.

Python

    up42.get_credits_balance()

  

Learn more