https://github.com/laactech/pre-commit-config-latest
Configuration files for automatically linting and formatting Python code on git commit
https://github.com/laactech/pre-commit-config-latest
bandit black flake8 formatting isort linting mypy pre-commit python
Last synced: about 2 months ago
JSON representation
Configuration files for automatically linting and formatting Python code on git commit
- Host: GitHub
- URL: https://github.com/laactech/pre-commit-config-latest
- Owner: laactech
- License: bsd-3-clause
- Created: 2020-10-07T13:10:46.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-11-01T16:43:45.000Z (almost 4 years ago)
- Last Synced: 2024-10-28T14:39:16.839Z (12 months ago)
- Topics: bandit, black, flake8, formatting, isort, linting, mypy, pre-commit, python
- Homepage:
- Size: 4.88 KB
- Stars: 3
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Pre-commit Config Latest
[pre-commit](https://pre-commit.com/) is used to install Python code linting and
formatting tools:
* [flake8](http://flake8.pycqa.org/en/latest/) a Python style guide linter
* [bandit](https://github.com/PyCQA/bandit) a Python security vulnerability linter
* [black](https://black.readthedocs.io/en/stable/) a Python automatic code formatter
* [isort](https://github.com/timothycrosley/isort) a Python automatic import formatter
* [mypy](https://github.com/python/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
1. `git add` the previous files to your git repository
1. Run `pip install pre-commit`
1. Add pre-commit to your project's requirements
1. Run `pre-commit install`
1. `git commit` the new configuration files
1. Run `pre-commit run -a` to lint and format your entire project
1. `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.