pib_cli.support.user_configuration.bases.version_base

UserConfigurationVersionBase class.

class UserConfigurationVersionBase(configuration: Any)[source]

The base class for a schema version of pib_cli configuration.

abstract get_command_definitions() List[Any][source]

Return the CLI command definitions from the configuration.

abstract get_documentation_root() str[source]

Return the documentation folder from the configuration.

abstract get_project_name() str[source]

Return the project name from the configuration.

select_config_entry(command_name: str) CommandSelectorBase[source]

Select the configuration entry of the specified command.

Parameters

command_name – The name of the command to select

Returns

A Python representation of the selected configuration.

Raises

KeyError