Update README file
This commit is contained in:
parent
0bb3d86ab3
commit
bff5e318f5
1 changed files with 19 additions and 5 deletions
22
README.md
22
README.md
|
@ -1,17 +1,31 @@
|
|||
# Docker image to run pre-commit on Python apps/libraries
|
||||
|
||||
Image with common dependencies to run pre-commit in Python apps/libraries:
|
||||
Debian stable based image with common dependencies to run `pre-commit` on Python apps/libraries:
|
||||
|
||||
- common python packages: `python3-all python3-dev python3-pip python3-venv pylint3`
|
||||
- common python packages: `python3-all python3-dev python3-pip python3-venv pylint`
|
||||
- `build-essential` to allow local python package using `pip`
|
||||
- `pre-commit` and `git` commands
|
||||
- pre-install `pre-commit` environments for `pylint`, `pyupgrade`, `black` and `isort`
|
||||
- pre-install `pre-commit` environments for `ruff`, `pyupgrade`, `black`, `isort`,
|
||||
`flake8`, `codespell`, `yamllint`, `prettier`, `pylint` and `bandit`.
|
||||
|
||||
To use it:
|
||||
|
||||
```bash
|
||||
docker run -it -v "$(pwd)":/src -w /src brenard/python-pre-commit
|
||||
docker run \
|
||||
-it --rm \
|
||||
-v "$(pwd)":/src -w /src \
|
||||
brenard/python-pre-commit \
|
||||
pre-commit run --all-files
|
||||
```
|
||||
|
||||
**Note:** an example `.pre-commit-config.yaml` file is provided with Docker image source.
|
||||
To test it on your project, use to following command:
|
||||
|
||||
```bash
|
||||
docker run \
|
||||
-it --rm \
|
||||
-v "$(pwd)":/src -w /src \
|
||||
-v "$(pwd)/.pre-commit-config.yaml":/src/.pre-commit-config.yaml \
|
||||
brenard/python-pre-commit \
|
||||
pre-commit run --all-files
|
||||
```
|
||||
|
|
Loading…
Reference in a new issue