treepy

Bare-bones CLI for displaying a tree of file structure

99.9% of this very bare-bones utility is taken from this stackoverflow answer. Thanks to the user abstrus for providing it.

Installation

git clone https://github.com/ekiefl/treepy.git
cd treepy
python setup.py install
treepy -h

Do you get a pkg_resources.ResolutionError? try cding out of the directory and try treepy -h again.

Usage

A couple of cases.

treepy -h (getting help)

usage: treepy_python [-h] [-d] [-a] [-q] [-f] path

positional arguments:
  path        brief description

optional arguments:
  -h, --help  show this help message and exit
  -d          Only display directories
  -a          Include those starting with `.`
  -q          Append quick-access variable path
  -f          Display the full path

treepy (most simple command)

treepy/
├── bin/
│   ├── treepy
│   └── treepy_python
├── build/
│   ├── bdist.macosx-10.12-x86_64/
│   ├── lib/
│   │   └── treepy/
│   │       ├── __init__.py
│   │       └── tree_generation.py
│   └── scripts-3.6/
│       ├── treepy
│       └── treepy_python
├── dist/
│   └── UNKNOWN-0.1-py3.6.egg
├── LICENSE
├── README.md
├── requirements.txt
├── setup.cfg
├── setup.py
├── treepy/
│   ├── __init__.py
│   ├── __pycache__/
│   └── tree_generation.py
└── UNKNOWN.egg-info/
    ├── dependency_links.txt
    ├── PKG-INFO
    ├── requires.txt
    ├── SOURCES.txt
    └── top_level.txt

treepy -d (directories only)

treepy/
├── bin/
├── build/
│   ├── bdist.macosx-10.12-x86_64/
│   ├── lib/
│   │   └── treepy/
│   └── scripts-3.6/
├── dist/
├── treepy/
│   └── __pycache__/
└── UNKNOWN.egg-info/

treepy -df (display full paths)

d/Users/evan/Software/treepy/
├── /Users/evan/Software/treepy/bin/
├── /Users/evan/Software/treepy/build/
│   ├── /Users/evan/Software/treepy/build/bdist.macosx-10.12-x86_64/
│   ├── /Users/evan/Software/treepy/build/lib/
│   │   └── /Users/evan/Software/treepy/build/lib/treepy/
│   └── /Users/evan/Software/treepy/build/scripts-3.6/
├── /Users/evan/Software/treepy/dist/
├── /Users/evan/Software/treepy/treepy/
│   └── /Users/evan/Software/treepy/treepy/__pycache__/
└── /Users/evan/Software/treepy/UNKNOWN.egg-info/

source treepy -dq (quick-access environment variables)

For this, it is essential that the command is run as source treepy, otherwise environmental variables will not be retained in the shell you run treepy from.

treepy/ → $TREE1
├── bin/ → $TREE2
├── build/ → $TREE3
│   ├── bdist.macosx-10.12-x86_64/ → $TREE4
│   ├── lib/ → $TREE5
│   │   └── treepy/ → $TREE6
│   └── scripts-3.6/ → $TREE7
├── dist/ → $TREE8
├── treepy/ → $TREE9
│   └── __pycache__/ → $TREE10
└── UNKNOWN.egg-info/ → $TREE11

Each path in tree is stored as an environmental variable TREE[X], where [X] is a number. Running

echo $TREE1

yields:

/Users/evan/Software/treepy