You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+22-1Lines changed: 22 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -72,16 +72,37 @@ To successfully run scripts that require client credentials, you will need to fo
72
72
- [flake8][flake8]: a python tool that glues together pep8, pyflakes, mccabe,
73
73
and third-party plugins to check the style and quality of some python code.
74
74
- [isort][isort]: A Python utility / library to sort imports.
75
+
- **Helper Scripts:**
76
+
- [`/dev/tools.sh`][tools.sh]: A script that runs `isort`, `black`, and `flake8` to automatically format and check the codebase for style issues.
77
+
78
+
To use the script, simply run the following command.
79
+
```
80
+
./dev/tools.sh
81
+
```
82
+
It can also accept command-line arguments to specify specific files or directories to check.
83
+
84
+
For example:
85
+
```
86
+
./dev/tools.sh path/to/my/file.py
87
+
```
88
+
- **GitHub Actions:**
89
+
- [`.github/workflows/python_static_analysis.yml`][python_static_analysis.yml]: A github workflow that checks the quality and style of code also using `isort`, `black`, and `flake8`.
90
+
91
+
The workflow is triggered automatically when you push changes to the main branch or open a pull request.
92
+
93
+
Once it's completed, review the results and fix any issues reported by the tools.
0 commit comments