A simple Directory Tree Generator
Project description
Directory-Tree
Simple Python CLI App to generate a directory tree for a given path
Current TaskList
- Add support for sorting files and directories
- Add icons and colors to the tree diagram
- Set up the application to publish it as an open source project
Run the App
To run RP Tree, you need to download the source code. Then open a terminal or command-line window and run the following steps:
- Create and activate a Python virtual environment
$ cd rptree_project/
$ python -m venv ./venv
$ source venv/bin/activate
(venv) $
- Run the application
(venv) $ python tree.py /path/to/directory/
Note: The -h
or --help
option provides help on how to use RP Tree.
To take a quick test on RP Tree, you can use the sample home/
directory provided along with the application's code and run the following command:
(venv) $ python tree.py ../hello/
../hello/
│
├── hello/
│ ├── __init__.py
│ └── hello.py
│
├── tests/
│ └── test_hello.py
│
├── requirements.txt
├── setup.py
├── README.md
└── LICENSE
That's it! You've generated a nice directory tree diagram.
Current Features
If you run RP Tree with a directory path as an argument, then you get the full directory tree printed on your screen. The default input directory is your current directory.
RP Tree also provides the following options:
-v
,--version
shows the application version and exits-h
,--help
show a usage message-d
,--dir-only
generates a directory-only tree-o
,--output-file
generates a tree and save it to a file in markdown format
Release History
- 0.1.0
- 1.0.0
- A work in progress
About the Author + Original Fork Address
Leodanis Pozo Ramos - Email: leodanis@realpython.com A fork from https://github.com/realpython/materials/tree/master/directory-tree-generator-python
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.