Utility Package that Displays out the Tree Structure of a Particular Directory.
Directory Tree Package
Want to Display your Project/Current Working Directory as a Neat Tree? No Worries!
Directory Tree is a simple python utility package that displays out the Tree Structure of a User Defined Directory.
Currently Available for All Platforms.
Run the Following Command on your Terminal to Install
1 . Installing the Package using
pip install directory_tree
pip3 install directory_tree
2 . Cloning the Repository:
git clone https://github.com/rahulbordoloi/Directory-Tree/ cd Directory-Tree pip install -e .
display_tree(dir_path: str = '', string_rep: bool=False, header: bool=False, max_depth: float=float("inf"), show_hidden: bool=False, ignore_list: list=None)
|dir_path||Root Path of Operation. By Default, Refers to the Current Working Directory.|
|string_rep||Boolean Flag for Direct Console Output or a String Return of the Same. By Default, It Gives out Console Output.|
|header||Boolean Flag for Displaying [OS & Directory Path] Info in the Console. Not Applicable if
|max_depth||Max Depth of the Directory Tree. By Default, It goes upto the Deepest Directory/File.|
|show_hidden||Boolean Flag for Returning/Displaying Hidden Files/Directories if Value Set to
|ignore_list||List of File and Directory Names or Patterns to Ignore.|
Run this Script in Order to Print out the Tree Structure of a User-Defined Directory
# Importing Libraries from directory_tree import display_tree # Main Method if __name__ == '__main__': display_tree(DirectoryPath)
- Here by default, the
DirectoryPathis the current working directory (CWD) unless specified by the user.
Sample Directory Tree -
NOTE - Here,
letseee.txt (File) and
Directory 4/ (Directory) are HIDDEN in Nature.
- For Current Working Directory with Argument [Header Info =
from directory_tree import display_tree display_tree(header=True)
- For User Specified Directory with Arguments [String Representation =
True, Show Hidden Entities =
from directory_tree import display_tree customPath = 'D:\Work\Python Packages Maintainence\Directory-Tree\Test\Main Directory' stringRepresentation = display_tree(customPath, string_rep=True, show_hidden=True) print(stringRepresentation)
- For Current Working Directory with Argument [Max Depth =
from directory_tree import display_tree display_tree(max_depth=2)
directory_tree, along with the tools you need to develop and run tests, and execute the following in your virtualenv:
$ pip install -e .[dev]
Security & Probable Bugs
Directory Treeuses recursion. It will raise a
RecursionErroron really deep directory trees.
- As the tree is lazily evaluated, it should behave well on really wide directory trees. Immediate children of a given directory are not lazily evaluated, though. It would be prompted to the last.
- If you're a Windows user, it is always advised to use
\in the address as using
\might catchup escape sequences and corrupt the address string.
Made with ♥ in Python!
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for directory_tree-0.0.4-py3-none-any.whl