foliolib.config.Config

class foliolib.config.Config(*dt, **mp)

Bases: object

Config class is a singleton. This class defines the handling of the config files.

Methods

create_foliolib_conf()	Create foliolib.conf
create_server_conf(name[, okapi_host, ...])	Create server.conf for given server config name.
del_token(tenantid)	Delete token for a tenant
delete_env(key)	Delete enviroment variable.
foliolibcfg()	Get foliolib.conf ConfigParser object.
get_confdir()	Get the configuration directory
get_env([as_dict])	get global enviroment variables.
get_kube_config()
get_server()	Get current server name.
get_servers()	Get all available server configs.
get_token(tenantid)	Get token for a tenant
get_url()
has_token(tenantid)	Delete token for a tenant
is_foliolib_env()	Is global env handled by foliolib?
is_kubernetes()	Is Kubernetes enabled?
modulescfg(modId)	Get ConfigParser object of a module config file.
remove_servercfg(section, option)	Remove a option in server.conf
servercfg()	Get server.conf ConfigParser object.
set_env(key, value)	Set enviroment variable.
set_foliolibcfg(section, option, value)	Set a value in foliolib.conf
set_server(name)	Set current server name.
set_servercfg(section, option, value)	Set a value in server.conf
set_token(tenantid, token)	Set token for a tenant

create_foliolib_conf()

Create foliolib.conf

create_server_conf(name: str, okapi_host: str = 'localhost', okapi_port: str = '9130', ssl: bool = False, isAdmin: bool = False)

Create server.conf for given server config name.

Parameters

• name (str) – Server name.

• okapi_host (str, optional) – Okapi host. Defaults to “localhost”.

• okapi_port (str, optional) – Okapi port. Defaults to “9130”.

• ssl (bool, optional) – Wether okapi server is ssl. Defaults to False.

• isAdmin (bool, optional) – Whether cli should provide management for okapi. Defaults to False.

del_token(tenantid: str)

Delete token for a tenant

Parameters

• tenantid (str) – tenant id

• token (str) – token

delete_env(key: str)

Delete enviroment variable.

Parameters

key (str) – Name of the enviroment variable.

foliolibcfg()

Get foliolib.conf ConfigParser object.

Returns

ConfigParser object of foliolib.conf

Return type

ConfigParser

get_confdir()

Get the configuration directory

Returns

Path to configuration directory

Return type

str

get_env(as_dict: bool = False)

get global enviroment variables.

Parameters

as_dict (bool, optional) – Defaults to False.

Returns

dict, if as_dict is True, else list with enviroments variables.

Return type

Union[dict, list]

get_kube_config()

get_server()

Get current server name.

Returns

Current server name.

Return type

str

get_servers()

Get all available server configs.

Returns

List of available servers.

Return type

List

get_token(tenantid: str)

Get token for a tenant

Parameters

tenantid (str) – tenant id

get_url()

has_token(tenantid: str)

Delete token for a tenant

Parameters

• tenantid (str) – tenant id

• token (str) – token

is_foliolib_env()

Is global env handled by foliolib?

Returns

Wether foliolib env is enabled.

Return type

bool

is_kubernetes()

Is Kubernetes enabled?

Returns

Wether kubernets is enabled.

Return type

bool

modulescfg(modId)

Get ConfigParser object of a module config file.

Returns

ConfigParser object of $MODULENAME.conf for a specific module.

Return type

ConfigParser

remove_servercfg(section: str, option: str)

Remove a option in server.conf

Parameters

• section (str) – Section

• option (str) – Option

• value (any) – Value

servercfg()

Get server.conf ConfigParser object.

Returns

ConfigParser object of server.conf of the current server setted.

Return type

ConfigParser

set_env(key: str, value: Any)

Set enviroment variable.

Parameters

• key (str) – Name of the enviroment variable.

• value (Any) – Value of the enviroment variable.

set_foliolibcfg(section: str, option: str, value: str)

Set a value in foliolib.conf

Parameters

• section (str) – Section

• option (str) – Option

• value (any) – Value

set_server(name: str)

Set current server name.

Parameters

name (str) – Server name

Raises

ServerConfigNotFound – Server config not found.

set_servercfg(section: str, option: str, value: str)

Set a value in server.conf

Parameters

• section (str) – Section

• option (str) – Option

• value (any) – Value

set_token(tenantid: str, token: str)

Set token for a tenant

Parameters

• tenantid (str) – tenant id

• token (str) – token