Skip to content

Commit

Permalink
add repo health status report script (#36935)
Browse files Browse the repository at this point in the history
* initial commit

* wip

* working

* write to html

* sorted

* fix black, add filters for include_sdk_owned and omit_good, sort libraries for markdown/html

* add sla status

* add default comments

* remove debug comment

* structure csv report to work with powerbi

* feedback

* fix some typing

* Update health report

* updates + fix html/markdown report

* rename things

* add short readme
  • Loading branch information
kristapratico authored Aug 16, 2024
1 parent 372fd7d commit 494b19b
Show file tree
Hide file tree
Showing 3 changed files with 902 additions and 0 deletions.
14 changes: 14 additions & 0 deletions scripts/repo_health_status_report/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Python SDK Health Status Report

This script generates a health status report for the Python SDK. The report can be found at [aka.ms/azsdk/python/health](https://www.aka.ms/azsdk/python/health).

# How to run the script

1. pip install -r dev_requirements.txt
2. az login
3. Set the `GH_TOKEN` environment variable to your [GitHub PAT](https://github.com/settings/tokens) (with repo permissions).
4. Run the script: `python output_health_report.py`

## Command line options

By default, the script will generate a csv report. To generate a report in markdown or html, pass `-f markdown` or `-f html`, respectively. To omit SDK team owned libraries from the report, pass `-s`.
6 changes: 6 additions & 0 deletions scripts/repo_health_status_report/dev_requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
httpx==0.25.2
markdown==3.6
PyGitHub>=1.59.0
setuptools==67.6.0
-e ../../sdk/identity/azure-identity
-e ../../tools/azure-sdk-tools
Loading

0 comments on commit 494b19b

Please sign in to comment.