installation_instruction.__main__

Code of the click custom commands install, show and default. The commands install and show are ConfigReadCommand instances while the subcommands add, remove and list from the multi command default are ConfigCommandGroup instances.

Attributes

VERSION_STRING

Classes

ConfigReadCommand

Custom click command class to read config file, folder or git repository and show installation instructions with parameters.

ConfigCommandGroup

Custom click command group class for default commands with subcommands.

Functions

_get_system(option_types)

Returns the os from the list of possible os systems defined in the schema.

cat(path)

show(ctx)

install(ctx, verbose)

default(ctx)

add(ctx)

remove(ctx)

list(ctx)

main(ctx)

Module Contents

installation_instruction.__main__.VERSION_STRING
installation_instruction.__main__._get_system(option_types)

Returns the os from the list of possible os systems defined in the schema.

Parameters:

option_types (list) – list of system from the schema.

Returns:

os system from input list or None.

Return type:

string or None

class installation_instruction.__main__.ConfigReadCommand(*args, **kwargs)

Bases: click.MultiCommand

Custom click command class to read config file, folder or git repository and show installation instructions with parameters.

get_command(ctx, config_file: str) → click.Command | None

Given a context and a command name, this returns a Command object if it exists or returns None.

class installation_instruction.__main__.ConfigCommandGroup(*args, **kwargs)

Bases: click.Group

Custom click command group class for default commands with subcommands.

get_command(ctx, config_file: str, **kwargs) → click.Command | None

Given a context and a command name, this returns a Command object if it exists or returns None.

installation_instruction.__main__.cat(path)
installation_instruction.__main__.show(ctx)
installation_instruction.__main__.install(ctx, verbose)
installation_instruction.__main__.default(ctx)
installation_instruction.__main__.add(ctx)
installation_instruction.__main__.remove(ctx)
installation_instruction.__main__.list(ctx)
installation_instruction.__main__.main(ctx)