Skip to content

Commit 2bf7de9

Browse files
committed
Update tooling documentation
1 parent 92b3a7c commit 2bf7de9

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,16 +72,37 @@ To successfully run scripts that require client credentials, you will need to fo
7272
- [flake8][flake8]: a python tool that glues together pep8, pyflakes, mccabe,
7373
and third-party plugins to check the style and quality of some python code.
7474
- [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.
7594
7695
[ccospyguide]: https://opensource.creativecommons.org/contributing-code/python-guidelines/
7796
[black]: https://github.com/psf/black
7897
[flake8]: https://gitlab.com/pycqa/flake8
7998
[isort]: https://pycqa.github.io/isort/
99+
[tools.sh]: /dev/tools.sh
100+
[python_static_analysis.yml]: .github/workflows/python_static_analysis.yml
80101
81102
82103
## Data Sources
83104
84-
Kindly visit the [`sources.md`](sources.md) file for it.
105+
Kindly visit the [sources.md](sources.md) file for it.
85106
86107
87108
## History

0 commit comments

Comments
 (0)