8.7. vantage6.common#

Common functionality used in multiple vantage6 components.

Functions

`base64s_to_bytes`(bytes_string)	Convert base64 encoded string to bytes.
`bytes_to_base64s`(bytes_)	Convert bytes into base64 encoded string.
`check_config_writeable`([system_folders])	Check if the user has write permissions to create the configuration file.
`debug`(msg)	Print a debug message to the CLI.
`echo`(msg[, level])	Print a message to the CLI.
`error`(msg)	Print an error message to the CLI.
`generate_apikey`()	Creates random api_key using uuid.
`get_config_path`(dirs[, system_folders])	Get the path to the configuration directory.
`get_database_config`(databases, label)	Get database configuration from config file
`info`(msg)	Print an info message to the CLI.
`is_ip_address`(ip)	Test if input IP address is a valid IP address
`logger_name`(special__name__)	Return the name of the logger.
`split_rabbitmq_uri`(rabbit_uri)	Get details (user, pass, host, vhost, port) from a RabbitMQ uri.
`warning`(msg)	Print a warning message to the CLI.

Classes

`ClickLogger`()	"Logs output to the click interface.
`Singleton`	Singleton metaclass.
`WhoAmI`(type_, id_, name, organization_name, ...)	Data-class to store Authenticatable information in.

Modules

`vantage6.common.colors`
`vantage6.common.configuration_manager`
`vantage6.common.context`
`vantage6.common.docker`
`vantage6.common.encryption`	Encryption between organizations
`vantage6.common.enum`
`vantage6.common.exceptions`
`vantage6.common.globals`
`vantage6.common.log`
`vantage6.common.serialization`
`vantage6.common.task_status`
`vantage6.common.utest`