Metadata-Version: 1.0
Name: completeme
Version: 0.2.0
Summary: Automagic ctrl+t filename completion to launch in your favorite editor
Home-page: https://github.com/mattspitz/completeme
Author: Matt Spitz
Author-email: mattspitz@gmail.com
License: UNKNOWN
Description: ##########
        completeme
        ##########
        
        completeme is a python script that'll allow you to auto-complete filenames and launch them in an editor, much like GitHub's 't' keyboard shortcut.  Rather than tab-completing to oblivion (ever worked on a Java project?), just start typing the name of the file, and when you hit enter, it'll open that file in your favorite $EDITOR.  Uses files stored in the current GitHub repository and falls back on all files below the current working directory.
        
        **Make sure to add `source /usr/local/bin/setup_completeme_key_binding.sh` to your .bashrc to enable Ctrl+t support!**
        
        #############
        Configuration
        #############
        
        completeme comes with /etc/completeme.json, which you can use to, well, configure your complete me experience.
        * *git_entire_tree* (default=true) indicates whether, if we're in a git repository, we should search all files in the git repository, regardless of where we are in said repository.  That is, if we have a repository like /hello.txt, /a/there.txt, /b/myfriends.txt, and we're in the /a directory, *git_entire_tree=true* implies that we'll also surface /hello.txt and /b/myfriends.txt.  Otherwise, you'll just get /a/there.txt.
        * *find_hidden_directories* (default=false) indicates whether we should search inside dot directories (assuming we didn't find a git repository).  These are things like .config, .vim, etc.
        * *find_hidden_files* (default=false) indicates whether we should find files that start with a dot (assuming we didn't find a git repository).  These are things like .emacs, .xinitrc, .DS_Store, etc.
        
        * Currently, the git search (ls-tree) lists only the files under source control at or beneath this directory.  Do we want to support querying all files in the git repository, regardless of which subdirectory you're in?  If so, we'll want to use the --full-tree option.
        
        ########
        Wishlist
        ########
        * I wish I didn't have to run the $EDITOR command in the script.  Wouldn't it be neat if Ctrl+t could just output the filename into my current prompt?  Then, you can autocomplete for anything, not just your text editor.
        * It'd also be neat to specify a different directory that you'd like to autocomplete, not just the current working directory, though perhaps that's beyond the scope of this project.
        
        #######
        License
        #######
        This software is licensed under the WtHYWv2 (Whatever the Hell You Want, v2).  Please throw some credit around if it's deserved.
        
Platform: UNKNOWN
