https://github.com/nanato12/pychecker
GitHub Action for Python code check
https://github.com/nanato12/pychecker
github-action github-actions-ci python
Last synced: 5 months ago
JSON representation
GitHub Action for Python code check
- Host: GitHub
- URL: https://github.com/nanato12/pychecker
- Owner: nanato12
- License: apache-2.0
- Created: 2020-11-18T15:17:37.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-09-11T00:44:17.000Z (over 4 years ago)
- Last Synced: 2025-07-08T05:00:39.975Z (6 months ago)
- Topics: github-action, github-actions-ci, python
- Language: Shell
- Homepage: https://github.com/marketplace/actions/pychecker
- Size: 32.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pychecker
GitHub Action for Python code check
Pythonのコードチェック用のGitHub Action
## check
- black
- flake8
- mypy
- isort
このActionでは上記4点が評価されます。
## How to use
Write `.github/workflows/main.yml`.
使用するには`.github/workflows/main.yml`に追記してください。
```yml
- name: GitHub Action for Python code check
uses: nanato12/pychecker@master
with:
path: './'
```
Refer to this: [main.yml](.github/workflows/main.yml)
こちらを参考に: [main.yml](.github/workflows/main.yml)
## Options [required]
Write the options for each check to `setup.cfg`.
各チェックのオプションは`setup.cfg`に記載してください。
**If `setup.cfg` does not exist, each check will conflict.**
**もし、`setup.cfg` が存在しない場合、各チェックは競合し失敗します。**
Recommended:
おすすめ:
```conf
[flake8]
extend-ignore = E203, E501
exclude = __init__.py
[isort]
multi_line_output=3
include_trailing_comma = True
force_grid_wrap = 0
use_parentheses = True
ensure_newline_before_comments = True
line_length = 88
[mypy]
disallow_untyped_calls = True
disallow_untyped_defs = True
```
## For myself :3
```bash
docker build . -t pychecker
docker run --workdir /workspace -v $PWD:/workspace pychecker /workspace
```