pkglts.option.license package

Submodules

pkglts.option.license.config module

pkglts.option.license.config.check(cfg)

Check the validity of parameters in working environment.

Parameters:cfg (Config) – current package configuration Returns:list of faulty parameters Return type:(list of str)

pkglts.option.license.config.require(purpose, cfg)

List of requirements for this option for a given purpose.

Parameters:

• purpose (str) – either ‘option’, ‘setup’, ‘install’ or ‘dvlpt’
• cfg (Config) – current package configuration

Returns:

(list of Dependency)

pkglts.option.license.config.update_parameters(cfg)

Update config with parameters necessary for this option.

Notes: create a section with option name to store params.

Parameters:cfg (dict) – dict of option parameters as seen in pkg_cfg.json Returns:update in place Return type:None

pkglts.option.license.handlers module

pkglts.option.license.handlers.environment_extensions(cfg)

Add more functionality to an environment.

Parameters:cfg (Config) – current package configuration Returns:any Return type:dict of str

pkglts.option.license.handlers.full_text(cfg)

Generate a license

pkglts.option.license.handlers.get_tpl_path(name)

Return a path for license template file.

Warnings: Do not test if path exists

Parameters:name (str) – name of license to fetch Returns:(str)

Module contents