Weekly Commits (GNOME extension)

See your past weeks' GitHub contributions in the top bar

Features

• Displays the number of commits via seven boxes in the top bar.
• Popup menu displays the number of commits each day.
• GUI preferences menu to set GitHub credentials and other settings.
• Auto update the data based on configurable intervals.
• Set the position of the extension manually.

Installation

1. Clone this repository:

   git clone https://github.com/funinkina/weekly-commits

2. Move this repository to the GNOME extensions directory:

   mv weekly-commits ~/.local/share/gnome-shell/extensions/

3. Restart GNOME Shell (press Alt + F2, type r, and press Enter) or log out and log back in of you are on Wayland.

4. Enable the extension from the GNOME Extenstions app or from the command line:

   gnome-extensions enable weekly-commits@funinkina.is-a.dev

Configuration

To make the extension work, you need to set your GitHub username and a Fine Grained Personal Access Token (PAT) with Repository Acess to 'All repositories'. Get it from here.

And put your GitHub username and the token in the extension's settings.

TODO

• Add a settings page to configure the GitHub username and PAT.
• Make it fetch the commits at some interval (e.g. every hour).
• Let users configure the placement in the top bar.
• Add a popup with the number of commits on the day.
• Add option for week start day (Monday or Sunday).
• Customisable commit view thresholds.
• Add translations.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Note

Legal

This project is not affiliated with or endorsed by GitHub, Inc. or the GNOME Foundation. The use of the GitHub logo and name is for informational purposes only and does not imply any endorsement or affiliation with GitHub, Inc. The copyright for github.com is owned by GitHub, Inc. All other trademarks and copyrights are the property of their respective owners.