cookiecutter_python.hooks package

Submodules

cookiecutter_python.hooks.pre_gen_project module

exception cookiecutter_python.hooks.pre_gen_project.InputValueError

Bases: Exception

exception cookiecutter_python.hooks.pre_gen_project.RegExMissMatchError

Bases: Exception

cookiecutter_python.hooks.pre_gen_project.get_request()

cookiecutter_python.hooks.pre_gen_project.get_verify_callback(error_message, log_message_getter)

cookiecutter_python.hooks.pre_gen_project.hook_main(request)

cookiecutter_python.hooks.pre_gen_project.main()

cookiecutter_python.hooks.pre_gen_project.verify_input_with_regex_callback(verify_callback, exception_message=None)

cookiecutter_python.hooks.pre_gen_project.verify_regex_and_log(message_getter)

cookiecutter_python.hooks.pre_gen_project.verify_templated_module_name(module: str)

cookiecutter_python.hooks.pre_gen_project.verify_templated_semantic_version(version: str)

cookiecutter_python.hooks.post_gen_project module

Cookiecutter post generation hook script that handles operations after the template project is used to generate a target project.

cookiecutter_python.hooks.post_gen_project.get_templated_vars()

cookiecutter_python.hooks.post_gen_project.git_add(project_dir: str)

Do a Git add operation on the generated project.

cookiecutter_python.hooks.post_gen_project.git_commit(request)

Commit the staged changes in the generated project.

cookiecutter_python.hooks.post_gen_project.grant_basic_permissions(project_dir: str)

cookiecutter_python.hooks.post_gen_project.initialize_git_repo(project_dir: str)

Initialize the Git repository in the generated project.

cookiecutter_python.hooks.post_gen_project.is_git_repo_clean(project_directory: str)

Check to confirm if the Git repository is clean and has no uncommitted changes. If its clean return True otherwise False.

cookiecutter_python.hooks.post_gen_project.main(request)

cookiecutter_python.hooks.post_gen_project.python36_n_below_run_params(project_directory: str)

cookiecutter_python.hooks.post_gen_project.python37_n_above_run_params(project_directory: str)

Module contents