Quirky_Director Package

About

Want to Save your Project / Current Working Directory as a Neat Tree to a Text file? No Worries!

Quirky_Director is a Fork of the Directory-Tree Package that displays out the Tree Structure of a Particular Directory with the added functionality to export to a Directory_Tree text file.

Currently Available for All Platforms.

Installation

Run the Following Command on your Terminal to Install quirky_director:

1 . Installing the Package using pip:

pip install quirky_director

OR

pip3 install quirky_director

2 . Cloning the Repository:

git clone https://github.com/SahilDave04/Quirky_Director/
cd Quirky_Director
pip install -e .

You can use either of the above methods to install quirky_director.

Usage

Function Signature

DisplayTree(
    dirPath: str='',
    stringRep: bool=False,
    header: bool=False,
    maxDepth: float=float('inf'),
    showHidden: bool=False,
    ignoreList: List[str]=None,
    onlyFiles: bool=False,
    onlyDirs: bool=False,
    sortBy: int=0,
    exportTxt: bool=False
) -> Union[str, None]:

Arguments Description

Parameters	CLI Parameters	Description
dirPath	directory	Root Path of Operation. By Default, Refers to the Current Working Directory.
stringRep	N/A	Boolean Flag for Direct Console Output or a String Return of the Same. By Default, It Gives out Console Output.
header	--header	Boolean Flag for Displaying [OS & Directory Path] Info in the Console. Not Applicable if stringRep=True.
maxDepth	-L, --max-depth	Max Depth of the Directory Tree. By Default, It goes upto the Deepest Directory/File.
showHidden	-a, --show-hidden	Boolean Flag for Returning/Displaying Hidden Files/Directories if Value Set to True.
ignoreList	-I, --ignore-list	List of File and Directory Names or Patterns to Ignore.
onlyFiles	-f, --only-files	Boolean Flag to Display Only Files
onlyDirs	-d, --only-dirs	Boolean Flag to Display Only Directories
sortBy	--sort-by	Sorting order. Possible Options: 0 - Default, 1 - Files First, 2 - Directories First
raiseException	--raise-exception	Boolean Flag to Raise Exception. By Default, It Doesn't Raise Exception
printErrorTraceback	--print-error-traceback	Boolean Flag to Print Error Traceback. By Default, It Doesn't Print Error Traceback
exportTxt	-o, --exportTxt	Boolean Flag to Export Directory Tree to TXT File

Command Line

1. Treating the Cloned Directory as Executable -
   (Works if you've cloning privileges but not of installation. You can clone the repo, go to its root and run the below)

python quirky_director

OR

python -m quirky_director

Use the inline help for command-line options:

python quirky_director --help

2. Treating the Package as Module -
   (You would need to install (pip) the Python Package in your system for the below to work)

quirky_director

Use the inline help for command-line options:

quirky_director --help

In Code

Example Script to Print out the Tree Structure of a User-Defined Directory directoryPath!

# Importing Libraries
from quirky_director import DisplayTree

# Main Method
if __name__ == '__main__':
    DisplayTree(directoryPath)

• Here by default, the directoryPath is the current working directory (CWD) unless specified by the user.

Output Examples

Sample Directory Tree -

1. For Current Working Directory with Argument [Header Info = False]

from quirky_director import DisplayTree

DisplayTree()

2. For User Specified Directory with Arguments [String Representation = True, Show Hidden Entities = True]

from quirky_director import DisplayTree

customPath: str = 'A://Coding_Files//To-Do_List'
stringRepresentation: str = DisplayTree(customPath, stringRep=True)
print(stringRepresentation)

Security & Probable Bugs

• Quirky_Director uses recursion. It will raise a RecursionError on 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 \\ instead of \ in the address as using \ might catchup escape sequences and corrupt the address string.

Contact Author

Name : Sahil Dave
Forked From : rahulbordoloi/Directory-Tree

Made with ♥ in Python!