StatTheGit is a python based tool to fetch, maintain and display GitHub clone and views statistics. By default GitHub only maintains GitHub repository statistics for 14 days only. This repository can be used to maintain a local copy of the repository statistics
Detailed documentation on this repository can be found here
git clone <repo_name>
cd StatTheGit
pip install -r requirements.txt
python fetch_stats.py --GitToken <GitToken> --username <GitHub Username> --RepoNames <Repository name>
| Argument | Explanation |
|---|---|
| GitToken | GitHub personal access token |
| username | The Github username |
| RepoNames | Name of the repository or repositories separated by space. If set to 'all', all the repositories under the username profile will be processed |
Running fetch_stats.py will create a folder repo_stats/<-username->. The view and clone stats for the mentioned repositories will be fetched from the GitHub profile and saved as a csv file. If the csv files for the repository already exists the code appends the fetched data to existing stats taking care of issues such as duplicate stats, missing dates etc.
# Generic
|-- repo_stats
| |-- <username>
| | |-- <repository 1>.txt
| | |-- <repository 2>.txt
| | |-- <repository 3>.txt
# Example
|-- repo_stats
| |-- aqeelanwar
| | |-- PEDRA.txt
| | |-- SocialDistancingAI.txt
StatTheGit can be used to create and update online graphs which can then be displayed on your personal website like this.
python display_stats.py --stat_folder repo_stats --display_type 'offline'
Running the above command will generate one interactive graph per repository displaying the views and clones statistics.
Plotly is being used to plot the Github graphs. In order to create the graphs online, and have it displayed on your website, chart studio account needs to be created Details here. Once you have the API key you can use the following commands to create online graphs that can then be shared on websites.
python display_stats.py --stat_folder repo_stats --display_type 'online' --username <plotly-username> --api_key <plotly-api-key