GIF-to-Contribution

Description

Ever wanted to have a cool stylised GIF to put into your GitHub profile README.md files? Well I did! So I created a program that takes any video and creates GIF inspired by the GitHub contribution graph. Also if you want to see a really cool example of this check out my profile.

Dependencies

• NumPy
• Pillow
• opencv-python
• alive_progress

How to Use

1. Ensure that you have all required dependencies for this project. The required dependencies are listed above.
2. Clone the repository

git clone https://github.com/RohanFredriksson/GIF-to-Contribution.git

3. Get a video that you wish to turn into a contribution graph. Usually black and white videos work best. The current file formats that are supported are: .mp4, .gif
4. Run the python script generate.py. This will create a GIF for your chosen video in your chosen theme.

python3 generator.py input [-h] [-t THEME] [-o OUTPUT]

5. To display your GIFs in your README files, do the following

![SpiralDark](examples/dark.gif#gh-dark-mode-only)
![SpriralLight](examples/light.gif#gh-light-mode-only)

This makes sure that the GIF that is shown matches the current theme of the user viewing your README.

Themes

Currently the only supported GitHub themes are:

• Light
• Dark
• HalloweenLight
• HalloweenDark

Examples