pkglts.option.license.option module

class pkglts.option.license.option.OptionLicense(name)[source]

Bases: Option

check(cfg)[source]

Check validity of parameters for this option.

Parameters:

cfg (Config) – current package configuration

Returns:

list of failing params

Return type:

(list of str)

environment_extensions(cfg)[source]

Get jinja2 environment extensions defined by this option.

Parameters:

cfg (Config) – current package configuration

Returns:

any): extensions defined by this option

Return type:

(dict of str

require_option(cfg)[source]

Names of other options required by this option.

Parameters:

cfg (Config) – current package configuration

Returns:

(list of str)

root_dir()[source]

Base directory containing option definition files.

Returns:

(Path)

update_parameters(cfg)[source]

Update configuration with option parameters.

Parameters:

cfg (Config) – current package configuration

Returns:

(Config)

version()[source]

Current version of this option.

Returns:

X.X.X

Return type:

(str)

pkglts.option.license.option.full_text(cfg)[source]

Generate a license

pkglts.option.license.option.get_tpl_path(name)[source]

Return a path for license template file.

Warnings: Do not test if path exists

Parameters:

name (str) – name of license to fetch

Returns:

(str)