Metadata-Version: 2.1
Name: treepick
Version: 0.1.4
Summary: Curses Tree Style Path Picker
Home-page: https://github.com/tslight/treepick
Author: Toby Slight
Author-email: tobyslight@gmail.com
License: UNKNOWN
Description: # CURSES TREE STYLE PATH PICKER
        
        A Curses based, tree style, path picker. For use as a terminal based file dialog.
        
        ![img](./treepick.gif "TreePick")
        
        ## INSTALLATION
        
        `pip install treepick`
        
        ## CLI USAGE
        
        ```
        usage: treepick [-h] [-a] [-r] [path]
        
        Select paths from a directory tree.
        
        positional arguments:
          path            A valid path.
        
        optional arguments:
          -h, --help      show this help message and exit
          -a, --hidden    Show all hidden paths too.
          -r, --relative  Output relative paths.
        ```
        
        ## PYTHON USAGE
        
        ```python
        from treepick import pick
        
        hidden = True
        
        parent_path = '/path/to/directory'
        
        my_list_of_paths = pick(parent_path, hidden)
        
        my_amazing_function(my_list_of_paths)
        ```
        
        ## KEYBINDINGS
        
        | KEY                | ACTION                                                |
        | :----------------- | :---------------------------------------------------- |
        | UP, k              | Step up one line.                                     |
        | DOWN, j            | Step down one line.                                   |
        | K                  | Jump to previous parent directory.                    |
        | J                  | Jump to next parent directory.                        |
        | PGDN, f            | Jump down a page of lines.                            |
        | PGUP, b            | Jump up a page of lines.                              |
        | HOME, g            | Jump to first line.                                   |
        | END, G             | Jump to last line.                                    |
        | TAB, RET           | Toggle expansion/collapse of directory.               |
        | RIGHT, l           | Expand and step into directory.                       |
        | LEFT, h            | Collapse directory.                                   |
        | SHIFT RIGHT, L     | Expand directory and child directories.               |
        | SHIFT LEFT, H      | Jump to parent directory and collapse all.            |
        | SPC                | Toggle picking of paths.                              |
        | v                  | Toggle picking of all currently expanded paths.       |
        | :                  | Toggle picking based on entered globs.                |
        | p                  | View all currently picked paths.                      |
        | /                  | Search for string in currently expanded paths.        |
        | n                  | Jump to next occurrence of search string.             |
        | N                  | Jump to previous occurrence of search string.         |
        | .                  | Toggle display of dotfiles.                           |
        | s                  | Display total size of path, recursively               |
        | S                  | Display totol size of all currently expanded paths.   |
        | F5, r              | Reset marking and expansion.                          |
        | F1, ?              | View all keybindings.                                 |
        | q, ESC             | Quit and display all marked paths.                    |
        
        ## TODO
        
        - [x] ~~Support window resizing.~~
        - [x] ~~Page for viewing all current picks~~
        - [x] ~~Fix permission exception handling in my du package.~~
        - [x] ~~Retain traversal position when toggling hidden directories.~~
        - [x] ~~Different colors for sizes.~~
        - [x] ~~Prompt to pick via entered globs.~~
        - [x] ~~Search for string and navigate results.~~
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: ISC License (ISCL)
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
