Library for managing git hooks
Project description
Autohooks
Library for managing and writing git hooks
in Python using pyproject.toml
for its settings.
Looking for automatic formatting and linting, e.g., with black and ruff,
while creating a git commit using a pure Python implementation? Do you just want
to have your git hook settings in the pyproject.toml
file too?
Welcome to autohooks!
- Why?
- Solution
- Requirements
- Plugins
- Installing autohooks
- Command Completion
- Maintainer
- Contributing
- License
Why?
Several outstanding libraries for managing and executing git hooks exist already. To name a few: husky, lint-staged, precise-commits or pre-commit.
However, they need another interpreter besides python (like husky), require a
different config file besides pyproject.toml
or are too ambiguous (like
pre-commit). pre-commit is written in python but has support hooks written in
all kind of languages. Additionally, it maintains the dependencies by itself and
does not install them in the current environment.
Solution
autohooks is a pure python library that installs a minimal
executable git hook.
It allows the decision of how to maintain the hook dependencies
by supporting different modes and stores its settings in the well known
pyproject.toml
file.
Requirements
Python 3.9+ is required for autohooks.
Plugins
-
Python code formatting via black
-
Python code formatting via autopep8
-
Python code linting via ruff
-
Python code linting via pylint
-
Python code linting via flake8
-
Python code linting via mypy
-
Python import sorting via isort
-
Running tests via pytest
Installing autohooks
Quick installation of ruff and black plugins using poetry:
poetry add --dev autohooks autohooks-plugin-black autohooks-plugin-ruff
poetry run autohooks activate --mode poetry
poetry run autohooks plugins add autohooks.plugins.black autohooks.plugins.ruff
The output of autohooks activate
should be similar to
✓ autohooks pre-commit hook installed at /autohooks-test/.git/hooks/pre-commit using poetry mode.
Autohooks has an extensible plugin model. Each plugin provides different functionality which often requires to install additional dependencies.
For managing these dependencies currently three modes are supported by autohooks:
pythonpath
for dependency management via pippoetry
for dependency management via poetry (recommended)pipenv
for dependency management via pipenv
These modes handle how autohooks, the plugins and their dependencies are loaded during git hook execution.
If no mode is specified in the pyproject.toml
config file
and no mode is set during activation, autohooks
will use the pythonpath mode by default.
For more details on using pip, poetry or pipenv in conjunction with these modes see the documentation.
Command Completion
autohooks
comes with support for command line completion in bash
and zsh.
Setup for bash
echo "source ~/.autohooks-complete.bash" >> ~/.bashrc
autohooks --print-completion bash > ~/.autohooks-complete.bash
Alternatively, you can use the result of the completion command directly with the eval function of your bash shell:
eval "$(autohooks --print-completion bash)"
Setup for zsh
echo 'fpath=("$HOME/.zsh.d" $fpath)' >> ~/.zsh
mkdir -p ~/.zsh.d/
autohooks --print-completion zsh > ~/.zsh.d/_autohooks
Alternatively, you can use the result of the completion command directly with the eval function of your zsh shell:
eval "$(autohooks --print-completion zsh)"
Maintainer
This project is maintained by Greenbone AG.
Contributing
Your contributions are highly appreciated. Please create a pull request on GitHub. Bigger changes need to be discussed with the development team via the issues section at GitHub first.
License
Copyright (C) 2019 - 2024 Greenbone AG
Licensed under the GNU General Public License v3.0 or later.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file autohooks-24.2.0.tar.gz
.
File metadata
- Download URL: autohooks-24.2.0.tar.gz
- Upload date:
- Size: 74.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.8
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ee929a9f7ff68e61c73201de817b679df168b4465be1026550a71956b419200b |
|
MD5 | 78709f2839078572864e91956cb19e15 |
|
BLAKE2b-256 | 8b9d29e14a12211fedd24eb971ccda2eefba745f73b738098662651c4a7b2083 |
File details
Details for the file autohooks-24.2.0-py3-none-any.whl
.
File metadata
- Download URL: autohooks-24.2.0-py3-none-any.whl
- Upload date:
- Size: 35.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.8
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a2097de2e092fa7b78a17b63b73980d3cc42b01065feb2caf0d41e2bb506621b |
|
MD5 | 30b164ee721271c6766c7a1f259a4daa |
|
BLAKE2b-256 | f056782de8fe79c99777cfdef761bfdd232f1557b7e24b3e81cc676f59006f95 |