Skip to content
/ treesnek Public

Print your directory tree in the terminal with Python

License

Notifications You must be signed in to change notification settings

al-ce/treesnek

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Tree-Snek

treesnek_demo.mov

Description

A shameless imitation of tree to print a nice looking recursive tree of the current directory in your terminal, written in Python.

treesnek "grows" the directory tree by recursively adding the directory's contents to a dictionary to the specified depth limit (TreeGrower.path_data()), then sorting the dictionary by type (directory or non-) then name (possible since Python 3.7).

Then it generates a tree by creating a list of strings that represent the tree (TreeGrower.generate_tree()) as if you were slicing the tree horizontally, adding connective branches along the way. Again, it uses recursion to reach the maximum depth set by the limit flag (--l), returning once it hits the limit. But, rather clumsily, it adds branches that go nowhere as it creates this list because it doesn't know if a sub-directory is the last one in its own folder until that sub-directory is done printing its own contents. That's confusing, so here's a picture of what treesnek would output without calling the TreeGrower.prune_tree() function.

unpruned-tree

The circled branches don't go anywhere, but I couldn't figure out an efficient way of calculating when the program should draw the vertical line. So instead, we generate the List[str] and then go back and "prune" it: if the char above any pipe char is a corner/elbow or an empty string (meaning a pipe was pruned there in the previous row), we prune that pipe, but really we're redrawing the whole tree.

depth_demo

Usage

In any directory in your terminal, use the treesnek command available after install.

treesnek takes two optional arguments:

  • --h to show hidden files
  • --l to control the level of directory depth to print (default 1). e.g. treesnek --l 5

Requirements

Python >= 3.7 with pip. This program uses the pathlib and colorama modules.

Installation

Clone this repository, cd into the directory, and install with pip.

$ pip install .

About

Print your directory tree in the terminal with Python

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages