Creating a custom directory tree is an efficient method for visually organizing your project's directory structure, complete with detailed information. It provides a clear model of your project layout for easy reference and management.
Project description
Custom Tree
Overview
This project directory is organized using a hierarchical structure to efficiently manage and navigate through various files and directories. Below is a breakdown of the directory tree along with explanations for each directory and file.
Installation
pip install custom-tree
then run:
custom-tree
you will see your current directory tree in the console.
Saving Directory Tree: If you want to save the results of your current directory tree Run this
custom-tree --output OR -o file_name.txt
it will generate the results in the current directory file_name.txt
.
Installation Path: Ensure that the installation path for Python packages is included in your system's PATH environment variable. This path typically includes the Scripts directory inside the Python installation directory.
Shell Restart: If you're using a shell (like Bash), you might need to restart it to pick up the changes to the PATH environment variable.
Installation Location: Double-check the installation location of the package. If it's not installed in the expected location, you might need to investigate why the installation path is different.
Executable Name: Ensure that the name specified in the console_scripts
entry point in your setup.py
matches the
command you're trying to run. In this case, it should be custom-tree
.
Permissions: Make sure that you have the necessary permissions to execute commands from the installed package.
Virtual Environment: If you're using a virtual environment, ensure that it is activated when you try to run the command.
Directory Tree
project_directory/
๐ src/
โ ๐ main/
โ โ ๐ java/
โ โ โ ๐ com/
โ โ โ ๐ Main.java
โ โ ๐ resources/
โ โ โ ๐ config/
โ โ โ ๐ application.properties
โ โ ๐ webapp/
โ โ ๐ index.html
โ ๐ test/
โ โ ๐ java/
โ โ โ ๐ com/
โ โ โ ๐ MainTest.java
โ โ โ ๐ example/
โ โ โ ๐ MainTest.java
โ โ ๐ resources/
โ โ ๐ test_config/
โ โ ๐ test.properties
๐ docs/
โ ๐ documentation.md
๐ README.md
๐ LICENSE
New Feature: Include Hidden Directories
The custom-tree
tool now supports including hidden directories in the directory tree structure. Hidden directories are
those whose names begin with a dot (.
), such as .git
or .config
. By default, hidden directories are excluded from
the tree structure.
Usage
To include hidden directories in the tree structure, use the --hidden
flag when running the custom-tree
command:
custom-tree --hidden
Example: Consider the following directory structure:
๐ my_project/
| ๐ .git/
| | ๐ config
| | \--- ...
| ๐ src/
| | ๐ main.py
| | \--- ...
| ๐ tests/
| | ๐ test.py
| | ๐ test_directory/
| | | ๐ test_file.txt
| | \--- ...
| ๐ README.md
Without the --hidden flag, running dir-tree would output:
๐ my_project/
| ๐ src/
| | ๐ main.py
| | \--- ...
| ๐ tests/
| | ๐ test.py
| | \--- ...
| ๐ README.md
With the --hidden
flag, hidden directories are included:
๐ my_project/
| ๐ .git/
| | ๐ config
| | \--- ...
| ๐ src/
| | ๐ main.py
| | \--- ...
| ๐ tests/
| | ๐ test.py
| | ๐ test_directory/
| | | ๐ test_file.txt
| | \--- ...
| ๐ README.md
Note: Including hidden directories can be useful for inspecting the entire directory structure, including version control files (e.g., .git) or configuration directories (e.g., .config). However, be cautious when sharing or distributing directory tree structures that include hidden directories, as they may contain sensitive information.
If you have any issue please submit it here. https://github.com/dragon-devs/custom-tree
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.
Source Distribution
Built Distribution
File details
Details for the file custom-tree-1.7.tar.gz
.
File metadata
- Download URL: custom-tree-1.7.tar.gz
- Upload date:
- Size: 4.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.11.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 48b82c0a155e18469198d7dff070d006da737cb7bb21ab30cba77e1bf756950d |
|
MD5 | 5f52c72fa7040a005d1649f8def2536a |
|
BLAKE2b-256 | d9d3c294ae8540462d8dad6707b2a02f53e6035d8e98bc669f36fccac771b97f |
File details
Details for the file custom_tree-1.7-py3-none-any.whl
.
File metadata
- Download URL: custom_tree-1.7-py3-none-any.whl
- Upload date:
- Size: 5.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.11.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d52d47d6defd666dbc9491fb73a067b5d0a93400bff96114cab98272a6be2f69 |
|
MD5 | e79e7c09d423764bdc7b3c6911673a29 |
|
BLAKE2b-256 | a06726b28a6b79b0303d14fe49f5f854ec8dc4a25724ae1af2a83c0fa7851e67 |