This repository contains code related to the LWEC/Tree Health/THAPBI project.
In this project, we're trying to keep to the Python PEP8 style convention, the PEP257 docstring conventions, and the Zen of Python. To help in this, a pre-commit hook script is provided in the git_hooks subdirectory that, if deployed in the Git repository, checks Python code for PEP8 correctness before permitting a git commit command to go to completion.
To install the pre-commit hook:
- clone the repository with
git clone https://github.com/widdowquinn/THAPBI(you may already have done this) - change directory to the root of the repository with
cd THAPBI - copy the pre-commit script to the
.git/hooksdirectory withcp git_hooks/pre-commit .git/hooks/
- Git hooks (
git): https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks - Git hooks (tutorial): http://githooks.com/
- PEP8: https://www.python.org/dev/peps/pep-0008/
- PEP257: https://www.python.org/dev/peps/pep-0257/
- Zen of Python (PEP20): https://www.python.org/dev/peps/pep-0020/