A tool that allows to quickly create Github Gists from your files.
(as soon as it is published, which is not yet the case at the moment)
pip install quick-gistIf you use quick-gist for the first time you have to create a new user configuration first:
quick-gist add-userAt first start quick-gist will automatically create a configuration file under ~/.config/quick_gist/quick-gist-config.yaml. This is the place where your Github username and Github-API token are stored. Just follow the instructions on the screen and type in your Github username.
Now your are having two options to store your Github API token:
- from an environment variable
- from the configuration file
Environment variable: If this option is selected, quick-gist is configured to look for your API token in an environment variable named QUICK_GIST_"YOUR-USERNAME"_AUTH every time you want to create a new gist. But you have to set this variable yourself in your environment variables.
From the configuration file: Using this option, your API token will be stored in the configuration file you just created.
In both cases, you have the option to encrypt your API token with a password. The tool will ask you for your password every time you want to create a new Github Gist.
Now, and in order to use the tool, you neet to create a new Github API token. Just go to Github Token Settings and log in to your Github account. There you will find the option to create a new token.
Type in a note. For example: "Access token for quick-gist" and select the checkbox gist for the scopes.
You can also specify an expiration time. This is the time after which your token becomes invalid and you have to recreate it. However, you can also choose the option without expiration date so that your token will be valid forever. Click Generate Token to complete the process. Copy your token and paste it into your terminal when quick-gist asks you for it. Decide whether you want to encrypt your token with a password or not. The configuration is now complete. If you have chosen the option to store the token in an environment variable, it will now tell you under which name and with which value it should be stored. If you have chosen the option to encrypt the token with a password, it will show you the value of the encrypted token.
Creating a new Github Gist works with the following command:
quick-gist new -f file1.txt file2.txt-f/--files files from which you want to create your new Github Gist
-d/--description (optional) the Github Gist description
-p/--public (optional) make the Github Gist public, default is secret
-sf/--softfail (optional) issue a warning instead of aborting if the program cannot read a file, default disabled
-u/--user (optional) specify Github username if you have more then one user configured
You can specify from which exact line numbers in your files you want to create a new Github Gist by passing it to the -f/--files argument.
Example: quick-gist new -f file1.txt[1-5] file2.txt[2] file3.txt[1-5,10-15]
In this case a new Github Gist will be created which includes
- line 1 to 5 from file1.txt
- only line 2 from file2.txt
- lines 1-5 and line 10-15 from file3.txt
If no lines are specified, the entire file is included.
quick-gist list-userThis command will print out information about which Github users are configured and how the API token is stored.
quick-gist remove-userThis command will allow you to remove a configured Github user from your configuration
quick-gist add-userThis command will allow you to add a new Github user to your configuration
- Allow passing a directory as file argument and add all files from this directory
- Allow piping content directly into the tool to create a new gist (instead of files)
- Issue warning when Github API token is about to expire
- Add command to renew Gihub API token
- Unittest (and refactor some functions to make them easier to test)
Any pull requests are welcome 🍰