Skip to content

Commit

Permalink
Merge pull request #58 from Paulooh007/main
Browse files Browse the repository at this point in the history
Update tooling documentation for helper script and github action
  • Loading branch information
TimidRobot authored Oct 26, 2023
2 parents 7ae63ff + 4aadd64 commit 835f57f
Showing 1 changed file with 21 additions and 2 deletions.
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,11 +76,20 @@ follow these steps:
### Static analysis
The `dev/tools.sh` helper script runs the static analysis tools:
The [`dev/tools.sh`][tools-sh] helper script runs the static analysis tools
(`black`, `flake8`, and `isort`):
```shell
./dev/tools.sh
```
It can also accept command-line arguments to specify specific files or
directories to check:
```shell
./dev/tools.sh PATH/TO/MY/FILE.PY
```
[tools-sh]: /dev/tools.sh
### Resources
Expand All @@ -99,6 +108,16 @@ The `dev/tools.sh` helper script runs the static analysis tools:
[pipenv]: https://github.com/pypa/pipenv


### GitHub Actions

The [`.github/workflows/python_static_analysis.yml`][workflow-static-analysis]
GitHub Actions workflow performs static analysis (`black`, `flake8`, and
`isort`) on committed changes. The workflow is triggered automatically when you
push changes to the main branch or open a pull request.

[workflow-static-analysis]: .github/workflows/python_static_analysis.yml


## Data sources

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

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

0 comments on commit 835f57f

Please sign in to comment.