bn8/docker-python-pre-commit
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update README file

Browse source
This commit is contained in:
Benjamin Renard 2024-02-13 13:34:45 +01:00
parent 0bb3d86ab3
commit bff5e318f5
Signed by: bn8
GPG key ID: 3E2E1CE1907115BC
1 changed files with 19 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -1,17 +1,31 @@
# Docker image to run pre-commit on Python apps/libraries # 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` - `build-essential` to allow local python package using `pip`
- `pre-commit` and `git` commands - `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: To use it:
```bash ```bash
docker run -it -v "$(pwd)":/src -w /src brenard/python-pre-commit docker run \
pre-commit run --all-files -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. **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
```