Trivial demo tasks for git users.
Project description
[![PyPI Python Versions](https://img.shields.io/pypi/pyversions/flowtool-githooks-demo.svg)](https://pypi.python.org/pypi/flowtool-githooks-demo) [![PyPI Latest Version](https://img.shields.io/pypi/v/flowtool-githooks-demo.svg)](https://pypi.python.org/pypi/flowtool-githooks-demo) [![PyPI Distribution Format](https://img.shields.io/pypi/format/flowtool-githooks-demo.svg)](https://pypi.python.org/pypi/flowtool-githooks-demo)
# flowtool-githooks-demo
This package contains some example git hooks.
The hooks are made runnable via console_scripts entry points. The hooks are also recognized by the flowtool-githooks management via entry points. That just means for a user of this tool, that the hooks will show up in the ft githooks-scripts menu automatically, and can also be run via their name from the command line.
## Setting things up
`shell $ pip install flowtool-githooks-demo ` Then you can install the hook runner and set up the demo hook by using these commands:
`shell $ flowtool githooks-install $ flowtool githooks-scripts --hook pre-commit --add _flowtool_githooks.demo $ flowtool githooks-scripts --hook commit-msg --add _flowtool_githooks.demo $ flowtool githooks-scripts --hook pre-push --add _flowtool_githooks.demo `
To configure the hooks interactively:
`shell $ flowtool githooks-scripts --help $ flowtool githooks-scripts `
To unistall the hooks use:
`shell $ flowtool githooks-scripts --hook pre-commit --remove _flowtool_githooks.demo $ flowtool githooks-wipe `
## _flowtool_githooks.demo
A git hook to showcase the possibilities of git hooks. It prints its (command line) arguments and various information that may or may not be interesting to someone developing a hook for his own purposes.
As one main feature, it reads it’s standard input non-blocking and outputs it if there is anything, since only some hooks get additional information passed in via stdin.
## _flowtool_githooks.demo_fail
A git hook that will always fail.
Good to test what a non-zero exit status will do for certain hooks.
## _flowtool_githooks.shellcheck
A step towards a collection of git hooks, that wrap code checkers. This one wraps [shellcheck](https://github.com/koalaman/shellcheck), a shell script syntax, style and security checker.
## _flowtool_githooks.yamllint
One more step towards a collection of useful git hooks. This one wraps [yamllint](https://github.com/adrienverge/yamllint), a yaml linter.
## _flowtool_githooks.markdownlint
One more step towards a collection of useful git hooks. This one wraps [pymarkdownlint](https://github.com/jorisroovers/pymarkdownlint), a markdown linter.
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
Hashes for flowtool-githooks-demo-0.7.18.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 661f1fe4a2adab5fa988e0b6a8e8fbb10eefa83023e62ca0055863162f0bdb0c |
|
MD5 | c4daf8eede5506e492a56f9ec07cdc47 |
|
BLAKE2b-256 | 317124379eb2069d19b45d7efee68ed8be2137e7860208005f1f71c603339fb5 |
Hashes for flowtool_githooks_demo-0.7.18-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fb3ea2c966e12cebc5a73c8db559e959171ea6e1e5e552a796a7642fe1fb255c |
|
MD5 | b0fc859311b7037e2f0e9a72370cbf25 |
|
BLAKE2b-256 | c24f78fa2c347f5801f898697c50dfb26ae7a04feb685a44c04a747fbb81a7f4 |