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
Arguments
Parameters | Description |
---|---|
dir_path | Refers to the Directory Path of Operation. By default, refers to the Current Working Directory. |
string_rep | Refers to whether you just want the direct output or a string representation of the same. |
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] [String Representation =
False
]
>>> 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] [String Representation =
True
]
>>> from directory_tree import display_tree
>>> stringRepresentation = display_tree('C:\Personal\Work\Directory-Tree\Test\Main Directory', string_rep = True)
>>> print(stringRepresentation)
$ 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.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2d67cf4fd9394b2a8dd30d2be074afc51ac61c5bd121b3bf91803e08b4fb6a3d |
|
MD5 | 9b6f682a391cff04d5be2a9c1b8047db |
|
BLAKE2b-256 | 89be02240d063df7e89e95680401b1d824018f77b571ac096b2c3cf20b4a07d2 |