directory-tree-printer 0.4.1__py3-none-any.whl

directory_tree_printer-0.4.1.dist-info/METADATA

@@ -0,0 +1,340 @@
+Metadata-Version: 2.4
+Name: directory-tree-printer
+Version: 0.4.1
+Summary: A Python CLI tool for generating clean directory tree structures.
+Author: AmirmasoudCS
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/AmirmasoudCS/Tree-Printer
+Project-URL: Repository, https://github.com/AmirmasoudCS/Tree-Printer
+Project-URL: Issues, https://github.com/AmirmasoudCS/Tree-Printer/issues
+Keywords: tree,cli,directory,filesystem,terminal
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Environment :: Console
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pathspec
+Requires-Dist: rich
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: setuptools-scm[toml]>=8; extra == "dev"
+Dynamic: license-file
+
+
+# 🌲 Tree Printer
+
+[![GitHub Release](https://img.shields.io/github/v/release/AmirmasoudCS/Tree-Printer)](https://github.com/AmirmasoudCS/Tree-Printer/releases)
+[![Tests](https://github.com/AmirmasoudCS/Tree-Printer/actions/workflows/tests.yml/badge.svg)](https://github.com/AmirmasoudCS/Tree-Printer/actions/workflows/tests.yml)
+[![License](https://img.shields.io/github/license/AmirmasoudCS/Tree-Printer)](LICENSE)
+[![Python](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://www.python.org/)
+
+A lightweight and customizable command-line utility for generating beautiful directory tree structures directly from your terminal.
+
+Tree Printer makes it easy to visualize project layouts, document repositories, create examples for documentation, and inspect filesystem structures with optional icons, metadata, filtering, sorting, and color themes.
+
+---
+
+## ✨ Features
+
+- 🌳 Generate recursive directory trees
+- 📁 Display directories only
+- 👁️ Show or hide hidden files
+- 🚫 Exclude files, directories, or file extensions
+- 📏 Limit recursion depth
+- 🔤 Sort entries by:
+  - Name
+  - Size
+  - Last modified date
+- 📊 Display file size
+- 🕒 Display modification timestamps
+- 🎨 Multiple color themes
+- 🖼️ Optional file and folder icons
+- 📝 Export output to text files
+- 🚫 Respect `.gitignore`
+- ⚡ Fast and lightweight
+- 🧪 Fully tested with pytest
+- 🔄 Continuous Integration using GitHub Actions
+
+---
+
+## 📦 Installation
+
+### From PyPI (Recommended)
+
+```bash
+pip install directory-tree-printer
+````
+
+### From source
+
+```bash
+git clone https://github.com/AmirmasoudCS/Tree-Printer.git
+
+cd Tree-Printer
+
+pip install .
+```
+
+---
+
+## 🚀 Quick Start
+
+Print the current directory
+
+```bash
+tp .
+```
+
+Print another directory
+
+```bash
+tp path/to/project
+```
+
+Print only directories
+
+```bash
+tp --dirs-only
+```
+
+Show icons
+
+```bash
+tp --icons
+```
+
+Show file sizes
+
+```bash
+tp --size
+```
+
+Limit depth
+
+```bash
+tp --max-depth 2
+```
+
+Save output
+
+```bash
+tp --output tree.txt
+```
+
+---
+
+## 📖 Examples
+
+### Basic
+
+```bash
+tp .
+```
+
+```text
+project
+├── src
+│   ├── main.py
+│   └── utils.py
+├── README.md
+└── pyproject.toml
+```
+
+---
+
+### Icons
+
+```bash
+tp --icons
+```
+
+```text
+📁 project
+├── 📁 src
+│   ├── 🐍 main.py
+│   └── 🐍 utils.py
+├── 📘 README.md
+└── ⚙️ pyproject.toml
+```
+
+---
+
+### File Sizes
+
+```bash
+tp --size
+```
+
+```text
+README.md (5.8 KB)
+main.py (4.2 KB)
+config.py (831 B)
+```
+
+---
+
+### Modified Dates
+
+```bash
+tp --modified
+```
+
+```text
+README.md (2026-05-12 18:42)
+main.py (2026-05-11 14:30)
+```
+
+---
+
+### Themes
+
+```bash
+tp --theme sunset
+```
+
+![Sunset Theme](images/themeImage1.png)
+
+---
+
+## ⚙️ CLI Options
+
+| Option               | Alias | Description                         |
+| -------------------- | ----- | ----------------------------------- |
+| `--max-depth`        | `-md` | Limit recursion depth               |
+| `--show-hidden`      | `-sh` | Include hidden files                |
+| `--dirs-only`        | `-do` | Show only directories               |
+| `--exclude-dirs`     | `-ed` | Exclude directories                 |
+| `--exclude-files`    | `-ef` | Exclude files                       |
+| `--exclude-suffixes` | `-es` | Exclude file extensions             |
+| `--sort`             | `-st` | Sort by name, size or modified      |
+| `--size`             | `-s`  | Display file sizes                  |
+| `--modified`         | `-m`  | Display modified dates              |
+| `--icons`            | `-i`  | Display icons                       |
+| `--theme`            | `-th` | Select a color theme                |
+| `--no-color`         | `-nc` | Disable colored output              |
+| `--gitignore`        | `-gi` | Ignore files listed in `.gitignore` |
+| `--output`           | `-o`  | Write output to a file              |
+| `--version`          | `-v`  | Show installed version              |
+
+---
+
+## 🧪 Development
+
+Clone the repository
+
+```bash
+git clone https://github.com/AmirmasoudCS/Tree-Printer.git
+```
+
+Install development dependencies
+
+```bash
+pip install -e ".[dev]"
+```
+
+Run the test suite
+
+```bash
+pytest
+```
+
+Run tests with coverage
+
+```bash
+pytest --cov=tree_printer --cov-report=term-missing
+```
+
+Build the package
+
+```bash
+python -m build
+```
+
+Verify the package
+
+```bash
+python -m twine check dist/*
+```
+
+---
+
+## 📂 Project Structure
+
+```text
+ 
+├── 📁 images
+│   └── 🖼️ themeImage1.png
+├── 📁 tests
+│   ├── 🐍 __init__.py
+│   ├── 🐍 test_cli.py
+│   ├── 🐍 test_formatter.py
+│   └── 🐍 test_printer.py
+├── 📁 tree_printer
+│   ├── 🐍 __init__.py
+│   ├── 🐍 cli.py
+│   ├── 🐍 config.py
+│   ├── 🐍 file_types.py
+│   ├── 🐍 formatter.py
+│   ├── 🐍 icons.py
+│   ├── 🐍 models.py
+│   ├── 🐍 printer.py
+│   └── 🐍 themes.py
+├── 📘 CHANGELOG.md
+├── ⚖️ LICENSE
+├── 🐍 main.py
+├── ⚙️ pyproject.toml
+├── 📘 README.md
+└── 📝 requirements-dev.txt
+```
+
+---
+
+## 🛣️ Roadmap
+
+Future improvements include:
+
+* Additional export formats
+* Custom icon packs
+* More color themes
+* Configuration file support
+* Improved Windows terminal support
+* Performance improvements for very large directories
+
+Suggestions and pull requests are always welcome.
+
+---
+
+## 🤝 Contributing
+
+Contributions, feature requests, and bug reports are welcome.
+
+If you'd like to contribute:
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Run the test suite
+5. Submit a Pull Request
+
+---
+
+## 📜 Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for release history.
+
+---
+
+## ⚖️ License
+
+This project is licensed under the MIT License.
+
+See [LICENSE](LICENSE) for details.
+
+---

directory_tree_printer-0.4.1.dist-info/RECORD

@@ -0,0 +1,17 @@
+directory_tree_printer-0.4.1.dist-info/licenses/LICENSE,sha256=lk9TUL2BhgEyBqk8cIk99ySGEo_m1qLWqnRXWDulBi4,1067
+tree_printer/__init__.py,sha256=vpM83YWnxWMxcoMv_LYyBKscx2FBtGIsVd6ap8gbDWI,169
+tree_printer/cli.py,sha256=rxd5HCgpIV2JB7vNtsECNEykdxI7p0xtoR_ElR9AD5A,4039
+tree_printer/config.py,sha256=Cs2QXo4fQC2_rbw7_-t5X9Yr_16puxqsfvTzIZfS5uA,227
+tree_printer/file_types.py,sha256=a-nNISqJKX02ZDBCYK-gZIifmnLlNcMUF0UDwglEylc,391
+tree_printer/formatter.py,sha256=tq1_BcL3G97IoGjcjE1w695rHqDh6_XWX9gGmXfhlww,3137
+tree_printer/icons.py,sha256=0ir8PjHpaZowNFzucbnkuJmmGZ7CvD2hKtBhVn54ODA,444
+tree_printer/models.py,sha256=c7Ovq3XEy5O5TFs5H02QcZgpw8UWUeshob5gEgLdhSI,226
+tree_printer/printer.py,sha256=mm4Ebgiin7MOk-rwwSmar_TkTxMQJzvErhBaRw6P2R0,4717
+tree_printer/themes.py,sha256=OmF5bisNZBpCOyxnU433Jq8s0s1RbxWGkUamqBpJYVE,4079
+directory_tree_printer-0.4.1.dist-info/METADATA,sha256=biB9T6UHOkmtuUCK1DA8R-UATHA9P4z4ZZDjBG3qOmQ,6987
+directory_tree_printer-0.4.1.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+directory_tree_printer-0.4.1.dist-info/entry_points.txt,sha256=KXraYIy_PcOWs4odhwXv4thpd5WBX6kaRPAeEwN77p0,80
+directory_tree_printer-0.4.1.dist-info/scm_file_list.json,sha256=w4cBoWsO4LNe0V6zbkbUqT0rCusn_gnPWnkM7tL2-TA,643
+directory_tree_printer-0.4.1.dist-info/scm_version.json,sha256=BZRbRlGczaDc5grvnF8kaFHL6d5NDoL9-jgRNyX1Yc0,160
+directory_tree_printer-0.4.1.dist-info/top_level.txt,sha256=wjkoS3ajkA1yI03t4-VJyME4ba-4qkhp-8Rcek86x3w,13
+directory_tree_printer-0.4.1.dist-info/RECORD,,

directory_tree_printer-0.4.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

directory_tree_printer-0.4.1.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+tp = tree_printer.cli:run
+tree-printer = tree_printer.cli:run

directory_tree_printer-0.4.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Amirmasoud
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

directory_tree_printer-0.4.1.dist-info/scm_file_list.json

@@ -0,0 +1,27 @@
+{
+  "files": [
+    "README.md",
+    "LICENSE",
+    "pyproject.toml",
+    "CHANGELOG.md",
+    "main.py",
+    ".gitignore",
+    "requirements-dev.txt",
+    "images/themeImage1.png",
+    "tree_printer/icons.py",
+    "tree_printer/formatter.py",
+    "tree_printer/__init__.py",
+    "tree_printer/config.py",
+    "tree_printer/models.py",
+    "tree_printer/themes.py",
+    "tree_printer/cli.py",
+    "tree_printer/printer.py",
+    "tree_printer/file_types.py",
+    "tests/__init__.py",
+    "tests/test_printer.py",
+    "tests/test_formatter.py",
+    "tests/test_cli.py",
+    ".github/workflows/release.yml",
+    ".github/workflows/tests.yml"
+  ]
+}

directory_tree_printer-0.4.1.dist-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "0.4.1",
+  "distance": 0,
+  "node": "gcd0f1e060c7446e931909c3cd16f582a994f09f8",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-07-04"
+}

directory_tree_printer-0.4.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+tree_printer

tree_printer/__init__.py

@@ -0,0 +1,8 @@
+from .printer import TreePrinter
+from .formatter import TreeFormatter
+from .models import TreeNode
+__all__ = [
+    "TreePrinter",
+    "TreeFormatter",
+    "TreeNode",
+]

tree_printer/cli.py

@@ -0,0 +1,145 @@
+import argparse
+#from rich_argparse import RichHelpFormatter
+from importlib.metadata import version
+from rich.console import Console
+from .themes import THEMES
+__version__ = version("directory-tree-printer")
+from .printer import  TreePrinter
+from .formatter import TreeFormatter
+
+
+def build_parser() -> argparse.ArgumentParser:
+    parser = argparse.ArgumentParser(
+        description="Generate and print directory tree structures"
+    )
+    parser.add_argument(
+        "path",
+        nargs="?",
+        default=".",
+        help="Root directory to generate the tree on"
+    )
+    parser.add_argument(
+        "--max-depth",
+        "-md",
+        type=int,
+        default=None,
+        help="Maximum directory depth that will be generated"
+    )
+    parser.add_argument(
+        "--output",
+        "-o",
+        help = "Write tree output to a file instead of printing"
+    )
+    parser.add_argument(
+        "--show-hidden",
+        "-sh",
+        action="store_true",
+        help="Include hidden files and directories"
+    )
+    parser.add_argument(
+        "--dirs-only",
+        "-do",
+        action="store_true",
+        help="Show directories only"
+    )
+    parser.add_argument(
+        "--exclude-dirs",
+        "-ed",
+        nargs="+",
+        default=None,
+        help="Exclude directories by name"
+    )
+    parser.add_argument(
+        "--exclude-files",
+        "-ef",
+        nargs="+",
+        default=None,
+        help="Exclude files by name"
+    )
+    parser.add_argument(
+        "--exclude-suffixes",
+        "-es",
+        nargs="+",
+        default=None,
+        help="Exclude files by suffixes"
+    )
+    parser.add_argument(
+        "--size",
+        "-s",
+        action="store_true",
+        help="Show file size"
+    )
+    parser.add_argument(
+        "--modified",
+        "-m",
+        action="store_true",
+        help="Show last modified time"
+    )
+    parser.add_argument(
+        "--icons",
+        "-i",
+        action="store_true",
+        help="Show icons next to files and directories"
+    )
+    parser.add_argument(
+        "--sort",
+        "-st",
+        choices=["name", "size", "modified"],
+        default = "name",
+        help = "Sort files by name, size or modified date"
+    )
+    parser.add_argument(
+        "--version",
+        "-v",
+        action="version",
+        version=f"tree-printer {__version__}"
+    )
+    parser.add_argument(
+        "--theme",
+        "-th",
+        default="default",
+        choices=THEMES.keys(),
+        help = "Choose the color theme"
+    )
+    parser.add_argument(
+        "--no-color",
+        "-nc",
+        action="store_true",
+        help="Disable colored output"
+    )
+    parser.add_argument(
+        "--gitignore",
+        "-gi",
+        action="store_true",
+        help="Respect .gitignore file patterns"
+    )
+    return parser
+
+
+def run(argv: list[str] | None = None) -> None:
+    parser = build_parser()
+    args = parser.parse_args(argv)
+    printer = TreePrinter(
+                        root_path=args.path,
+                        show_hidden=args.show_hidden,
+                        dirs_only=args.dirs_only,
+                        exclude_dirs=args.exclude_dirs,
+                        exclude_files=args.exclude_files,
+                        exclude_suffixes=args.exclude_suffixes,
+                        show_size=args.size,
+                        show_modified=args.modified,
+                        sort_by=args.sort,
+                        use_gitignore=args.gitignore
+                        )
+    formatter = TreeFormatter(show_icons=args.icons, theme_name=args.theme)
+    tree = printer.build_tree()
+    lines = formatter.format(tree, max_depth=args.max_depth)
+    if args.output:
+        text_lines = [line.plain for line in lines]
+        with open(args.output, "w", encoding="utf-8") as file:
+            file.write("\n".join(text_lines))
+        print(f"Tree written into {args.output}")
+    else:
+        console = Console(no_color=args.no_color)
+        for line in lines:
+            console.print(line)

tree_printer/config.py

@@ -0,0 +1,16 @@
+DEFAULT_EXCLUDE_DIRS ={
+    ".git",
+    "__pycache__",
+    ".venv",
+    "venv",
+    "dist",
+    "build",
+}
+DEFAULT_EXCLUDE_FILES = {
+    ".DS_Store",
+    "Thumbs.db",
+}
+DEFAULT_EXCLUDE_SUFFIXES = {
+    ".pyc",
+    ".egg-info"
+}

tree_printer/file_types.py

@@ -0,0 +1,19 @@
+FILE_STYLES = {
+    ".py": "python",
+    ".md": "markdown",
+    ".json": "json",
+    ".png": "image",
+    ".jpg": "image",
+    ".jpeg": "image",
+    ".gif": "image",
+    ".csv": "data",
+    ".pdf": "document",
+    ".zip": "archive",
+    ".mp3": "audio",
+    ".mp4": "video",
+    ".html": "web",
+    ".css": "web",
+    ".js": "javascript",
+    ".toml": "config",
+}
+DEFAULT_FILE_STYLE = "file"

tree_printer/formatter.py

@@ -0,0 +1,86 @@
+from datetime import datetime
+from rich.text import Text
+from .file_types import FILE_STYLES, DEFAULT_FILE_STYLE
+from .themes import THEMES
+from tree_printer.models import TreeNode
+from pathlib import Path
+from typing import List
+from .icons import FILE_ICONS, DEFAULT_FILE_ICON
+
+class TreeFormatter:
+    def __init__(
+            self,
+            show_icons : bool = False,
+            theme_name : str = "default"
+    ):
+        self.show_icons = show_icons
+        self.theme = THEMES.get(theme_name, THEMES["default"])
+    def format_metadata(self, node : TreeNode) -> Text:
+        style_key = self.get_style_key(node)
+        style = self.theme.get(style_key, "white")
+        label = f"{self.get_icon(node)}{node.name}"
+        text = Text(label, style=style)
+        metadata = []
+        if node.size is not None:
+            metadata.append(self.format_size(node.size))
+        if node.modified is not None:
+            formatted_date = datetime.fromtimestamp(node.modified).strftime("%Y-%m-%d %H:%M")
+            metadata.append(formatted_date)
+        if metadata:
+            text.append(f" ({' | '.join(metadata)})", style="dim")
+        return text
+    def format_size(self, size_in_bytes : int) -> str:
+        if size_in_bytes < 1024:
+            return f"{size_in_bytes} B"
+        units = ["KB", "MB", "GB", "TB", "PB"]
+        size = float(size_in_bytes)
+        for unit in units :
+            size/=1024
+            if size < 1024:
+                return f"{size:.1f} {unit}"
+        return f"{size:.1f} EB"
+    def format(
+            self,
+            node : TreeNode,
+            prefix : str = "",
+            depth : int = 0,
+            max_depth : int | None = None
+    ) -> list[Text]:
+        if max_depth is not None and depth > max_depth:
+            return []
+        lines = []
+        if depth == 0 :
+            lines.append(self.format_metadata(node))
+        for index, child in enumerate(node.children):
+            is_last = index == len(node.children) - 1
+            connector = "└── " if is_last else "├── "
+            line = Text(prefix + connector)
+            line.append(self.format_metadata(child))
+            lines.append(line)
+            if child.is_dir:
+                extension = "    " if is_last else "│   "
+                lines.extend(
+                    self.format(
+                        child,
+                        prefix=prefix+extension,
+                        depth=depth+1,
+                        max_depth=max_depth
+                    )
+                )
+        return lines
+    def get_icon(self, node : TreeNode) -> str :
+        if not self.show_icons:
+            return ""
+        if node.is_dir:
+            return "📁 "
+        name = node.name.lower()
+        if name == "license":
+            return "⚖️ "
+        suffix = Path(node.name).suffix.lower()
+        return FILE_ICONS.get(suffix, DEFAULT_FILE_ICON)
+    def get_style_key(self, node : TreeNode) -> str:
+        if node.is_dir:
+            return "folder"
+        suffix = Path(node.name).suffix.lower()
+        return FILE_STYLES.get(suffix, DEFAULT_FILE_STYLE)
+    

tree_printer/icons.py

@@ -0,0 +1,21 @@
+FILE_ICONS = {
+    ".py" : "🐍 ",
+    ".md" : "📘 ",
+    ".json": "🧩 ",
+    ".ipynb": "📄 ",
+    ".txt" : "📝 ",
+    ".png": "🖼️ ",
+    ".jpg": "🖼️ ",
+    ".jpeg": "🖼️ ",
+    ".gif": "🎞️ ",
+    ".csv": "📊 ",
+    ".pdf": "📕 ",
+    ".zip": "🗜️ ",
+    ".mp3": "🎵 ",
+    ".mp4": "🎬 ",
+    ".html": "🌐 ",
+    ".css": "🎨 ",
+    ".js": "✨ ",
+    ".toml" : "⚙️ "
+}
+DEFAULT_FILE_ICON = "📄 "

tree_printer/models.py

@@ -0,0 +1,8 @@
+from dataclasses import dataclass, field
+@dataclass
+class TreeNode:
+    name : str
+    is_dir : bool
+    size : int | None = None
+    modified : float | None = None
+    children : list["TreeNode"] = field(default_factory=list)

tree_printer/printer.py

@@ -0,0 +1,129 @@
+from pathlib import Path
+import pathspec
+from .config import DEFAULT_EXCLUDE_DIRS 
+from .config import DEFAULT_EXCLUDE_FILES 
+from .config import DEFAULT_EXCLUDE_SUFFIXES 
+from .models import TreeNode
+from .formatter import TreeFormatter
+from rich.console import Console
+class TreePrinter:
+    def __init__(
+        self,
+        root_path : str | Path = ".",
+        exclude_dirs : list[str] | None = None,
+        exclude_files : list[str] | None = None,
+        exclude_suffixes : list[str] | None = None,
+        show_hidden : bool = False,
+        dirs_only : bool = False,
+        show_size : bool = False,
+        show_modified : bool = False,
+        sort_by : str = "name",
+        use_gitignore : bool = False,
+        console: Console | None = None,
+    ):
+        self.root = Path(root_path)
+        self.use_gitignore = use_gitignore
+        self.gitignore_spec = self.load_gitignore() if use_gitignore else None
+        self.show_hidden = show_hidden
+        self.dirs_only = dirs_only
+        self.show_size = show_size
+        self.show_modified = show_modified
+        self.sort_by = sort_by 
+
+        self.exclude_dirs = (DEFAULT_EXCLUDE_DIRS if exclude_dirs is None else exclude_dirs)
+        self.exclude_files = (DEFAULT_EXCLUDE_FILES if exclude_files is None else exclude_files)
+        self.exclude_suffixes = (DEFAULT_EXCLUDE_SUFFIXES if exclude_suffixes is None else exclude_suffixes)
+        self.console = console or Console()
+    def should_exclude(self, path: Path) -> bool:
+        if path.is_dir() and path.name in self.exclude_dirs:
+            return True
+        if path.is_file() and path.name in self.exclude_files:
+            return True
+        if path.is_file() and path.suffix in self.exclude_suffixes:
+            return True
+
+        spec = getattr(self, "gitignore_spec", None)
+        if spec is not None:
+            try:
+                rel = path.relative_to(self.root)
+            except ValueError:
+                return False
+            rel_str = rel.as_posix()
+            if path.is_dir():
+                rel_str += "/"
+            if spec.match_file(rel_str):
+                return True
+        return False
+    def load_gitignore(self) -> pathspec.PathSpec | None:
+        gitignore_path = self.root/".gitignore"
+        if not gitignore_path.exists():
+            return None
+        try:
+            with open(gitignore_path, "r", encoding="utf-8") as f:
+                return pathspec.PathSpec.from_lines("gitignore", f.readlines())  # was "gitwildmatch"
+        except (OSError, UnicodeDecodeError):
+            return None
+        
+    def render(
+        self,
+        show_icons: bool = False,
+        theme_name: str = "default",
+        max_depth: int | None = None,
+        no_color: bool = False,
+    ) -> None:
+        root = self.build_tree()
+        formatter = TreeFormatter(show_icons=show_icons, theme_name=theme_name)
+        lines = formatter.format(root, max_depth=max_depth)
+        for line in lines:
+            self.console.print(line)
+    def get_items(self, path: Path) -> list[Path]:
+        return sorted(
+            [
+                item
+                for item in path.iterdir()
+                if (
+                    (self.show_hidden or not item.name.startswith("."))
+                    and not self.should_exclude(item)
+                    and (not self.dirs_only or item.is_dir())
+                )
+            ],
+            key=self.sort_key
+        )
+
+    def build_tree(self, path: Path | None = None) -> TreeNode:
+        path = path or self.root
+        size = None
+        modified = None
+        if self.show_size or self.show_modified:
+            stat = path.stat()
+            if self.show_size and path.is_file():
+                size = stat.st_size
+            if self.show_modified:
+                modified = stat.st_mtime
+        node = TreeNode(
+            name=path.name,
+            is_dir=path.is_dir(),
+                size=size,
+                modified=modified
+        )
+
+        if path.is_dir():
+            for item in self.get_items(path):
+                child_node = self.build_tree(item)
+                node.children.append(child_node)
+
+        return node
+    def sort_key(self, path : Path):
+        if self.sort_by == "size":
+            try:
+                size = path.stat().st_size
+            except OSError:
+                size = 0
+            return (not path.is_dir(), -size, path.name.lower())
+        elif self.sort_by == "modified":
+            try:
+                mtime = path.stat().st_mtime
+            except OSError:
+                mtime = 0 
+            return (not path.is_dir(), -mtime, path.name.lower())
+        return (not path.is_dir(), path.name.lower())

tree_printer/themes.py

@@ -0,0 +1,154 @@
+THEMES = {
+    "default": {
+        "folder": "blue",
+        "file": "white",
+        "python": "yellow",
+        "markdown": "cyan",
+        "json": "bright_yellow",
+        "image": "magenta",
+        "data": "green",
+        "document": "red",
+        "archive": "bright_black",
+        "audio": "bright_green",
+        "video": "bright_magenta",
+        "web": "bright_blue",
+        "javascript": "yellow",
+        "config": "bright_cyan",
+    },
+
+    "github": {
+        "folder": "bright_blue",
+        "file": "white",
+        "python": "bright_yellow",
+        "markdown": "bright_white",
+        "json": "yellow",
+        "image": "bright_magenta",
+        "data": "bright_green",
+        "document": "white",
+        "archive": "bright_black",
+        "audio": "green",
+        "video": "magenta",
+        "web": "cyan",
+        "javascript": "yellow",
+        "config": "bright_cyan",
+    },
+
+    "dracula": {
+        "folder": "bright_magenta",
+        "file": "white",
+        "python": "yellow",
+        "markdown": "cyan",
+        "json": "bright_yellow",
+        "image": "magenta",
+        "data": "green",
+        "document": "bright_red",
+        "archive": "bright_black",
+        "audio": "bright_green",
+        "video": "bright_magenta",
+        "web": "bright_cyan",
+        "javascript": "yellow",
+        "config": "bright_blue",
+    },
+
+    "monokai": {
+        "folder": "bright_blue",
+        "file": "white",
+        "python": "bright_green",
+        "markdown": "bright_cyan",
+        "json": "yellow",
+        "image": "magenta",
+        "data": "green",
+        "document": "bright_red",
+        "archive": "bright_black",
+        "audio": "cyan",
+        "video": "bright_magenta",
+        "web": "bright_blue",
+        "javascript": "bright_yellow",
+        "config": "bright_green",
+    },
+
+    "nord": {
+        "folder": "bright_cyan",
+        "file": "white",
+        "python": "yellow",
+        "markdown": "cyan",
+        "json": "bright_yellow",
+        "image": "magenta",
+        "data": "green",
+        "document": "bright_white",
+        "archive": "bright_black",
+        "audio": "bright_green",
+        "video": "bright_magenta",
+        "web": "blue",
+        "javascript": "yellow",
+        "config": "cyan",
+    },
+
+    "solarized": {
+        "folder": "blue",
+        "file": "bright_white",
+        "python": "yellow",
+        "markdown": "cyan",
+        "json": "bright_yellow",
+        "image": "magenta",
+        "data": "green",
+        "document": "red",
+        "archive": "bright_black",
+        "audio": "green",
+        "video": "bright_magenta",
+        "web": "bright_blue",
+        "javascript": "bright_yellow",
+        "config": "cyan",
+    },
+
+    "minimal": {
+        "folder": "white",
+        "file": "white",
+        "python": "white",
+        "markdown": "white",
+        "json": "white",
+        "image": "white",
+        "data": "white",
+        "document": "white",
+        "archive": "bright_black",
+        "audio": "white",
+        "video": "white",
+        "web": "white",
+        "javascript": "white",
+        "config": "white",
+    },
+
+    "neon": {
+        "folder": "bright_cyan",
+        "file": "bright_white",
+        "python": "bright_green",
+        "markdown": "bright_magenta",
+        "json": "bright_yellow",
+        "image": "bright_magenta",
+        "data": "bright_green",
+        "document": "bright_red",
+        "archive": "bright_black",
+        "audio": "bright_cyan",
+        "video": "bright_magenta",
+        "web": "bright_blue",
+        "javascript": "yellow",
+        "config": "bright_cyan",
+    },
+
+    "sunset": {
+        "folder": "bright_red",
+        "file": "bright_white",
+        "python": "yellow",
+        "markdown": "bright_magenta",
+        "json": "bright_yellow",
+        "image": "magenta",
+        "data": "green",
+        "document": "red",
+        "archive": "bright_black",
+        "audio": "bright_green",
+        "video": "bright_red",
+        "web": "bright_yellow",
+        "javascript": "yellow",
+        "config": "bright_magenta",
+    }
+}