beccam / github-stats

Python scripts for pulling views, clones, stars, forks, contributors, commits from GitHub API. Optionally write to a Google Sheet

github-stats

Pulls Github views, commits, or contributors for a repo and writes the data to a csv file

Prerequisites

1. Python 3
2. PyGithub installed - pip install PyGithub
3. Push access - the Github Traffic API requires push access to see view statistics

Running

Views

Get views counts for all repos in an org for a 7 day period, beginning with the day specified as -s

This will output text to the console and produce a .csv file named github-stats-views-<github-org>-YYYY-MM-DD.csv

python GithubStats.py -m views -t <token> -o <github-org> -s <YYYY-MM-DD>

Commits

Get commits for a 7 day period, beginning with the day specified as -s

This will produce a .csv file named github-stats-commits-<github-org>-<github-repo>-YYYY-MM-DD.csv

python GithubStats.py -m commits -t <token> -o <github-org> -r <github-repo> -s <YYYY-MM-DD>

Contributors

Get contributors count for a repo

This will produce a .csv file named github-stats-contributors-<github-org>-<github-repo>-YYYY-MM-DD.csv

python GithubStats.py -m contributors -t <token> -o <github-org> -r <github-repo> -s <YYYY-MM-DD>

References

Get repositories created that reference a term

This produces output to the console

python GithubStats.py -m refs -t <token> -x <term> -s <YYYY-MM-DD> -e <YYYY-MM-DD>

Send all stats to a Google Sheet

Get views (unique and count), clones (unique and count), stars, forks, issues, comments, and reactions

This sends a row to the specified Google Sheet

python GithubStats.py -m usage -t <token> -o <org> -r <repo> -g --gsheet_creds_file=<service-account-json> --gsheet_name=<google-sheet-name> --gsheet_worksheet_name=<worksheet-name>