Index

A

add_template_filters() (qwikstart.utils.templates.TemplateRenderer method) add_template_variable() (qwikstart.utils.templates.TemplateRenderer method) aliases (qwikstart.operations.base.BaseOperation attribute) (qwikstart.operations.BaseOperation attribute) (qwikstart.operations.prompt.Operation attribute)

assert_has_dataclass_fields() (in module qwikstart.utils.core)

B

BaseContext (class in qwikstart.base_context) BaseOperation (class in qwikstart.operations) (class in qwikstart.operations.base)

BaseRepoLoader (class in qwikstart.repository) (class in qwikstart.repository.base) BoolInput (class in qwikstart.utils.input_types)

C

can_load() (qwikstart.repository.local.YamlFileLoader method) can_load_spec() (qwikstart.repository.base.BaseRepoLoader method) (qwikstart.repository.BaseRepoLoader method) (qwikstart.repository.GitRepoLoader method) (qwikstart.repository.LocalRepoLoader method) (qwikstart.repository.git.GitRepoLoader method) (qwikstart.repository.local.LocalRepoLoader method) cast() (qwikstart.utils.input_types.BoolInput method) (qwikstart.utils.input_types.InputType method) (qwikstart.utils.input_types.IntegerInput method)

choices (qwikstart.utils.prompt.PromptSpec attribute) completer (qwikstart.utils.input_types.InputType attribute) (qwikstart.utils.input_types.PathInput attribute) Config (class in qwikstart.config) config (qwikstart.parser.operations.OperationDefinition attribute) ConfigurationError configure_logger() (in module qwikstart.utils.logging) Context (class in qwikstart.operations.find_tagged_line) copy() (qwikstart.utils.filesystem.FileTreeGenerator method) create_prompt_spec() (in module qwikstart.utils.prompt)

D

default (qwikstart.utils.prompt.PromptSpec attribute) default_prefix (qwikstart.utils.input_types.BoolInput attribute) (qwikstart.utils.input_types.InputType attribute)

download_git_repo() (in module qwikstart.repository.git)

E

ensure_path() (in module qwikstart.utils) (in module qwikstart.utils.core) error_msg (qwikstart.utils.input_types.BoolInput attribute) (qwikstart.utils.input_types.InputType attribute) (qwikstart.utils.input_types.StringInput attribute)

execute() (qwikstart.operations.base.BaseOperation method) (qwikstart.operations.BaseOperation method) (qwikstart.tasks.Task method) execution_context (qwikstart.utils.templates.TemplateContext attribute) ExecutionContext (class in qwikstart.base_context)

F

file_loader (qwikstart.repository.local.LocalRepoLoader attribute) (qwikstart.repository.LocalRepoLoader attribute) FileTreeGenerator (class in qwikstart.utils.filesystem) first() (in module qwikstart.utils) (in module qwikstart.utils.core)

fnmatches_to_regex() (in module qwikstart.utils.filesystem) from_context() (qwikstart.utils.templates.TemplateRenderer class method) from_dict() (qwikstart.base_context.BaseContext class method) full_class_name() (in module qwikstart.utils) (in module qwikstart.utils.core)

G

GenericOperation (in module qwikstart.operations) (in module qwikstart.operations.base) get_context_class() (qwikstart.operations.base.BaseOperation class method) (qwikstart.operations.BaseOperation class method) get_dataclass_keys() (in module qwikstart.utils) (in module qwikstart.utils.core) get_dataclass_values() (in module qwikstart.utils) (in module qwikstart.utils.core) get_local_repo_path() (in module qwikstart.repository.git) get_nested_dict_value() (in module qwikstart.utils.dict_utils)

get_operation_help() (in module qwikstart.cli.utils) get_operations_mapping() (in module qwikstart.parser) get_param_type() (in module qwikstart.utils.prompt) get_repo_loader() (in module qwikstart.cli.resolver) get_template() (qwikstart.utils.templates.TemplateRenderer method) get_template_loader() (qwikstart.base_context.ExecutionContext method) get_text() (qwikstart.operations.insert_text.Operation method) get_user_config() (in module qwikstart.config) GitRepoLoader (class in qwikstart.repository) (class in qwikstart.repository.git)

H

help() (qwikstart.base_context.BaseContext class method)

I

indent() (in module qwikstart.utils) (in module qwikstart.utils.core) input_type (qwikstart.utils.prompt.PromptSpec attribute) InputType (class in qwikstart.utils.input_types) IntegerInput (class in qwikstart.utils.input_types)

is_valid() (qwikstart.utils.input_types.BoolInput method) (qwikstart.utils.input_types.InputType method) (qwikstart.utils.input_types.IntegerInput method) (qwikstart.utils.input_types.NumberRange method) (qwikstart.utils.input_types.StringInput method)

J

join_regex() (in module qwikstart.utils.filesystem)

K

known_extensions (qwikstart.repository.local.YamlFileLoader attribute)

L

load() (qwikstart.repository.local.YamlFileLoader method) load_custom_config_file() (in module qwikstart.config) load_raw_task_spec() (qwikstart.repository.base.BaseRepoLoader method) (qwikstart.repository.BaseRepoLoader method) (qwikstart.repository.GitRepoLoader method) (qwikstart.repository.LocalRepoLoader method) (qwikstart.repository.git.GitRepoLoader method) (qwikstart.repository.local.LocalRepoLoader method)

LocalRepoLoader (class in qwikstart.repository) (class in qwikstart.repository.local)

M

main() (in module qwikstart.cli.main)

merge_nested_dicts() (in module qwikstart.utils) (in module qwikstart.utils.dict_utils)

N

