Skip to content
Write to your GitHub activity chart
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
github_vanity
.gitignore
LICENSE
Makefile
README.rst
requirements-dev.txt
requirements.txt
setup.cfg
setup.py
stdeb.cfg
vanity.jpg

README.rst

Vanity text for GitHub

Write to your GitHub activity chart.

Inspired by Rockstar

https://img.shields.io/pypi/v/github-vanity.svg?style=flat-square https://img.shields.io/github/license/mashape/apistatus.svg?style=flat-square https://img.shields.io/badge/author-%40ihabunek-blue.svg?style=flat-square

Installation

From APT package repository

This works for Debian, Ubuntu and other derivatives.

The repo is signed with my keybase.io key.

echo "deb http://bezdomni.net/packages/ ./" | sudo tee /etc/apt/sources.list.d/bezomni.list
curl https://keybase.io/ihabunek/pgp_keys.asc | sudo apt-key add -

sudo apt update
sudo apt install python3-github-vanity

From Python Package Index

Preferably install into a virtual environment.

pip install github-vanity

Usage

Initialize an empty Git repository which you will submit to GitHub.

Populate the repo with the desired text:

vanity write "Hi there!"

Push the repo to GitHub and presto!

https://raw.githubusercontent.com/ihabunek/github-vanity/master/vanity.jpg

Reference

vanity write [options] text

  • text - text to write to the commit chart

Available options:

  • -h, --help - show usage instructions
  • -d, --start_date - the date to start with, should be a Sunday
  • -o, --offset - number of spaces to leave to the left (default is 0)
  • -s, --spacing - spacing between letters (default is 1)
  • -w, --space_width - width of space character (default is 4)
  • -c, --commits - number of commits per pixel (default is 50)

The default start_date is the Sunday 52 weeks before the last one, which is the first pixel visible on the commit chart.

You can’t perform that action at this time.