kolena.initialize

initialize(api_token, *args, verbose=False, proxies=None, **kwargs)

Initialize a client session.

Retrieve an API token from the Developer page and populate the KOLENA_TOKEN environment variable before initializing:

import os
import kolena

kolena.initialize(os.environ["KOLENA_TOKEN"], verbose=True)

A session has a global scope and remains active until interpreter shutdown.

Note

As of version 0.29.0: the entity argument is no longer needed; the signature initialize(entity, api_token) has been deprecated and replaced by initialize(api_token).

Parameters:

Name	Type	Description	Default
api_token	str	Provided API token. This token is a secret and should be treated with caution.	required
verbose	bool	Optionally configure client to run in verbose mode, providing more information about execution. All logging events are emitted as Python standard library logging events from the "kolena" logger as well as to stdout/stderr directly.	False
proxies	Optional[Dict[str, str]]	Optionally configure client to run with http or https proxies. The proxies parameter is passed through to the requests package and can be configured accordingly.	None

Raises:

Type	Description
InvalidTokenError	The provided api_token is not valid.
InputValidationError	The provided combination or number of args is not valid.