name (qwikstart.operations.add_file.Operation attribute) (qwikstart.operations.add_file_tree.Operation attribute) (qwikstart.operations.define_context.Operation attribute) (qwikstart.operations.echo.Operation attribute) (qwikstart.operations.find_tagged_line.Operation attribute) (qwikstart.operations.insert_text.Operation attribute) (qwikstart.operations.prompt.Operation attribute) (qwikstart.operations.shell.Operation attribute) (qwikstart.parser.operations.OperationDefinition attribute)

normalize_context() (in module qwikstart.parser.tasks) normalize_operations_list() (in module qwikstart.parser.tasks) NumberRange (class in qwikstart.utils.input_types)

O

Operation (class in qwikstart.operations.add_file) (class in qwikstart.operations.add_file_tree) (class in qwikstart.operations.define_context) (class in qwikstart.operations.echo) (class in qwikstart.operations.find_tagged_line) (class in qwikstart.operations.insert_text) (class in qwikstart.operations.prompt) (class in qwikstart.operations.shell)

OperationDefinition (class in qwikstart.parser.operations) OperationDefinitionError OperationError OperationHelp (class in qwikstart.cli.utils) OperationMapping (in module qwikstart.parser) Output (class in qwikstart.operations.find_tagged_line)

P

parse_operation() (in module qwikstart.parser.operations) parse_task() (in module qwikstart.parser) (in module qwikstart.parser.tasks) parsed_config (qwikstart.parser.operations.OperationDefinition attribute) PathInput (class in qwikstart.utils.input_types) pop_nested_dict_value() (in module qwikstart.utils.dict_utils)

post_run() (qwikstart.operations.base.BaseOperation method) (qwikstart.operations.BaseOperation method) pre_run() (qwikstart.operations.base.BaseOperation method) (qwikstart.operations.BaseOperation method) prompt() (qwikstart.utils.input_types.InputType method) PromptSpec (class in qwikstart.utils.prompt)

Q

qwikstart (module) qwikstart.base_context (module) qwikstart.cli (module) qwikstart.cli.main (module) qwikstart.cli.resolver (module) qwikstart.cli.utils (module) qwikstart.config (module) qwikstart.exceptions (module) qwikstart.operations (module) qwikstart.operations.add_file (module) qwikstart.operations.add_file_tree (module) qwikstart.operations.base (module) qwikstart.operations.define_context (module) qwikstart.operations.echo (module) qwikstart.operations.find_tagged_line (module) qwikstart.operations.insert_text (module) qwikstart.operations.prompt (module) qwikstart.operations.shell (module)

qwikstart.parser (module) qwikstart.parser.operations (module) qwikstart.parser.tasks (module) qwikstart.repository (module) qwikstart.repository.base (module) qwikstart.repository.git (module) qwikstart.repository.local (module) qwikstart.tasks (module) qwikstart.utils (module) qwikstart.utils.core (module) qwikstart.utils.dict_utils (module) qwikstart.utils.filesystem (module) qwikstart.utils.input_types (module) qwikstart.utils.logging (module) qwikstart.utils.prompt (module) qwikstart.utils.templates (module) qwikstart_cache_path (qwikstart.config.Config attribute) QwikstartException

R

raw_prompt() (qwikstart.utils.input_types.BoolInput method) (qwikstart.utils.input_types.InputType method) (qwikstart.utils.input_types.IntegerInput method) read_user_choice() (in module qwikstart.utils.prompt) read_user_variable() (in module qwikstart.utils.prompt) remap_dict() (in module qwikstart.utils) (in module qwikstart.utils.dict_utils) render() (qwikstart.utils.templates.TemplateRenderer method) render_string() (qwikstart.utils.templates.TemplateRenderer method) RepoLoaderError resolve_git_url() (in module qwikstart.repository.git) resolve_path() (in module qwikstart.utils.core)

resolve_task() (in module qwikstart.cli.resolver) resolve_template_path() (qwikstart.utils.templates.TemplateRenderer method) run() (qwikstart.operations.add_file.Operation method) (qwikstart.operations.BaseOperation method) (qwikstart.operations.add_file_tree.Operation method) (qwikstart.operations.base.BaseOperation method) (qwikstart.operations.define_context.Operation method) (qwikstart.operations.echo.Operation method) (qwikstart.operations.find_tagged_line.Operation method) (qwikstart.operations.insert_text.Operation method) (qwikstart.operations.prompt.Operation method) (qwikstart.operations.shell.Operation method)

S

set_nested_dict_value() (in module qwikstart.utils.dict_utils) source_dir (qwikstart.base_context.ExecutionContext attribute) spec_path (qwikstart.repository.base.BaseRepoLoader attribute) (qwikstart.repository.BaseRepoLoader attribute) (qwikstart.repository.GitRepoLoader attribute) (qwikstart.repository.LocalRepoLoader attribute) (qwikstart.repository.git.GitRepoLoader attribute) (qwikstart.repository.local.LocalRepoLoader attribute)

StringInput (class in qwikstart.utils.input_types)

T

target_dir (qwikstart.base_context.ExecutionContext attribute) Task (class in qwikstart.tasks) TaskParserError TaskSpec (class in qwikstart.parser) (class in qwikstart.parser.tasks)

template_variable_prefix (qwikstart.utils.templates.TemplateContext attribute) template_variables (qwikstart.utils.templates.TemplateContext attribute) TemplateContext (class in qwikstart.utils.templates) TemplateRenderer (class in qwikstart.utils.templates)

U

update_git_repo() (in module qwikstart.repository.git)

update_template_variables() (qwikstart.utils.templates.TemplateRenderer method) UserFacingError

V

validator (qwikstart.utils.input_types.InputType attribute)

Y

YamlFileLoader (class in qwikstart.repository.local)