Pre-commit Config Latest

pre-commit is used to install Python code linting and formatting tools:

• flake8 a Python style guide linter
• bandit a Python security vulnerability linter
• black a Python automatic code formatter
• isort a Python automatic import formatter
• mypy an optional type checker for Python

Getting started

Requires python >=3.6, pre-commit>=1.14 and a git repository

1. Copy the following files to the root of your Python project's git repository:
   • .pre-commit-config.yaml
   • .flake8
   • pyproject.toml
2. git add the previous files to your git repository
3. Run pip install pre-commit
4. Add pre-commit to your project's requirements
5. Run pre-commit install
6. git commit the new configuration files
7. Run pre-commit run -a to lint and format your entire project
8. git add and git commit the formatting and linting changes once you've resolved any issues

Now on every commit, pre-commit will use a git hook to run the tools. Warning: the first commit will take some time because the tools are being installed by pre-commit

Resolving failed commits

• If black or isort fail, they have reformatted your code. git add and git commit the changes.
• If flake8, bandit, or mypy fail, they will output a complaint and where that complaint exists. Fix the code that they complain about and git add and git commit the changes.