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) assert_no_errors() (in module qwikstart.repository.yamllint)

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.loaders) BoolInput (class in qwikstart.utils.input_types)

C

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) clean_multiline() (in module qwikstart.utils) (in module qwikstart.utils.text_utils) column (qwikstart.operations.find_tagged_line.Output attribute) completer (qwikstart.utils.input_types.InputType attribute) (qwikstart.utils.input_types.PathInput attribute) Config (class in qwikstart.config) config() (qwikstart.parser.operations.OperationDefinition property) ConfigurationError

configure_logger() (in module qwikstart.utils.logging) Context (class in qwikstart.operations.context_from_regex) (class in qwikstart.operations.find_files) (class in qwikstart.operations.find_tagged_line) (class in qwikstart.operations.search_and_replace) context (qwikstart.tasks.Task attribute) copy() (qwikstart.base_context.ExecutionContext method) (qwikstart.utils.filesystem.FileTreeGenerator method) create() (qwikstart.operations.base.OperationConfig class method) (qwikstart.operations.OperationConfig class method) create_prompt_spec() (in module qwikstart.utils.prompt) create_regex_flags() (in module qwikstart.utils) (in module qwikstart.utils.regex)

D

default (qwikstart.utils.prompt.PromptSpec attribute) default_opconfig (qwikstart.operations.base.BaseOperation attribute) (qwikstart.operations.BaseOperation attribute) (qwikstart.operations.define_context.Operation attribute) (qwikstart.operations.echo.Operation attribute) (qwikstart.operations.prompt.Operation attribute) default_prefix (qwikstart.utils.input_types.BoolInput attribute) (qwikstart.utils.input_types.InputType attribute)

directory (qwikstart.operations.find_files.Context attribute) display_description (qwikstart.operations.base.OperationConfig attribute) (qwikstart.operations.OperationConfig attribute) docstring (qwikstart.cli.utils.OperationHelp attribute) download_git_repo() (in module qwikstart.repository.git) dry_run (qwikstart.base_context.ExecutionContext attribute) dump_yaml_file() (in module qwikstart.utils.io) dump_yaml_string() (in module qwikstart.utils.io)

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.base_context.BaseContext attribute) execution_context() (qwikstart.utils.templates.TemplateContext property) ExecutionContext (class in qwikstart.base_context)

F

file_path (qwikstart.operations.context_from_regex.Context attribute) (qwikstart.operations.find_tagged_line.Context attribute) (qwikstart.operations.search_and_replace.Context 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_config_dicts() (qwikstart.operations.base.OperationConfig class method) (qwikstart.operations.OperationConfig class method) 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_output_class() (qwikstart.operations.base.BaseOperation class method) (qwikstart.operations.BaseOperation class method)

get_param_type() (in module qwikstart.utils.prompt) get_repo_loader() (in module qwikstart.repository) (in module qwikstart.repository.loaders) get_template() (qwikstart.utils.templates.TemplateRenderer method) get_template_loader() (qwikstart.base_context.ExecutionContext method) get_text() (qwikstart.operations.append_text.Operation method) (qwikstart.operations.find_tag_and_insert_text.Operation method) (qwikstart.operations.insert_text.Operation method) get_user_config() (in module qwikstart.config) git_abbreviations (qwikstart.config.Config attribute) GitRepoLoader (class in qwikstart.repository) (class in qwikstart.repository.loaders) GitUrl (class in qwikstart.repository.git)

H

help() (qwikstart.base_context.BaseContext class method) (qwikstart.operations.context_from_regex.Context class method) (qwikstart.operations.find_files.Context class method) (qwikstart.operations.find_tagged_line.Context class method) (qwikstart.operations.search_and_replace.Context class method)

help_text (qwikstart.utils.prompt.PromptSpec attribute)

I

indent() (in module qwikstart.utils) (in module qwikstart.utils.core) index_of_non_empty_line() (in module qwikstart.utils.text_utils) input_config (qwikstart.utils.prompt.PromptSpec attribute) input_mapping (qwikstart.operations.base.OperationConfig attribute) (qwikstart.operations.OperationConfig attribute) input_namespace (qwikstart.operations.base.OperationConfig attribute) (qwikstart.operations.OperationConfig attribute)

input_type (qwikstart.utils.prompt.PromptSpec attribute) InputType (class in qwikstart.utils.input_types) IntegerInput (class in qwikstart.utils.input_types) is_url() (in module qwikstart.utils.http) 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)

L

line (qwikstart.operations.find_tagged_line.Output attribute) linter_errors() (in module qwikstart.repository.yamllint)

