solomspd / contribution-cal-snake

A snake daily snake GIF generator based on your GitHub contributions calendar to show off on your GitHub profile.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Snake GIF from your GitHub contribution calendar history 🐍

snake

Steps to create your own calendar:

  1. Fork this repo

  2. Generate a personal access token, to do that go to settings -> developer setting -> personal access token -> click generate new token -> select the repo:staus permission -> click generate token

  3. Add the token to the forked repo's secrets, to do that go to the forked repo's settings -> secrets -> actions -> click new repository secret -> enter the name ACCESS_TOKEN -> and pase the token in the value field -> click add secret

  4. To generate the first image without waiting for the secheduler, go to the forked repo -> actions -> click on the Generate GIF workflow -> click run workflow

  5. Enjoy your custom snake animation! you can find it under animation/, now you can embed the GIF in your profile readme with the following HTML.

<div align="center">
  <img  src="https://github.com/{your username}/contribution-cal-snake/blob/master/animation/snake.gif"
       alt="snake" />
</div>

Note: the GitHub actions workflow runs everyday so that it reflects your new contributions and since the calendar on your profile changes each passing day.

About

A snake daily snake GIF generator based on your GitHub contributions calendar to show off on your GitHub profile.

License:GNU General Public License v3.0


Languages

Language:Python 100.0%