treecount 0.0.2

Description:

treecount 0.0.2

Treecount Package






About
Ever get confused in counting the number of files in a set of directories? No Worries!
treecount is a simple fork of Directory-tree python utility package that displays out the Tree Structure of a user-defined directory with their respective file count.
Currently Available for All Platforms.
Installation
Run the following command on your terminal to install treecount:
1 . Installing the package using pip:
pip install treecount

OR
pip3 install treecount

2 . Cloning the repository:
git clone https://github.com/rushic24/treecount/
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 treecount 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 treecount 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 treecount 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 treecount
To install treecount, along with the tools you need to develop and run tests, and execute the following in your virtualenv:
$ pip install -e .[dev]