pib_cli
latest
PIB CLI
CLI Reference
Codebase
License
GitHub Repository
pib_cli
Index
Edit on GitHub
Index
Symbols
|
A
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
L
|
M
|
P
|
R
|
S
|
T
|
U
|
V
|
Y
Symbols
--config-file
dev-@pib-config command line option
-c
dev-@pib-config command line option
A
ARGS
dev-build-wheel command line option
dev-coverage command line option
dev-fmt command line option
dev-lint command line option
dev-reinstall-requirements command line option
dev-sectest command line option
dev-test command line option
C
clear() (State class method)
CommandBase (class in pib_cli.cli.commands.bases.command)
CommandBaseExceptionsTestHarness (class in pib_cli.cli.commands.bases.fixtures.command_harness_exceptions)
CommandBaseTestHarness (class in pib_cli.cli.commands.bases.fixtures.command_harness)
CommandConfigBase (class in pib_cli.cli.commands.bases.command_config)
CommandConfigBaseTestHarness (class in pib_cli.cli.commands.bases.fixtures.command_harness_config)
CommandRunner (class in pib_cli.support.runner)
CommandSelector (class in pib_cli.support.user_configuration.selectors.command_selector)
CommandSelectorBase (class in pib_cli.support.user_configuration.bases.command_selector_base)
CommandSelectorBaseTestHarness (class in pib_cli.support.user_configuration.bases.fixtures.command_selector_base_harness)
ConfigShowCommand (class in pib_cli.cli.commands.config_show)
ConfigValidateCommand (class in pib_cli.cli.commands.config_validate)
ConfigVersionCommand (class in pib_cli.cli.commands.config_version)
ConfigWhereCommand (class in pib_cli.cli.commands.config_where)
container_only_exception() (DevContainer method)
container_valid_exception() (DevContainer method)
container_version_exception() (DevContainer method)
ContainerBashFilesIterator (class in pib_cli.support.iterators.container_bash_files)
ContainerSetupCommand (class in pib_cli.cli.commands.container_setup)
ContainerShimFileIterator (class in pib_cli.support.iterators.container_shim_file)
ContainerValidateCommand (class in pib_cli.cli.commands.container_validate)
ContainerVersionCommand (class in pib_cli.cli.commands.container_version)
CustomClickCommandIterator (class in pib_cli.support.iterators.cli_custom_commands)
CustomizedCommand (class in pib_cli.cli.commands.customized)
D
destination (SourceDestinationPair property)
dev-@pib-config command line option
--config-file
-c
dev-build-wheel command line option
ARGS
dev-coverage command line option
ARGS
dev-fmt command line option
ARGS
dev-lint command line option
ARGS
dev-reinstall-requirements command line option
ARGS
dev-sectest command line option
ARGS
dev-test command line option
ARGS
DevContainer (class in pib_cli.support.container)
DevContainerBase (class in pib_cli.support.container.bases.container)
DevContainerException
DevContainerInstaller (class in pib_cli.support.container.installer)
documentation_root() (PathMap method)
documentation_root_path (PathMap property)
E
execute() (CommandRunner method)
exit() (DevContainerException method)
F
FileCopyIteratorBase (class in pib_cli.support.iterators.bases.file_copy_base)
FileCopyIteratorBaseTestHarness (class in pib_cli.support.iterators.bases.fixtures.file_copy_base_harness)
G
get_command_definitions() (LegacyUserVersionIntermediateBase method)
(UserConfigurationV210 method)
(UserConfigurationVersionBase method)
get_config_commands() (CommandSelectorBase method)
get_config_file_name() (UserConfigurationFile method)
get_config_path_method() (CommandSelector method)
(CommandSelectorBase method)
(LegacyCommandSelector method)
get_config_response() (CommandSelectorBase method)
get_container_version() (DevContainer method)
get_documentation_root() (LegacyUserVersionIntermediateBase method)
(UserConfigurationV210 method)
(UserConfigurationVersionBase method)
get_installation_files() (DevContainerInstaller method)
get_project_name() (LegacyUserVersionIntermediateBase method)
(UserConfigurationV210 method)
(UserConfigurationVersionBase method)
get_raw_file() (UserConfigurationFile method)
git_root() (PathMap method)
H
handler() (in module pib_cli.cli.commands)
hook_create_destination() (ContainerBashFilesIterator method)
(ContainerShimFileIterator method)
(FileCopyIteratorBase method)
I
invoke() (CommandBase method)
(ConfigShowCommand method)
(ConfigValidateCommand method)
(ConfigVersionCommand method)
(ConfigWhereCommand method)
(ContainerSetupCommand method)
(ContainerValidateCommand method)
(ContainerVersionCommand method)
(CustomizedCommand method)
(VersionCommand method)
invoke_command() (CommandBaseTestHarness method)
(CommandConfigBaseTestHarness method)
is_compatible_container() (DevContainer method)
is_container() (DevContainer method)
is_executable_exception() (CommandSelectorBase method)
J
JSONFileReader (class in pib_cli.support.mixins.json_file)
L
LegacyCommandSelector (class in pib_cli.support.user_configuration.selectors.command_selector_legacy)
LegacyUserVersionIntermediateBase (class in pib_cli.support.user_configuration.bases.version_legacy_base)
load() (State method)
load_custom_commands() (in module pib_cli.cli.interface.custom)
load_json_file() (JSONFileReader method)
load_text_file() (TextFileReader method)
load_yaml_file() (YAMLFileReader method)
M
main() (in module pib_cli.main)
module
pib_cli.cli
pib_cli.cli.commands
pib_cli.cli.commands.bases
pib_cli.cli.commands.bases.command
pib_cli.cli.commands.bases.command_config
pib_cli.cli.commands.bases.fixtures
pib_cli.cli.commands.bases.fixtures.command_harness
pib_cli.cli.commands.bases.fixtures.command_harness_config
pib_cli.cli.commands.bases.fixtures.command_harness_exceptions
pib_cli.cli.commands.config_show
pib_cli.cli.commands.config_validate
pib_cli.cli.commands.config_version
pib_cli.cli.commands.config_where
pib_cli.cli.commands.container_setup
pib_cli.cli.commands.container_validate
pib_cli.cli.commands.container_version
pib_cli.cli.commands.customized
pib_cli.cli.commands.version
pib_cli.cli.interface
pib_cli.cli.interface.builtins
pib_cli.cli.interface.builtins.config
pib_cli.cli.interface.builtins.container
pib_cli.cli.interface.custom
pib_cli.config
pib_cli.config.locale
pib_cli.config.yaml_keys
pib_cli.main
pib_cli.support
pib_cli.support.container
pib_cli.support.container.bases
pib_cli.support.container.bases.container
pib_cli.support.container.exceptions
pib_cli.support.container.installer
pib_cli.support.iterators
pib_cli.support.iterators.bases
pib_cli.support.iterators.bases.file_copy_base
pib_cli.support.iterators.bases.fixtures
pib_cli.support.iterators.bases.fixtures.file_copy_base_harness
pib_cli.support.iterators.cli_custom_commands
pib_cli.support.iterators.container_bash_files
pib_cli.support.iterators.container_shim_file
pib_cli.support.mixins
pib_cli.support.mixins.json_file
pib_cli.support.mixins.text_file
pib_cli.support.mixins.yaml_file
pib_cli.support.path_map
pib_cli.support.runner
pib_cli.support.state
pib_cli.support.user_configuration
pib_cli.support.user_configuration.bases
pib_cli.support.user_configuration.bases.command_selector_base
pib_cli.support.user_configuration.bases.fixtures
pib_cli.support.user_configuration.bases.fixtures.command_selector_base_harness
pib_cli.support.user_configuration.bases.fixtures.version_base_harness
pib_cli.support.user_configuration.bases.version_base
pib_cli.support.user_configuration.bases.version_legacy_base
pib_cli.support.user_configuration.selectors
pib_cli.support.user_configuration.selectors.command_selector
pib_cli.support.user_configuration.selectors.command_selector_legacy
pib_cli.support.user_configuration.user_configuration_file
pib_cli.support.user_configuration.validator
pib_cli.support.user_configuration.versions
P
parse() (UserConfigurationFile method)
PathMap (class in pib_cli.support.path_map)
pib_cli.cli
module
pib_cli.cli.commands
module
pib_cli.cli.commands.bases
module
pib_cli.cli.commands.bases.command
module
pib_cli.cli.commands.bases.command_config
module
pib_cli.cli.commands.bases.fixtures
module
pib_cli.cli.commands.bases.fixtures.command_harness
module
pib_cli.cli.commands.bases.fixtures.command_harness_config
module
pib_cli.cli.commands.bases.fixtures.command_harness_exceptions
module
pib_cli.cli.commands.config_show
module
pib_cli.cli.commands.config_validate
module
pib_cli.cli.commands.config_version
module
pib_cli.cli.commands.config_where
module
pib_cli.cli.commands.container_setup
module
pib_cli.cli.commands.container_validate
module
pib_cli.cli.commands.container_version
module
pib_cli.cli.commands.customized
module
pib_cli.cli.commands.version
module
pib_cli.cli.interface
module
pib_cli.cli.interface.builtins
module
pib_cli.cli.interface.builtins.config
module
pib_cli.cli.interface.builtins.container
module
pib_cli.cli.interface.custom
module
pib_cli.config
module
pib_cli.config.locale
module
pib_cli.config.yaml_keys
module
pib_cli.main
module
pib_cli.support
module
pib_cli.support.container
module
pib_cli.support.container.bases
module
pib_cli.support.container.bases.container
module
pib_cli.support.container.exceptions
module
pib_cli.support.container.installer
module
pib_cli.support.iterators
module
pib_cli.support.iterators.bases
module
pib_cli.support.iterators.bases.file_copy_base
module
pib_cli.support.iterators.bases.fixtures
module
pib_cli.support.iterators.bases.fixtures.file_copy_base_harness
module
pib_cli.support.iterators.cli_custom_commands
module
pib_cli.support.iterators.container_bash_files
module
pib_cli.support.iterators.container_shim_file
module
pib_cli.support.mixins
module
pib_cli.support.mixins.json_file
module
pib_cli.support.mixins.text_file
module
pib_cli.support.mixins.yaml_file
module
pib_cli.support.path_map
module
pib_cli.support.runner
module
pib_cli.support.state
module
pib_cli.support.user_configuration
module
pib_cli.support.user_configuration.bases
module
pib_cli.support.user_configuration.bases.command_selector_base
module
pib_cli.support.user_configuration.bases.fixtures
module
pib_cli.support.user_configuration.bases.fixtures.command_selector_base_harness
module
pib_cli.support.user_configuration.bases.fixtures.version_base_harness
module
pib_cli.support.user_configuration.bases.version_base
module
pib_cli.support.user_configuration.bases.version_legacy_base
module
pib_cli.support.user_configuration.selectors
module
pib_cli.support.user_configuration.selectors.command_selector
module
pib_cli.support.user_configuration.selectors.command_selector_legacy
module
pib_cli.support.user_configuration.user_configuration_file
module
pib_cli.support.user_configuration.validator
module
pib_cli.support.user_configuration.versions
module
project_root() (PathMap method)
project_root_path (PathMap property)
R
repo_root() (PathMap method)
repo_root_path (PathMap property)
S
select_config_entry() (UserConfigurationVersionBase method)
selector (UserConfigurationV100 attribute)
(UserConfigurationV200 attribute)
(UserConfigurationV210 attribute)
setUp() (CommandBaseExceptionsTestHarness method)
(CommandBaseTestHarness method)
(CommandConfigBaseTestHarness method)
setup() (DevContainerInstaller method)
source (SourceDestinationPair property)
SourceDestinationPair (class in pib_cli.support.iterators.bases.file_copy_base)
State (class in pib_cli.support.state)
T
test_get_config_path_method() (CommandSelectorBaseTestHarness method)
test_get_documentation_folder() (UserConfigurationVersionBaseTestHarness method)
test_get_project_name() (UserConfigurationVersionBaseTestHarness method)
test_invoke() (CommandBaseTestHarness method)
test_invoke_default() (CommandConfigBaseTestHarness method)
test_invoke_exception() (CommandBaseExceptionsTestHarness method)
test_invoke_with_config() (CommandConfigBaseTestHarness method)
TextFileReader (class in pib_cli.support.mixins.text_file)
TypeLegacyUserConfiguration (class in pib_cli.config.yaml_keys)
TypeRunnerEnvVar (class in pib_cli.support.runner)
TypeUserConfiguration (class in pib_cli.config.yaml_keys)
U
UserConfigurationFile (class in pib_cli.support.user_configuration.user_configuration_file)
UserConfigurationV100 (class in pib_cli.support.user_configuration.versions)
UserConfigurationV200 (class in pib_cli.support.user_configuration.versions)
UserConfigurationV210 (class in pib_cli.support.user_configuration.versions)
UserConfigurationValidator (class in pib_cli.support.user_configuration.validator)
UserConfigurationVersionBase (class in pib_cli.support.user_configuration.bases.version_base)
UserConfigurationVersionBaseTestHarness (class in pib_cli.support.user_configuration.bases.fixtures.version_base_harness)
V
validate() (UserConfigurationValidator method)
VersionCommand (class in pib_cli.cli.commands.version)
Y
YAMLFileReader (class in pib_cli.support.mixins.yaml_file)