awesome-contributions
Make your GitHub's contributions viewer awesome!
With this simple python script you can make your contributions viewer look however you want:
You can use any image, it will be grayscaled and converted to commits for you:
Requirements
If you don't have pip, apt-get install python-pip
The script uses the Python Image Library (PIL)
pip install pillow
Usage (Image)
- Clone this repository it doesn't work on forks:
git clone https://github.com/twinone/awesome-contributions cd awesome-contributions
- Create a new empty github repository yourself on github, called
awesome-contributions - Add your repository as a remote:
git remote add github https://github.com/[YourUser]/awesome-contributions
-
Replace the test.png image by the 52x7 image you want as background (can be other formats too)
-
Run the generator:
# In the awesome-contributions directory:
python gen.py test.png
- Push the changes to your GitHub repository:
git push github master
Usage (Text)
You can also generate an image containing whatever text you want:
python gen.py --text "AWESOME"
Will generate AWESOME.bmp for you:
Then you just run the program the normal way:
python gen.py AWESOME.bmp
Important
Sometimes some commits don't make it into the contributions page, in this case you create another repository (for example called awesome) and follow this steps:
# Go to the cloned repository
cd awesome-contributions
# Add the second repository as a remote
git remote add helper https://github.com/[YourUser]/awesome
# Push the same commits there too...
git push helper master
This will make GitHub refresh the commits correctly. If you refresh your profile page and see the commits are there, you can delete this helper repository again, and the commits from the original (forked) repository will stay visible.
Notes
- Each week the image will be shifted to the left, so if you leave some padding you can update once every two months or so.
- Make sure to leave at least a few weeks of space at the right so you don't spam the people who follow you.