ClientConfig#
- class cegalprizm.hub.ClientConfig#
Global configuration for the Python client communicating with a running Cegal Hub Server. This is used primarily with ConnectionParameters objects. When a ConnectionParameters object is created but no values are provided, the ConnectionParameters object will rely on the ClientConfig and ServerConfig global configurations for defaults.
Functions
__init__
()Get the configuration for whether or not to use authentication.
set_use_auth
(use_auth)Update the ClientConfig to use auth or not.
- static get_use_auth()#
Get the configuration for whether or not to use authentication. This will look for an environment variable called CEGAL_HUB_USE_AUTH which it will expect to be set to True or False.
- Returns
Whether or not to use authentication.
- Return type
[bool]
- static set_use_auth(use_auth: bool)#
Update the ClientConfig to use auth or not.
- Parameters
use_auth (bool) – True to indicate authentication should be used, False otherwise.