Skip to main content

A small utility for making gists

Project description

mkgist

A small utility for making gists. When I need to share code snippets online, the formatting always ends up totally messed up when I copy-paste manually. This alleviates that.

Setup

For general use, it's a good idea to keep it somewhere in your path. Because the endpoint requires authentication, you should create a JSON file with your credentials called .mkgist.conf at the home directory. For example,

{
  "username": "user",
  "password": "password"
}

To install dependencies, run pip install -r requirements.txt after installing. I don't use this within a virtual environment, but doing so would look something like this:

virtualenv -p $(which python3) $HOME/virtualenv/mkgist
source $HOME/virtualenv/mkgist/bin/activate

Usage

mkgist filenames [-d "description"] [--public] [--raw] [--nocopy]
  • If no filenames are entered, the contents of the gist are read from STDIN.
  • The location of the created gist is printed to stdout.
  • Gists are secret by default, but can be made public with --public. (Secret gists aren't indexed by search engines)
  • --raw returns a link to the raw hosted file, which you can then get with curl or wget. If multiple files are created with this flag, the URLs are always printed to stdout.
  • By default, the URL of the created Gist is copied to the clipboard. --nocopy prints the link to stdout instead, not overwriting the clipboard.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkgist-2.0.tar.gz (3.3 kB view hashes)

Uploaded Source

Built Distribution

mkgist-2.0-py3-none-any.whl (3.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page