Skip to content

Commit 835f57f

Browse files
authored
Merge pull request #58 from Paulooh007/main
Update tooling documentation for helper script and github action
2 parents 7ae63ff + 4aadd64 commit 835f57f

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,11 +76,20 @@ follow these steps:
7676
7777
### Static analysis
7878
79-
The `dev/tools.sh` helper script runs the static analysis tools:
79+
The [`dev/tools.sh`][tools-sh] helper script runs the static analysis tools
80+
(`black`, `flake8`, and `isort`):
8081
```shell
8182
./dev/tools.sh
8283
```
8384
85+
It can also accept command-line arguments to specify specific files or
86+
directories to check:
87+
```shell
88+
./dev/tools.sh PATH/TO/MY/FILE.PY
89+
```
90+
91+
[tools-sh]: /dev/tools.sh
92+
8493
8594
### Resources
8695
@@ -99,6 +108,16 @@ The `dev/tools.sh` helper script runs the static analysis tools:
99108
[pipenv]: https://github.com/pypa/pipenv
100109

101110

111+
### GitHub Actions
112+
113+
The [`.github/workflows/python_static_analysis.yml`][workflow-static-analysis]
114+
GitHub Actions workflow performs static analysis (`black`, `flake8`, and
115+
`isort`) on committed changes. The workflow is triggered automatically when you
116+
push changes to the main branch or open a pull request.
117+
118+
[workflow-static-analysis]: .github/workflows/python_static_analysis.yml
119+
120+
102121
## Data sources
103122

104123
Kindly visit the [`sources.md`](sources.md) file for it.
@@ -140,4 +159,4 @@ The documentation within the project is licensed under a [Creative Commons
140159
Attribution 4.0 International License][cc-by].
141160

142161
[cc-by-png]: https://licensebuttons.net/l/by/4.0/88x31.png#floatleft "CC BY 4.0 license button"
143-
[cc-by]: https://creativecommons.org/licenses/by/4.0/ "Creative Commons Attribution 4.0 International License"
162+
[cc-by]: https://creativecommons.org/licenses/by/4.0/ "Creative Commons Attribution 4.0 International License"

0 commit comments

Comments
 (0)