Metadata-Version: 2.1
Name: python-githooks
Version: 1.0.0
Summary: Create git hooks with ease using a simple configuration file
Home-page: https://github.com/ygpedroso/python-githooks
Author: Yannier González Pedroso
Author-email: ygpedroso2503@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development
Description-Content-Type: text/markdown
Requires-Dist: configparser

# python-githooks

[![code linting: flake8](https://img.shields.io/badge/lint-flake8-blue.svg)](http://flake8.pycqa.org/)  [![code quality: pytest](https://img.shields.io/badge/test-pytest-yellow.svg)](https://docs.pytest.org/) [![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/)

> Create git hooks with ease using a simple configuration file

## Install
```bash
pip install python-githooks
```

## Usage
1. Create a `.githooks.ini` configuration file(If not provided a dummy configuration file will be created).
2. Add sections based on `git hooks names`  followed by a `command` property with the shell code you want to run.
3. Run either `python -m python_githooks` or `githooks`.
* Configuration file Example:
```
[pre-commit]
command = pytest --cov

[pre-push]
command = pytest --cov && flake8
```

## License
python-githooks is [MIT-licensed](https://github.com/ygpedroso/python-githooks/blob/master/LICENSE).


