Github Wrapped

@Violeta-Tejera

The purpose of this project is to develop a tool that offers Github users a comparable experience to Spotify Wrapped, an annual viral marketing campaign made by Spotify since 2016, in which their users are shown several statistics about their music tendencies during the current year.

Disclaimer

This software is provided to you "as is", and you use it at your own risk. Under no circumstances shall any author be liable for direct, indirect, special, indicental or consequential damages resulting from the use, miuse, or inability to use this software, even if the authors have been advised of the possibility of such damages.

Features

• Language statistics: Discover the variety of programming languages you've used during the past year.
• Top language: Find out which programming language dominated your contributions.
• Repository insights: Which are the repositories you've created and/or contributed to during this last year? What can be told about them?
• Commit metrics: How many commits have you done this year? Which was your longest commit streak?

Roadmap

• Social engagement statistics (stars, followers,...)
• More statistics...
• GUI

Running it locally

1. Clone the repository:

git clone https://github.com/Violeta-Tejera/Github_Wrapped
cd Github_Wrapped

2. Install dependencies

  pip install -r requirements.txt

3. Modify the config.json file to comply with your details:

-username: Your username goes here

-token: Your personal access token goes here. More info. on that here: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens

-year: Type in the year you want to view

-showPrivate: Some functionalities toggle between public repositories and all repositories. Choose true for the latter.

-showRepoInfo: This boolean let's you choose whether or not you'd like to show extra information about the displayed repos, such as the quantity of commits it had during the year, or the number of new stargazers it had.

4. Run

python githubwrapped.py

References

• Python Official documentation: https://docs.python.org/3/
• Github Rest API documentation: https://docs.github.com/es/rest?apiVersion=2022-11-28
• PyGithub documentation: https://pygithub.readthedocs.io/en/latest/introduction.html

Contact info

Should you have any further inquiry of would like to provide your feedback, please do reach out to me via email at [email protected]