Package boonamber

Sub-modules

v1
v2

Amber API Server …

Classes

class AmberV1Client (license_id='default', license_file='~/.Amber.license', verify=True, cert=None, timeout=300)

Main client which interfaces with the Amber cloud. Amber account credentials are discovered within a .Amber.license file located in the home directory, or optionally overridden using environment variables.

Args

license_id : str
license identifier label found within .Amber.license file
license_file : str
path to .Amber.license file
verify
Boolean, controls whether we verify the server’s TLS certificate
cert : bool
if String, path to ssl client cert file (.pem). If Tuple, (‘cert’, ‘key’) pair.

Environment

AMBER_LICENSE_FILE: sets license_file path

AMBER_LICENSE_ID: sets license_id

AMBER_USERNAME: overrides the username as found in .Amber.license file

AMBER_PASSWORD: overrides the password as found in .Amber.license file

AMBER_SERVER: overrides the server as found in .Amber.license file

AMBER_OAUTH_SERVER: overrides the oauth server as found in .Amber.license file

AMBER_SSL_CERT: path to ssl client cert file (.pem)

AMBER_SSL_VERIFY: Either a boolean, in which case it controls whether we verify the server’s TLS certificate, or a string, in which case it must be a path to a CA bundle to use

Raises

AmberUserError
if error supplying authentication credentials

Ancestors

Inherited members

class AmberV2Client (license_id: str = None, license_file: str = '~/.Amber.license', verify: bool = False, timeout: int = 300)

Main client which interfaces with the Amber cloud. Amber account credentials are discovered within a .Amber.license file located in the home directory, or optionally overridden using environment variables.

Args

license_id
(type: str) license identifier label found within .Amber.license file
license_file
(type: str) path to .Amber.license file
verify
(type: boolean) Boolean, controls whether we verify the server’s TLS certificate
timeout
(type: int) number of seconds to allow API call to wait

Environment

AMBER_V2_LICENSE_FILE: sets license_file path

AMBER_V2_LICENSE_ID: sets license_id

AMBER_V2_SERVER: overrides the server as found in .Amber.license file

AMBER_V2_OAUTH_SERVER: overrides the oauth server as found in .Amber.license file

AMBER_V2_LICENSE_KEY: overrides the license key as found in .Amber.license file

AMBER_V2_SECRET_KEY: overrides the secret key as found in .Amber.license file

Raises

ApiException
if error supplying authentication credentials

Ancestors

Inherited members