Skip to content

Latest commit

 

History

History
58 lines (41 loc) · 1.48 KB

README.md

File metadata and controls

58 lines (41 loc) · 1.48 KB
Raw

PyAction

One-stop, zero-configuration GitHub Action for linting and enforcing style in Python projects.

Screenshot of annotations

Features

  • Zero configuration based: Add a single line in your CI and done!
  • GitHub Annotations on PR: Highlights issues inline on the PR diff.
  • all of most popular community trusted linters in one place.

Linters supported

Usage

Basic:

steps:
  - uses: actions/checkout@v1
  - uses: rahul-deepsource/[email protected]

Options:

steps:
  - uses: actions/checkout@v1
  - uses: rahul-deepsource/[email protected]
    with:
      python-root-list: "src/ tests/"
      use-pycodestyle: false
      use-mypy: false
      use-vulture: true
      extra-pylint-options: "--output-format="colorized"

License

The scripts and documentation in this project are released under the MIT License

Contributions

Contributions are welcome! See CONTRIBUTING.md

Thanks to

  • Ricardo Baltazar Chaves' python-lint which was used as a starting point for this project.
  • Florian Bruhin who provided most of the regular expressions for problem matchers.