Config (config)

pypint.utilities.config.config(config_file=None)

Returns configuration object

By default, PyPinT looks in the current user’s home directory (i.e. $HOME) for a file called .pypint.conf.

In case the environment variable $PYPINT_CONFIG is set, its value is used as the absolute path and file name of the config file (cf. config_file parameter).

Validation of the given config file is done against the configspec file in PyPinT’s installation path in utilities/config.spec.

In case no config file is present, the default values as stated in $PYPINT_ROOT/default_config.conf file are used.

Parameters:config_file (str) – (optional) The absolute path and file name of the config file to use. If given, it will override all defaults. Returns:config – Configuration object parsed from the config file. Return type:ConfigObj