load_custom_config_file() (in module qwikstart.config) load_yaml_file() (in module qwikstart.utils.io) load_yaml_string() (in module qwikstart.utils.io)

M

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

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

N

name (qwikstart.cli.utils.OperationHelp attribute) (qwikstart.operations.add_file.Operation attribute) (qwikstart.operations.add_file_tree.Operation attribute) (qwikstart.operations.append_text.Operation attribute) (qwikstart.operations.base.BaseOperation attribute) (qwikstart.operations.BaseOperation attribute) (qwikstart.operations.context_from_regex.Operation attribute) (qwikstart.operations.define_context.Operation attribute) (qwikstart.operations.echo.Operation attribute) (qwikstart.operations.edit_json.Operation attribute) (qwikstart.operations.edit_yaml.Operation attribute) (qwikstart.operations.find_files.Operation attribute) (qwikstart.operations.find_tag_and_insert_text.Operation attribute) (qwikstart.operations.find_tagged_line.Operation attribute) (qwikstart.operations.insert_text.Operation attribute) (qwikstart.operations.prompt.Operation attribute) (qwikstart.operations.search_and_replace.Operation attribute) (qwikstart.operations.shell.Operation attribute) (qwikstart.operations.subtask.Operation attribute) (qwikstart.utils.prompt.PromptSpec attribute)

name() (qwikstart.parser.operations.OperationDefinition property) noop() (in module qwikstart.utils.text_utils) normalize_operations_list() (in module qwikstart.parser.tasks) NumberRange (class in qwikstart.utils.input_types)

O

on_dry_run() (qwikstart.operations.edit_json.Operation static method) (qwikstart.operations.edit_yaml.Operation static method) Operation (class in qwikstart.operations.add_file) (class in qwikstart.operations.add_file_tree) (class in qwikstart.operations.append_text) (class in qwikstart.operations.context_from_regex) (class in qwikstart.operations.define_context) (class in qwikstart.operations.echo) (class in qwikstart.operations.edit_json) (class in qwikstart.operations.edit_yaml) (class in qwikstart.operations.find_files) (class in qwikstart.operations.find_tag_and_insert_text) (class in qwikstart.operations.find_tagged_line) (class in qwikstart.operations.insert_text) (class in qwikstart.operations.prompt) (class in qwikstart.operations.search_and_replace) (class in qwikstart.operations.shell) (class in qwikstart.operations.subtask)

OperationConfig (class in qwikstart.operations) (class in qwikstart.operations.base) OperationDefinition (class in qwikstart.parser.operations) OperationDefinitionError OperationError OperationHelp (class in qwikstart.cli.utils) OperationMapping (in module qwikstart.parser) operations (qwikstart.tasks.Task attribute) optional_context (qwikstart.cli.utils.OperationHelp attribute) Output (class in qwikstart.operations.find_tagged_line) output_annotations (qwikstart.cli.utils.OperationHelp attribute) output_mapping (qwikstart.operations.base.OperationConfig attribute) (qwikstart.operations.OperationConfig attribute) output_name (qwikstart.operations.find_files.Context attribute) output_namespace (qwikstart.operations.base.OperationConfig attribute) (qwikstart.operations.OperationConfig attribute)

P

parse_git_url() (in module qwikstart.repository.git) parse_operation() (in module qwikstart.parser.operations) parse_task() (in module qwikstart.parser) (in module qwikstart.parser.tasks) parse_task_steps() (in module qwikstart.parser) (in module qwikstart.parser.tasks) parsed_config() (qwikstart.parser.operations.OperationDefinition property) path() (qwikstart.repository.git.GitUrl property) path_filter (qwikstart.operations.find_files.Context attribute) PathInput (class in qwikstart.utils.input_types)

pformat_json() (in module qwikstart.utils) (in module qwikstart.utils.text_utils) 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) prefix() (qwikstart.repository.git.GitUrl property) prompt() (qwikstart.utils.input_types.InputType method) PromptSpec (class in qwikstart.utils.prompt) ptk_kwargs() (qwikstart.utils.prompt.PromptSpec property)

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.append_text (module) qwikstart.operations.base (module) qwikstart.operations.context_from_regex (module) qwikstart.operations.define_context (module) qwikstart.operations.echo (module) qwikstart.operations.edit_json (module) qwikstart.operations.edit_yaml (module) qwikstart.operations.find_files (module) qwikstart.operations.find_tag_and_insert_text (module) qwikstart.operations.find_tagged_line (module) qwikstart.operations.insert_text (module) qwikstart.operations.prompt (module) qwikstart.operations.search_and_replace (module)

