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 (**kwargs)

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

Args

kwargs: Direct specification: server: full URL for amber server oauth_server: full URL for oauth server license_key: Amber license_key secret_key: Amber secret key timeout: Timeout value for all requests

License File: license_file: path to license file (defaults to ~/.Amber.license) (AMBER_LICENSE_FILE) profile_name: profile name withing .Amber.license (defaults to "default") (AMBER_PROFILE_NAME aka AMBER_LICENSE_ID)

Profile Dictionary: profile: profile dictionary Environment variables: AMBER_LICENSE_KEY: license key

<code>AMBER\_SECRET\_KEY</code>: secret key

<code>AMBER\_SERVER</code>: amber server address

<code>AMBER\_OAUTH\_SERVER</code>: amber oauth server address, defaults to AMBER_SERVER if unset

<code>AMBER\_SSL\_CERT</code>: path to ssl client cert file (.pem)

<code>AMBER\_SSL\_VERIFY</code>: 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

<code>AMBER\_LICENSE\_FILE</code>: file containing amber credentials

<code>AMBER\_PROFILE\_NAME</code>: named entry within the AMBER_LICENSE_FILE

<code>AMBER\_LICENSE\_ID</code>: alias for AMBER_PROFILE_NAME

Ancestors

Inherited members