COT.install_helpers module

Implements “install-helpers” command.

class COTInstallHelpers(ui)[source]

Bases: COT.submodule.COTGenericSubmodule

Install all helper tools that COT requires.

Inherited attributes: ui, package, output

__init__(ui)[source]

Instantiate this submodule with the given UI.

Parameters:ui (UI) – User interface instance.
create_subparser()[source]

Create ‘install-helpers’ CLI subparser.

install_helper(helper)[source]

Install the given helper module.

Parameters:helper (Helper) – Helper module to install.
Returns:tuple – (result, message)
manpages_helper()[source]

Verify or install COT’s manual pages.

Returns:tuple – (result, message)
run()[source]

Verify all helper tools and install any that are missing.

guess_manpath()[source]

Guess the directory path where man pages should be installed.

install_manpages(man_dir)[source]

Install COT’s manual pages.

Parameters:man_dir (str) – Base directory where manpages should be installed.
Returns:tuple – (result, message)
verify_manpages(man_dir)[source]

Verify installation of COT’s manual pages.

Parameters:man_dir (str) – Base directory where manpages should be found.
Returns:tuple – (result, message)