https://github.com/ricardochaves/python-lint
GitHub Action for Lint your code
https://github.com/ricardochaves/python-lint
black flake8 github-actions isort mypy pycodestyle pylint
Last synced: 6 months ago
JSON representation
GitHub Action for Lint your code
- Host: GitHub
- URL: https://github.com/ricardochaves/python-lint
- Owner: ricardochaves
- License: mit
- Created: 2019-11-30T19:56:42.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-01-04T11:32:02.000Z (almost 2 years ago)
- Last Synced: 2024-10-22T03:26:17.019Z (12 months ago)
- Topics: black, flake8, github-actions, isort, mypy, pycodestyle, pylint
- Language: Shell
- Homepage:
- Size: 24.4 KB
- Stars: 92
- Watchers: 2
- Forks: 41
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# python-lint
## About
This action must be used for aplication the bids:
- [black](https://github.com/psf/black)
- [pylint](https://www.pylint.org/)
- [isort](https://github.com/timothycrosley/isort)
- [pycodestyle](https://pycodestyle.readthedocs.io)
- [flake8](http://flake8.pycqa.org)
- [mypy](http://mypy-lang.org/)
## Usage
See [action.yml](action.yml)
Basic:
```yml
steps:
- uses: actions/checkout@v4
- uses: ricardochaves/python-lint@v1.4.0
```
Options:
```yml
steps:
- uses: actions/checkout@v4
- uses: ricardochaves/python-lint@v1.4.0
with:
python-root-list: "python_alelo tests"
use-pylint: false
use-pycodestyle: false
use-flake8: false
use-black: false
use-mypy: false
use-isort: false
extra-pylint-options: ""
extra-pycodestyle-options: ""
extra-flake8-options: ""
extra-black-options: ""
extra-mypy-options: ""
extra-isort-options: ""
```
Command build logic list:
```bash
pylint $(extra-pylint-options) $(python-root-list)
pycodestyle $(extra-pycodestyle-options) $(python-root-list)
flake8 $(extra-flake8-options) $(python-root-list)
black --check $(extra-black-options) $(python-root-list)
mypy $(extra-mypy-options) $(python-root-list)
isort $(extra-isort-options) $(python-root-list) -c --diff
```
## Versions used
To identify the version used you must consult the [CHANGELOG.md](https://github.com/ricardochaves/python-lint-image/blob/master/CHANGELOG.md) of the image used in our [Dockerfile](https://github.com/ricardochaves/python-lint-image/blob/master/Dockerfile).
## Test locally
Use [act](https://github.com/nektos/act) to test the action locally.
Unfortunately it still doesn't work on all OSs, if you can't use it try the solution below.
Some libs may behave differently between OSs.
That's why this action runs on a docker image. This makes it possible for us to test some things locally.
Using `docker compose`, add the following service
```yml
test-lint:
image: ricardobchaves6/python-lint-image:1.3.0
working_dir: /app
volumes:
- .:/app
command: ["mypy", "."]
```
Use the commands described in the section above. Choose the version of the image equivalent to the version of the action.
## License
The scripts and documentation in this project are released under the [MIT License](LICENSE)
## Contributions
Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md)