tejasa97 / github_traffic

A GitHub traffic scraper to keep you on top of your repository traffic stats.

GitHub Traffic

Like to to keep tabs on your GitHub account traffic statistics?
Fret no more.

Presenting, a GitHub traffic scraper to keep you on top of your repository traffic stats.

A couple of pre-requisites before you kick off.

1. GitHub Personal Access token! (because identity).
   Just generate a new token (can set it up for only repo read permissions); you can also use an existing one.
   Assign it to token in the config.ini file.
   

[github]
token=<personal_access_token>

2. Install the official python GitHub package (pyGithub) and pandas.
   pip install -r requirements.txt

Fire it up!

python get_traffic.py
The traffic stats of all repositories associated with the user are stored in the CSV <user_name>.csv.

PS : Open to your suggestions and enhancements. Plan to make it a cron job that regularly updates you of the current traffic!

Please Star the repo if you found it interesting!

github_traffic's Issues

The repo name doesn't take into account the organization

There are many users that will have conflicting repo names. The repo.name should probably be repo.full_name.

Repo statistics pull fails if you don't have push permissions

The script will fail if it encounters a repo that you don't have push permissions for. These should probably be filtered out.

get_traffic.py Syntax Error?

File "get_traffic.py", line 59
print(f"Extracting repo stats of '{self.user_name}'...")
^
SyntaxError: invalid syntax

Would love to get this working

No License

Please add a license for the project.