Base functions in SDK

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

Methods

authenticate

Authenticates with the SDK.

ParameterDescription
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.

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

Learn more

Console docs | Registration Console docs | Credit purchase

Last updated: