Metadata-Version: 1.0
Name: gists.cli
Version: 0.2
Summary: A CLI to create, edit, view and list your GitHub Gists
Home-page: https://github.com/khilnani/gists.cli
Author: khilnani
Author-email: nik@khilnani.org
License: GPLv2
Description: Gists.cli
        ===========
        
        > I'm a Developer who uses VI and the like. iPad and iPhone apps are great, but when I really need a Gist i'm at the command line. 
        
        An easy to use CLI to manage *your* GitHub Gists. Create, edit, append, view, search and download. 
        
        - Github - https://github.com/khilnani/gists.cli 
        - Python Package - https://pypi.python.org/pypi/gists.cli
        
        Installation
        ============
        
        Recomended installation process
        
        - Install the Python package manager PIP (http://www.pip-installer.org/)
          - Run `sudo easy_install pip`
        - Once PIP is installed, run `pip install gists.cli`
        
        If you would like to contribute changes to the code base
        
        - Get the code
          - Fork and `git clone` the fork, or ...
          - `git clone https://github.com/khilnani/gists.cli.git`, or ...
          - Download the latest Tag Archive from https://github.com/khilnani/gists.cli  
            - *Downloading the Archive is not recommended, since it won't be easy to merge code back*.
        - Install dependencies by running `./setup.sh`. 
          - This installs PIP (if not already installed) and then installs the dependencies.
        - Run the installer as below. If you get any error run with `sudo ...`
          - `./install.py` with no arguments will install to `/usr/local/bin`.
          - `./install.py INSTALL_PATH` will install to a specific directory.
        
        Usage
        =========
        
        Authentication
        --------------
        
        - By default the application will attempt to use Basic Auth to authenticate. 
        - If `~/.git-credentials` is available, it will use the first entry. 
        - If  `~/.gists` is found, it will be given preference over the above two mechanisms.
        
        Usage
        ---------
        
        *All the commands below are interactive and will prompt for user input.*
        *To suppress interactivity, use the 'suppress' command. See the 'Tips' section for more info.*
        
        **List all your Gists**
        
        - `./gists` - list your Gists.
        
        **View a Gist**
        
        - `./gists ID` - view Gist with ID on the console.
        - `./gists ID PATH` - download Gist files with ID to PATH. Will prompt for confirmation.
        
        **Setup OAuth token**
        
        - `./gists token|t` - setup to use OAuth Token other than `~/.git-credentials`. Saves to `~/.gists`.
        
        **Create a Gist**
        
        > FILE - is a file path, relative or absolute.
        > Bool - True, False, 1, 0, Yes, No, y, n. Case-insensitive
        > Description and Content - Text content within quotes
        
        
        Without specifying a command (eg. create, new), the application will trying to figure it out. However, this supports fewer combinations of arguments.
        
        - `./gists FILE`
        - `./gists "Content"`
        - `./gists Bool FILE`
        - `./gists Bool "Content"`
        - `./gists "Description" FILE`
        - `./gists "Description" "Content"`
        - `./gists Bool "Description" FILE`
        - `./gists Bool "Description" "Content"`
        
        
        If you like to type, or be specific - with the create command specified:
        
        - `./gists new|n|create|c FILE`
        - `./gists new|n|create|c "Content"`
        - `./gists new|n|create|c Bool FILE`
        - `./gists new|n|create|c Bool "Content"`
        - `./gists new|n|create|c "Description" FILE`
        - `./gists new|n|create|c "Description" "Content"`
        - `./gists new|n|create|c Bool "Description" FILE`
        - `./gists new|n|create|c Bool "Description" "Content"`
        
        Tips
        ---------
        
        - Add `debug|d` at the end of any execution to view low level details. eg. `./gists debug`. *NOTE - This will reveal your OAuth ID but not your Basic Auth password.*
        - Add `supress|silent|s` at the end of any execution to supress any prompts of confirmations if you like to live dangerously. 
          - eg. `./gists create FILE supress debug`. 
        
        
        In Development
        ==============
        
        - `./gists update|u ID [PARAMS]` - Update a Gist. Content sent via Console, Clipboard or File.
        - `./gists delete|del|d ID` - Delete a Gist.
        - `./gists append|a ID [PARAMS]` - Append to a Gist. Content sent via Console, Clipboard or File.
        - `./gists backup|b [DIR]` - Backup all Gists in the user's account.
        - `./gists search|query|q QUERY` - Search Gists.
        - `./gists star` - List starred Gists
        
        Issues and Roadmap
        ==================
        
        - Take a look at https://github.com/khilnani/gists.cli/issues to view Issues and Milestones.
        
        
        
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Unix
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.5
Classifier: Programming Language :: Python :: 2.6
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
