README.md

python-lint

About

This action must be used for aplication the bids:

• black
• pylint
• isort
• pycodestyle
• flake8
• mypy

Usage

See action.yml

Basic:

steps:
  - uses: actions/checkout@v4
  - uses: ricardochaves/[email protected]

Options:

steps:
  - uses: actions/checkout@v4
  - uses: ricardochaves/[email protected]
    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:

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 of the image used in our Dockerfile.

Test locally

Use 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

  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

Contributions

Contributions are welcome! See CONTRIBUTING.md