Metadata-Version: 2.1
Name: fadi-xtree
Version: 0.2.0
Summary: Directory tree generator
Author: 1fadi
License: MIT License
        
        Copyright (c) 2022 1fadi
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Keywords: tree,diagram,terminal
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# XTree
A Directory Tree Generator

### Installation

`pip install fadi-xtree` to install the package in your python enviroment.

### Usage
```
usage: tree [-h] [-v] [-d] [-o [OUTPUT_FILE]] [-i IGNORE_DIR [IGNORE_DIR ...]]
            [--by-name | --by-size | --by-date] [-r]
            [ROOT_DIR]

XTree, a directory tree generator

positional arguments:
  ROOT_DIR              Generate a full directory tree starting at ROOT_DIR

options:
  -h, --help            show this help message and exit
  -v, --version         show program's version number and exit
  -d, --dir-only        Generate a directory-only tree.
  -o [OUTPUT_FILE], --output-file [OUTPUT_FILE]
                        Generate a full directroy tree and save the output to a file
  -i IGNORE_DIR [IGNORE_DIR ...], --ignore-dir IGNORE_DIR [IGNORE_DIR ...]
                        Don't list files from these directories. (e.g. env, __pycache__)
  --by-name             list the files by name.
  --by-size             list the files by size.
  --by-date             list the files by date.
  -r, --reverse         reverse the order.

Thanks for using XTree.
```
