qwikstart package

Subpackages

• qwikstart.cli package
  • Submodules
  • qwikstart.cli.main module
  • qwikstart.cli.resolver module
  • qwikstart.cli.utils module
  • Module contents
• qwikstart.operations package
  • Submodules
  • qwikstart.operations.add_file module
  • qwikstart.operations.add_file_tree module
  • qwikstart.operations.append_text module
  • qwikstart.operations.base module
  • qwikstart.operations.define_context module
  • qwikstart.operations.echo 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.utils module
  • Module contents
• qwikstart.parser package
  • Submodules
  • qwikstart.parser.operations module
  • qwikstart.parser.tasks module
  • Module contents
• qwikstart.repository package
  • Submodules
  • qwikstart.repository.base module
  • qwikstart.repository.git module
  • qwikstart.repository.local module
  • Module contents
• qwikstart.utils package
  • Submodules
  • 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.utils.text_utils module
  • Module contents

Submodules

qwikstart.base_context module

class qwikstart.base_context.BaseContext(execution_context:qwikstart.base_context.ExecutionContext)

Bases: object

classmethod from_dict(field_dict: Mapping[str, Any]) → TContext

Return instance of context, ignoring unknown keys in field_dict.

Adapted from https://stackoverflow.com/a/55096964/260303.

classmethod help(field_name: str) → Optional[str]

class qwikstart.base_context.ExecutionContext(source_dir:pathlib.Path, target_dir:pathlib.Path)

Bases: object

get_template_loader() → jinja2.loaders.BaseLoader

source_dir = None

Source directory defining qwikstart task. Templates and other data files are relative to this location.

target_dir = None

Target directory for qwikstart modifications. In practice, this will be set to the working directory by the CLI.

qwikstart.config module

class qwikstart.config.Config(qwikstart_cache:str, git_abbreviations:Dict[str, str])

Bases: object

qwikstart_cache_path

qwikstart.config.get_user_config() → qwikstart.config.Config

qwikstart.config.load_custom_config_file() → Dict[str, Any]

qwikstart.exceptions module

qwikstart.exceptions

All exceptions used in the qwikstart code base are defined here.

exception qwikstart.exceptions.ConfigurationError

Bases: qwikstart.exceptions.UserFacingError

User-facing exception raised during qwikstart configuration.

exception qwikstart.exceptions.OperationDefinitionError

Bases: qwikstart.exceptions.QwikstartException

Exception raised when an operation is improperly defined.

exception qwikstart.exceptions.OperationError

Bases: qwikstart.exceptions.UserFacingError

User-facing exception raised during execution of operation.

exception qwikstart.exceptions.QwikstartException

Bases: Exception

Base exception class. All qwikstart-specific exceptions should subclass this.

exception qwikstart.exceptions.RepoLoaderError

Bases: qwikstart.exceptions.QwikstartException

Exception raised when loading task specification fails.

exception qwikstart.exceptions.TaskParserError

Bases: qwikstart.exceptions.UserFacingError

User-facing exception raised when parsing task specification fails.

exception qwikstart.exceptions.UserFacingError

Bases: qwikstart.exceptions.QwikstartException

Base exception for errors that are meant to be displayed to users.

qwikstart.tasks module

class qwikstart.tasks.Task(operations: Sequence[qwikstart.operations.base.BaseOperation], context: Dict[str, Any])

Bases: object

A series of operations to complete an qwikstart task.

execute() → Dict[str, Any]

Module contents