Crates.io | git-shining |
lib.rs | git-shining |
version | 0.2.2 |
source | src |
created_at | 2023-08-27 21:55:48.50708 |
updated_at | 2023-08-30 11:34:16.834467 |
description | Create art out of a yearly GitHub contribution graph |
homepage | https://github.com/erikh/git-shining |
repository | https://github.com/erikh/git-shining |
max_upload_size | |
id | 956406 |
size | 136,761 |
This program turns your contributor graph into a work of art by filing commits with the right dates. GitHub will automatically scan the repository and fill out the graph for you.
Or here if you want a more in-your-face example.
Best to create or use a burner account for this; this is not for your main account.
--origin
option if you want to exploit that.The first step is to generate configuration. You can do this in two ways:
git-shining generate-config <json|txt>
This will generate a blank canvas for editing in JSON or TXT (more on this later) format.
or
git-shining render-font <.otf or .ttf file> <message (be sure to quote)>
This will generate a pre-filled configuration with the message rasterized to the canvas in the font provided.
Then, you can generate a repository with the generate-repository
command. Be sure to at least set the email
field of the person you want getting credit for the commits, it must map directly to a configured GitHub email:
git-shining generate-repository -i bro.txt -e wearelegion@example.org -m "Sup Bro" /tmp/test.git
After that, you can create your repository and upload it.
If you want to generate repositories that start the graph at a certain date, look at the --origin
options of build
and generate-repository
.
There are two formats for configuration: JSON and TXT.
JSON is a JSON array of integers, from 0-10, which coordinate to shading in the graph (made possible by filing more commits for brighter shades). It is easy to consume, post-process, and generate, but a little hard to edit.
TXT is an easier format to hand-edit. It is simply a well-aligned grid of integers, which you can set from 0-A
(A
is 10 here) to affect shading.
The generate-config
sub-command can generate both formats for hand-editing, and the render-font
command has switches to modify target configuration output.
build
sub-command which will generate a HTML mock of the graph you can load into your browser. You can hover over each square to get the expected date.The Professional erik+github@hollensbe.org