Metadata-Version: 1.1
Name: python-gist
Version: 0.1.11
Summary: Manage github gists
Home-page: http://github.com/jdowner/gist
Author: Joshua Downer
Author-email: joshua.downer@gmail.com
License: MIT
Description: ==================================================
        GIST
        ==================================================
        
        'gist' is a command line interface for working with github gists. It provides
        several methods for inspecting a users gists, and the ability to easily create
        them.
        
        .. image:: https://travis-ci.org/jdowner/gist.svg?branch=master
            :target: https://travis-ci.org/jdowner/gist
        
        Installation
        --------------------------------------------------
        
        To install 'gist' you can either use,
        
        ::
        
          $ sudo pip install python-gist
        
        or,
        
        ::
        
          $ sudo python setup.py install
        
        or,
        
        ::
        
          $ sudo make install
        
        This will install the python package 'gist' to the standard location for your
        system and copy the license, readme, and some bash scripts into /usr/share/gist.
        
        There is also tab-completion available for bash and fish shells. The scripts are
        installed in /usr/local/share/gist.
        
        There are 3 different scripts for tab-completion in bash: gist.bash,
        gist-fzf.bash, and gist-fzsl.bash. The first, provides simple tab completion and
        can be enable by adding the following to your .bashrc file,
        
        ::
        
          source /usr/local/share/gist/gist.bash
        
        The other scripts, gist-fzf.bash and fist-fzsl.bash, provide fuzzy matching of
        gists using an ncurses interface (NB: these scripts request fzf and fzsl,
        respectively, to be installed -- see Dependencies).
        
        The gist.fish script provides tab completion in the fish shell, and should be
        copied to ~/.config/fish/completions.
        
        
        Getting started
        --------------------------------------------------
        
        'gist' requires a personal access token for authentication. To create a token,
        go to https://github.com/settings/applications. The token needs to then be added
        to a 'gist' configuration file that should have the form,
        
        ::
        
          [gist]
          token: <enter token here>
          editor: <path to editor>
        
        The editor field is optional. If the default editor is specified through some
        other mechanism 'gist' will try to infer it. Otherwise, you can use the config
        file to ensure that 'gist' uses the editor you want it to use.
        
        The configuration file must be in one of the following,
        
        ::
        
          ${XDG_DATA_HOME}/gist
          ${HOME}/.config/gist
          ${HOME}/.gist
        
        If more than one of these files exist, this is also the order of preference,
        i.e. a configuration that is found in the ``${XDG_DATA_HOME}`` directory will be
        taken in preference to ``${HOME}/.config/gist``.
        
        
        Usage
        --------------------------------------------------
        
        'gist' is intended to make it easy to manage and use github gists from the
        command line. There are several commands available:
        
        ::
        
          gist create      - creates a new gist
          gist edit        - edit the files in your gist
          gist description - updates the description of your gist
          gist list        - prints a list of your gists
          gist clone       - clones a gist
          gist delete      - deletes a gist from github
          gist files       - prints a list of the files in a gist
          gist archive     - downloads a gist and creates a tarball
          gist content     - prints the content of the gist to stdout
          gist info        - prints detailed information about a gist
          gist version     - prints the current version
        
        
        **gist create**
        
        Most of the 'gist' commands are pretty simple and limited in what they can do.
        'gist create' is a little different and offers more flexibility in how the user
        can create the gist.
        
        If you have a set of existing files that you want to turn into a gist,
        
        ::
        
          $ gist create "divide et impera" foo.txt bar.txt
        
        where the quoted string is the description of the gist. Or, you may find it
        useful to create a gist from content on your clipboard (say, using xclip),
        
        ::
        
          $ xclip -o | gist create "ipsa scientia potestas est"
        
        Another option is to pipe the input into 'gist create' and have it automatically
        put the content on github,
        
        ::
        
          $ echo $(cat) | gist create "credo quia absurdum est"
        
        Finally, you can just call,
        
        ::
        
          $ gist create "a posse ad esse"
        
        which will launch your default editor (defined by the EDITOR environment
        variable).
        
        
        **gist edit**
        
        You can edit your gists directly with the 'edit' command. This command will
        clone the gist to a temporary directory and open up the default editor (defined
        by the EDITOR environment variable) to edit the files in the gist. When the
        editor is exited the user is prompted to commit the changes, which are then
        pushed back to the remote.
        
        **gist description**
        
        You can update the description of your gist with the 'description' command.
        You need to supply the gist ID and the new description. For example -
        
        ::
        
          $ gist description e1f5e95a1705cbfde144 "This is a new description"
        
        
        **gist list**
        
        Returns a list of your gists. The gists are returned as,
        
        ::
        
          2b1823252e8433ef8682 - mathematical divagations
          a485ee9ddf6828d697be - notes on defenestration
          589071c7a02b1823252e + abecedarian pericombobulations
        
        The first column is the gists unique identifier; The second column indicates
        whether the gist is public ('+') or private ('-'); The third column is the
        description in the gist, which may be empty.
        
        
        **gist clone**
        
        Clones a gist to the current directory. This command will clone any gist based
        on its unique identifier (i.e. not just the users) to the current directory.
        
        
        **gist delete**
        
        Deletes the specified gist.
        
        
        **gist files**
        
        Returns a list of the files in the specified gist.
        
        
        **gist archive**
        
        Downloads the specified gist to a temporary directory and adds it to a tarball,
        which is then moved to the current directory.
        
        
        **gist content**
        
        Writes the content of each file in the specified gist to the terminal, e.g.
        
        ::
        
          $ gist content c971fca7997aed65ddc9
          foo.txt:
          this is foo
        
        
          bar.txt:
          this is bar
        
        
        For each file in the gist the first line is the name of the file followed by a
        colon, and then the content of that file is written to the terminal.
        
        
        **gist info**
        
        This command provides a complete dump of the information about the gist as a
        JSON object. It is mostly useful for debugging.
        
        
        **gist version**
        
        Simply prints the current version.
        
        
        
        Dependencies
        --------------------------------------------------
        
        'gist' currently depends on,
        
        * docopts
        * pep8
        * requests
        * responses
        * simplejson
        * six
        * tox
        
        Optional packages (for fuzzy matching)
        
        * fzf   (https://github.com/junegunn/fzf)
        * fzsl  (https://github.com/jsbronder/fzsl)
        
        
        Contributors
        --------------------------------------------------
        
        Thank you to the following people for contributing to 'gist'!
        
        * Eren Inan Canpolat (https://github.com/canpolat)
        * Kaan Genç (https://github.com/SeriousBug)
        * Eric James Michael Ritz (https://github.com/ejmr)
        * Karan Parikh (https://github.com/karanparikh)
        
Keywords: gist github git
Platform: Unix
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Version Control
Classifier: Topic :: Utilities
