pystclient.api

pystclient API.

Functions

run([config_file, login, delete_token])

Run the pystclient process.

Classes

PyStclientProcess([config_file, login, ...])

Top level class encapsulating the pystclient process.
pystclient.api.run(config_file: str | PathLike[str] | None = None, *, login: bool = False, delete_token: bool = False) → None

Run the pystclient process.

Parameters:

  • config_file – File containing the pystclient configuration. Defaults to None.

  • login – If True, login to Veracity Identity to retrieve and store an access token to a local cache. Defaults to False.

  • delete_token – If True, delete an access token stored in a local cache. Defaults to False.

Raises:

FileNotFoundError – If config_file was specified but does not exist.