qwikstart.operations.shell (module) qwikstart.operations.subtask (module) qwikstart.operations.utils (module) qwikstart.parser (module) qwikstart.parser.operations (module) qwikstart.parser.tasks (module) qwikstart.repository (module) qwikstart.repository.core (module) qwikstart.repository.git (module) qwikstart.repository.loaders (module) qwikstart.repository.yamllint (module) qwikstart.tasks (module) qwikstart.utils (module) qwikstart.utils.core (module) qwikstart.utils.dict_utils (module) qwikstart.utils.filesystem (module) qwikstart.utils.http (module) qwikstart.utils.input_types (module) qwikstart.utils.io (module) qwikstart.utils.logging (module) qwikstart.utils.prompt (module) qwikstart.utils.regex (module) qwikstart.utils.templates (module) qwikstart.utils.text_utils (module) QwikstartException

R

raw_path() (qwikstart.repository.git.GitUrl property) raw_prompt() (qwikstart.utils.input_types.BoolInput method) (qwikstart.utils.input_types.InputType method) (qwikstart.utils.input_types.IntegerInput method) read_file_contents() (in module qwikstart.utils.io) read_from_url() (in module qwikstart.utils.http) read_user_choice() (in module qwikstart.utils.prompt) read_user_variable() (in module qwikstart.utils.prompt) regex (qwikstart.operations.context_from_regex.Context attribute) (qwikstart.operations.find_files.Context attribute) regex_flags (qwikstart.operations.context_from_regex.Context attribute) (qwikstart.operations.find_files.Context attribute) 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) replace (qwikstart.operations.search_and_replace.Context attribute) repo_cache (qwikstart.config.Config attribute) repo_cache_path() (qwikstart.config.Config property) repo_path() (qwikstart.repository.BaseRepoLoader property) (qwikstart.repository.GitRepoLoader property) (qwikstart.repository.loaders.BaseRepoLoader property) (qwikstart.repository.loaders.GitRepoLoader property) (qwikstart.repository.loaders.RepoLoader property) (qwikstart.repository.RepoLoader property)

RepoLoader (class in qwikstart.repository) (class in qwikstart.repository.loaders) RepoLoaderError required_context (qwikstart.cli.utils.OperationHelp attribute) 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.add_file_tree.Operation method) (qwikstart.operations.append_text.Operation method) (qwikstart.operations.base.BaseOperation method) (qwikstart.operations.BaseOperation method) (qwikstart.operations.context_from_regex.Operation method) (qwikstart.operations.define_context.Operation method) (qwikstart.operations.echo.Operation method) (qwikstart.operations.edit_json.Operation method) (qwikstart.operations.edit_yaml.Operation method) (qwikstart.operations.find_files.Operation method) (qwikstart.operations.find_tag_and_insert_text.Operation method) (qwikstart.operations.find_tagged_line.Operation method) (qwikstart.operations.insert_text.Operation method) (qwikstart.operations.prompt.Operation method) (qwikstart.operations.search_and_replace.Operation method) (qwikstart.operations.shell.Operation method) (qwikstart.operations.subtask.Operation method)

S

search (qwikstart.operations.search_and_replace.Context attribute) separator() (qwikstart.repository.git.GitUrl property) set_nested_dict_value() (in module qwikstart.utils.dict_utils) source_dir (qwikstart.base_context.ExecutionContext attribute)

StringInput (class in qwikstart.utils.input_types) strip_empty_lines() (in module qwikstart.utils) (in module qwikstart.utils.text_utils) sync_git_repo_locally() (in module qwikstart.repository.git)

T

tag (qwikstart.operations.find_tagged_line.Context attribute) target_dir (qwikstart.base_context.ExecutionContext attribute) Task (class in qwikstart.tasks) task_spec() (qwikstart.repository.BaseRepoLoader property) (qwikstart.repository.GitRepoLoader property) (qwikstart.repository.loaders.BaseRepoLoader property) (qwikstart.repository.loaders.GitRepoLoader property) (qwikstart.repository.loaders.RepoLoader property) (qwikstart.repository.RepoLoader property)

TaskParserError template_variable_prefix() (qwikstart.utils.templates.TemplateContext property) template_variables() (qwikstart.utils.templates.TemplateContext property) 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)

use_regex (qwikstart.operations.search_and_replace.Context attribute) UserFacingError

V

validator() (qwikstart.utils.input_types.InputType property)