Skip to content

A simple tool for writing text to your commit history calendar

License

Notifications You must be signed in to change notification settings

robvold/send_nudes

Repository files navigation

send_nudes

send_nudes: A simple tool for writing text to your commit history calendar.

It works for both Github and Gitlab. It supports most of the ascii character set, including all the capital letters, and the most commonly used special characers. For a complete list, look at the letters.py-file.

It works by creating a shell-script, that uses gits ability to make commits in the past.

While testing the code you will probably generate a few .sh-files, you can use the provided remove_shell_scripts.sh-script to delete them all safely.

Important: It's recommended to execute the generated script in a empty repo as it will be easier to make changes later on.


Usage

First you'll need to clone the repo:

git clone https://github.com/robvold/send_nudes

Then you are able to use the tool with this general flow:

  1. Run the code
  2. Move the created shell script to the desired repo
    a. Preferably an empty one
  3. Execute the shell-script

Note: It may take some days before the text is visible in the commit calendar.

Commands

There are primarily two ways of running the code. You can make it print the default text, "send_nudes", by running:

python send_nudes.py

Or you can define the text with the -t or -m flag, like this:

python send_nudes.py -t "desired text"

If you need help use the -h flag:

python send_nudes.py -h

Removing the text

As the text is actual commits in a repo, the simplest way of deleting the text would be to delete the repository.


License

send_nudes is released under the GPL v3 license.

Wanting to contribute?

Do you find a bug, miss a character or simply want to extend the functionality?
Feel free to make a PR or create an issue.

About

A simple tool for writing text to your commit history calendar

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published