CLI to update local and remote files from GitHub gists
Project description
GetGist
Easily download any file from a GitHub Gist, with one single command.
Why?
Because of reasons I do not have a dotfiles repository. I prefer to store my .vimrc, .gitconfig, .bash_profile etc. as Gists.
I wrote this script so I could update my dotfiles with one single command: getmy .vimrc, for example — and it’s done.
Install
$ pip install getgist
GetGist works with Python 2.7+ or 3.4+.
To update just run $ pip install -U getgist.
Usage
Getting Gists from GitHub
Just run getgist <username> <filename>. For example:
$ getgist cuducos .vimrc
Fetching https://api.github.com/users/cuducos/gists
Reading https://gist.githubusercontent.com/cuducos/409fac6ac23bf515f495/raw/666d7d01a0058e4fd898ff752db66160f10a60bb/.vimrc
Saving .vimrc
Done!GetGist asks you what to do when a local file (with the same name) exists. If you decide not to delete your local copy of the file, it will be renamed with extensions such as .bkp, .bkp1, .bkp2 etc.
Updating Gists at GitHub
Just run putgist <username> <filename> to upate the remote Gist with the contents of the local file. It requires an OAuth token (see Using OAuth authentication below). For example:
$ putgist cuducos .vimrc
User cuducos authenticated
Fetching https://api.github.com/gists
Sending contents of .vimrc to https://api.github.com/gists/409fac6ac23bf515f495
Done!
The URL to this Gist is: https://gist.github.com/cuducos/409fac6ac23bf515f495GetGist asks you what to do when it finds the different files with the same name in different Gists.
Using OAuth authentication
Why?
Add your personal access token as as enviroment variable to allow:
the download of private Gists
the update of existing Gists
How?
Get a personal access token with permission to manage your gists from GitHub settings
Set an environment variable called GETGIST_TOKEN with your personal access token
Example
$ export GETGIST_TOKEN=whatever1234
$ getgist cuducos .vimrc
User cuducos authenticated
Fetching https://api.github.com/gists
Reading https://gist.githubusercontent.com/cuducos/409fac6ac23bf515f495/raw/666d7d01a0058e4fd898ff752db66160f10a60bb/.vimrc
Saving .vimrc
Done!
The URL to this Gist is: https://gist.github.com/cuducos/409fac6ac23bf515f495This will work even if the file you are trying to download is a private gist (surely the user name has to macth the GETGIST_TOKEN account).
Setting a default user
Why?
Set a default user to avoid typing your GitHub user name all the time
How?
Set an environment variable called GETGIST_USER with your GitHub username
Use the shortcut getmy <filename> or putmy <filename>
Example
$ export GETGIST_USER=cuducos
$ getmy .vimrc
Fetching https://api.github.com/users/cuducos/gists
Reading https://gist.githubusercontent.com/cuducos/409fac6ac23bf515f495/raw/666d7d01a0058e4fd898ff752db66160f10a60bb/.vimrc
Saving .vimrc
Done!
The URL to this Gist is: https://gist.github.com/cuducos/409fac6ac23bf515f495Contributing
Feel free to report an issue, open a pull request, or drop a line.
Thank you very much @ddboline and /u/Sean1708 for the contributions!
Don’t forget to format your code with Black, and to write and run tests:
$ pip install tox
$ toxRelease history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
