Utility Package that displays out the Tree Structure of a Particular Directory.
Project description
Directory Tree Package
About
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.
Installation
Run the following command on your terminal to install directory_tree
:
1 . Installing the package using pip
:
pip install directory_tree
OR
pip3 install directory_tree
2 . Cloning the repository:
git clone https://github.com/rahulbordoloi/Directory-Tree/
cd Directory-Tree
pip install -e .
Usage
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(directory_path)
- Here by default, the
directory_path
is the current working directory (CWD) unless specified by the user.
Output
- For Current Working Directory [DEFAULT]
>>> from directory_tree import display_tree
>>> display_tree()
$ Operating System : Windows
$ Path : C:\Personal\Work\Directory-Tree\Test\Main Directory
*************** Directory Tree ***************
Main Directory/
├── Directory 1/
│ └── Directory 2/
│ ├── Directory 3/
│ │ └── Directory 4/
│ │ └── Hello World.txt
│ └── Say World.txt
├── Directory A/
│ └── Hmm.txt
├── directory-tree-print.cpp
├── letseee.txt
└── printTree.exe
- For User Specified Directory [Argument]
>>> from directory_tree import display_tree
>>> display_tree('C:\Personal\Work\Directory-Tree\Test\Main Directory')
$ Operating System : Windows
$ Path : C:\Personal\Work\Directory-Tree\Test\Main Directory
*************** Directory Tree ***************
Main Directory/
├── Directory 1/
│ └── Directory 2/
│ ├── Directory 3/
│ │ └── Directory 4/
│ │ └── Hello World.txt
│ └── Say World.txt
├── Directory A/
│ └── Hmm.txt
├── directory-tree-print.cpp
├── letseee.txt
└── printTree.exe
Developing Directory Tree
To install 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 & Bugs
Directory Tree
uses recursion. It will raise aRecursionError
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.
- Currently
Directory Tree
doesn't support the functionality of ignoring files/directories in a particular path, so will print every files-directories present in the given path. - 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 : Rahul Bordoloi
Website : https://rahulbordoloi.me
Email : rahulbordoloi24@gmail.com
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for directory_tree-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 535299f29b0b4df776a0ba530e037cb4bd4012f7a8eac048f9f0eaf43a64f800 |
|
MD5 | abb412ad195c7258b3c35db5b4ccfa44 |
|
BLAKE2b-256 | fd18e9a12faf5ce168e8e6a74d044505a0b68cae1de0b5160526a754cf1b7456 |