GitHub statistics

This project downloads data about a given public GitHub repository and helps to visualize some statistics with different plots. The data is downloaded from the official GitHub API

Usage

1. Install the dependencies with pip install -r requirements.txt
2. (Optional) Set the GITHUB_OAUTH_TOKEN environment variable to your personal GitHub Oauth token (GitHub - Creating a personal access token). You can use the dotenv package and a .env file like in the examples.
3. Instantiate a new Visualizer and specify the owner and repository parameters.

pandas_visualizer = Visualizer('porsk', 'github-stats')

1. Use the provided methods for plotting statistics about the repository.

Note: If you have not turned the cache functionality off with the useCache parameter of the visualizer subsequent calls should be faster.

Examples

You can find examples for the usage in the Downloader Example and Visualizer Example notebooks.

Downloader (hub_downloader.py)

• expects an owner and a repository name
• optionally a githab oauth token (by default as an anonymous user the limit is 100 request per hour, but with a token 5000)
• it caches the downloadad data by default into the data directory
• can be forsed to ignore the cache and redownload the data with the useCacheIfAvailable parameter
• by default it logs some information about the status, but it can be disabled with the verbose paramter

Methods for fetching data

get_contributors_statistic()

Returns two lists, one with the total commit counts by user and another list with additions, deletions, and commit counts by week and user.

Total contributions example:

Weekly contributions example:

get_code_frequency_statistic()

Returns a weekly aggregate of the number of additions and deletions pushed to the repository.

Example:

get_issues()

Returns the list of open issues in the repository.

Example:

get_commit_activity()

Returns the last year of commit activity grouped by week.

Example:

get_stargazers()

Returns the lists of people that have starred the repository.

Example:

Visualizer (hub_visualizer.py)

• expects an owner and a repository name
• uses the downloader in the background for getting the data
• by default it will try to get the GitHub oauth token from the GITHUB_OAUTH_TOKEN environment variable

Methods for plotting graphs

commit_activity()

Plots a grid plot about the commit activity in the repository during the last year.

Commit activity example:

lines_over_time()

Plots two graphs, one showing the total lines of code over time, the other the additions and deletions over time using line charts.

Total lines over time example:

Additions and deletions over time example:

commits_by_author()

Plots a pie chart showing the top contributors based on the commit count. With the optional limit parameter the number of shown contributor can be modified.

Commits by author example:

stargazer_history()

Plots two line charts, one showing the number of stars on the repo over time and the other showing the number of new stars month by month.

Number of stars over time example:

New stars aggregated by months example: