📁🌳 wintree
This library was born out of the limitations of the default Windows tree command.
wintree is a Python library that displays the directory structure in a tree format for any specified path.
It can be easily used from the command line and supports features like emoji-based visual tree rendering and directory exclusion.
Additionally, it can output the tree structure as JSON, making it suitable for integration with GUI applications.
🔋 Install
pip install wintree
🚀 Usage
📚️ As a Library
import wintree
print(wintree.tree())
# sample output
📂 root: .
├── 📄 .gitignore
├── 📄 README.md
├── 📄 pyproject.toml
├── 📁 src/
│ ├── 📁 assets/
│ │ ├── 📄 icon.png
│ │ └── 📄 splash_android.png
│ └── 📄 main.py
└── 📁 storage/
├── 📁 data/
└── 📁 temp/
With arguments:
from wintree import tree
print(tree(root_dir="/path/to/project", use_emoji=True, ignore_dirs=[".git", "__pycache__"], filter_exts=[".py",".txt"]))
| Argument | Type | Description |
|---|---|---|
| root_dir | str | Path to the root directory to start displaying the tree. Default is the current directory "." |
| use_emoji | bool | Whether to use emojis in the tree view. If True, adds icons to folders and files. |
| ignore_dirs | List[str] | List of directory names to exclude from the tree (partial match). Example: [".git", "node_modules"] |
| filter_ext | List[str] | File extensions to include. Example: [".py", "txt"] |
Get or save as JSON
# Get as a dictionary
data = wintree.tree_to_dict(show_meta=True)
# Save as a JSON file
wintree.tree_to_json(root_dir="path/to/project" ,save_path="path/to/project_tree.json")
You can also list file paths vertically as relative or absolute paths from the root directory, instead of using a tree structure.
import wintree
print(wintree.list_files())
⚙️ Usage from CLI
wintree /path/to/project --exclude .git __pycache__
Options
| Option | Description |
|---|---|
| path | Path to the root directory |
| --no-emoji | Disable emoji display |
| --exclude | Specify directory names to exclude (partial match, space-separated) |
| --ext | File extensions to include |
| --no-tree | List absolute paths instead of a tree structure |
| --abs | Output absolute file paths |
| --json-output | Path to save the file hierarchy in |
| --show-meta | Include timestamp and file size in JSON output |
📌 Features
- Emoji-based tree view for better visibility
- Flexible exclusion of target directories
- Supports Windows/macOS/Linux
- Pure Python, no external dependencies
🧪 For Developers
This library can also be used as a base for directory visualization tools. Integration with GUI tools or IDE plugins is also possible.
📄 License
MIT License
🌐 Language
Metadata
Release files for wintree 0.1.17
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| wintree-0.1.17.tar.gz | 5.8 kB | Without provenance | Details for wintree-0.1.17.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| wintree-0.1.17-py3-none-any.whl | Python 3 | none | any | Details for wintree-0.1.17-py3-none-any.whl |
Total release size: 12.5 kB
Release files / wintree-0.1.17.tar.gz
| Download URL | wintree-0.1.17.tar.gz |
|---|---|
| Size | 5.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ab8cc64f29812eaf688ac5fb68bc10405d40ad35913a27c2f8e19d87ea4acd11
|
|
BLAKE2b-256 checksum How to use checksums |
77e1ee78dca9040970fac870b3fcb5405b2960a36d1799b5616da5c14a75e564
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.1.3 CPython/3.12.0 Windows/11
|
Release files / wintree-0.1.17-py3-none-any.whl
| Download URL | wintree-0.1.17-py3-none-any.whl |
|---|---|
| Size | 6.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8913b946169125ff19cbdf03bd6d5abad91e9451d1294d33f47d3152d207eb21
|
|
BLAKE2b-256 checksum How to use checksums |
46d05eb2d24fd42e0e852486dccd95ccd58ba0fac183777def7526eb77265fcf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.1.3 CPython/3.12.0 Windows/11
|
Security for wintree 0.1.17
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.