Skip to main content

[![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.

Metadata

Release files for flowtool-githooks-demo 0.7.24

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for flowtool-githooks-demo 0.7.24
File Interpreter ABI Platform
flowtool_githooks_demo-0.7.24-py2.py3-none-any.whl Python 3, Python 2 none any Details

Release files / flowtool_githooks_demo-0.7.24-py2.py3-none-any.whl

Download URL flowtool_githooks_demo-0.7.24-py2.py3-none-any.whl
Size 11.1 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
f28c066f1c249751f7eef8e7aaadcdb52d9e02ab12b40c1717ba955db33b2f81
BLAKE2b-256 checksum
How to use checksums
8ed826e2c82474c9627044a8b438d022afaa3b2dd6cc61d25924246833e5056f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for flowtool-githooks-demo 0.7.24

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page