Create git hooks with ease using a simple configuration file in a git project
Project description
# 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 in a git project
## 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` in you virtual environment.
* 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).
[![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 in a git project
## 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` in you virtual environment.
* 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).
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
python-githooks-1.0.2.tar.gz
(2.7 kB
view hashes)
Built Distribution
Close
Hashes for python_githooks-1.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 18f2b224a01ef8fc17f4fdd2a2bf7c398c1b747c305e8f117838975b9653a252 |
|
MD5 | ce7f9e9abbed3ec814f30610c0ec198b |
|
BLAKE2b-256 | b12f7247b73e89abb1eef3d1c3eae4324b5749d72635258fbd8c913b3c2022fe |