Framework for Python

Git

git_hooks_list()

The hook checks and whether each is enabled.

Usage

git_hooks_list(settings_file: str | Path | None = None) -> pd.DataFrame

Arguments

Name Type Default Description
settings_file str | Path | None None

The project's settings file. Default: the settings.yml or config.yml found from the current directory.

Value

A DataFrame with columns hook, enabled, and description. Its attrs["installed"] says whether the pre-commit hook is installed.