pytree-stats 1.0.0__tar.gz

pytree_stats-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 JohannesL2
+
+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.

pytree_stats-1.0.0/PKG-INFO

@@ -0,0 +1,73 @@
+Metadata-Version: 2.4
+Name: pytree-stats
+Version: 1.0.0
+Summary: Analyze files and folders fast
+Author: 
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: rich
+Requires-Dist: pyperclip
+Dynamic: license-file
+
+# pytree-stats
+![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)
+
+<p align="center">
+<img width="128" height="128" src="https://github.com/user-attachments/assets/4b45c09f-1aa2-4277-a760-94b916b9e829" />
+</p>
+
+A small Python command-line utility for generating directory tree listings. Use it to inspect folder hierarchies, share file structure snapshots, or compare directory layouts across projects.
+
+<img alt="screenshot" src="https://github.com/user-attachments/assets/afccc1ae-e935-4f32-ae22-1fe169294009" width="400" alt="pytree-stats screenshot" />
+
+## What the project does
+
+`pytree-stats` reads a filesystem path and prints a tree-style view of the directory contents. It is designed as a lightweight, easy-to-run Python script that works without complex setup.
+
+## Why the project is useful
+
+- Quickly inspect folder structure from the terminal
+- **AI-Friendly:** Generates structured output that is easy for LLMs to parse.
+- Useful for documentation, code reviews, and project audits
+- Works cross-platform with Python
+- Simple, no heavy dependencies
+
+## Get started
+
+### Prerequisites
+
+- Python 3.7+
+- [Rich](https://github.com/Textualize/rich) library
+- [pyperclip](https://github.com/asweigart/pyperclip) library
+
+### Installation
+
+1. Clone the repository:
+
+```bash
+git clone https://github.com/JohannesL2/pytree-stats.git
+cd pytree-stats
+```
+
+2. Install dependencies using the requirements file:
+
+```bash
+pip install -r requirements.txt
+```
+
+3. Run the script
+
+```bash
+python tree.py
+```
+
+## Contributing
+
+Contributions are welcome and greatly appreciated! Here is how you can help:
+
+1. Look at the open issues labeled [good first issue](https://github.com/JohannesL2/pytree-stats/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
+2. Fork the repository and create a new branch for your feature or bugfix.
+3. Open a Pull Request (PR) and describe your changes.
+
+Thanks for helping make `pytree-stats` better! 🚀

pytree_stats-1.0.0/README.md

@@ -0,0 +1,61 @@
+# pytree-stats
+![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)
+
+<p align="center">
+<img width="128" height="128" src="https://github.com/user-attachments/assets/4b45c09f-1aa2-4277-a760-94b916b9e829" />
+</p>
+
+A small Python command-line utility for generating directory tree listings. Use it to inspect folder hierarchies, share file structure snapshots, or compare directory layouts across projects.
+
+<img alt="screenshot" src="https://github.com/user-attachments/assets/afccc1ae-e935-4f32-ae22-1fe169294009" width="400" alt="pytree-stats screenshot" />
+
+## What the project does
+
+`pytree-stats` reads a filesystem path and prints a tree-style view of the directory contents. It is designed as a lightweight, easy-to-run Python script that works without complex setup.
+
+## Why the project is useful
+
+- Quickly inspect folder structure from the terminal
+- **AI-Friendly:** Generates structured output that is easy for LLMs to parse.
+- Useful for documentation, code reviews, and project audits
+- Works cross-platform with Python
+- Simple, no heavy dependencies
+
+## Get started
+
+### Prerequisites
+
+- Python 3.7+
+- [Rich](https://github.com/Textualize/rich) library
+- [pyperclip](https://github.com/asweigart/pyperclip) library
+
+### Installation
+
+1. Clone the repository:
+
+```bash
+git clone https://github.com/JohannesL2/pytree-stats.git
+cd pytree-stats
+```
+
+2. Install dependencies using the requirements file:
+
+```bash
+pip install -r requirements.txt
+```
+
+3. Run the script
+
+```bash
+python tree.py
+```
+
+## Contributing
+
+Contributions are welcome and greatly appreciated! Here is how you can help:
+
+1. Look at the open issues labeled [good first issue](https://github.com/JohannesL2/pytree-stats/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
+2. Fork the repository and create a new branch for your feature or bugfix.
+3. Open a Pull Request (PR) and describe your changes.
+
+Thanks for helping make `pytree-stats` better! 🚀

pytree_stats-1.0.0/app/__init__.py

@@ -0,0 +1,5 @@
+from .stats import calc_helper
+from .cli import print_to_terminal
+from .global_ import IGNORE_DIRS
+
+__all__ = ["calc_helper", "print_to_terminal", "IGNORE_DIRS"]

pytree_stats-1.0.0/app/cli.py

@@ -0,0 +1,53 @@
+from __future__ import annotations
+
+from rich.tree import Tree 
+from rich.console import Console
+from rich.filesize import decimal
+from collections import Counter
+from rich.table import Table
+
+
+# Own functions
+from app.core import generate_tree
+from app.export import handle_markdown, handle_copy
+
+
+
+def return_summary(file_counts: Counter) -> Table:
+    """Creates and returns a table with file statistics."""
+    tb_obj = Table(title="File statistics", title_style="bold magenta", show_header=True, header_style="bold cyan")
+
+    tb_obj.add_column("File type", style="dim")
+    tb_obj.add_column("Quantity", justify="right")
+
+    for ext, count in file_counts.most_common():
+        label = ext if ext else "No extension"
+        tb_obj.add_row(label, str(count))
+    
+    return tb_obj
+
+def print_to_terminal(root, total_files, file_counts, total_size, total_folders, ignore):
+    """handles the printing of all text in the Terminal"""
+    t_obj = Tree(f":open_file_folder: [bold cyan]{root.name}[/bold cyan]", guide_style="bright_black")
+    generate_tree(root, t_obj, ignore)
+        
+    # Capture tree as string
+    tree_console = Console(record=True)
+    tree_console.print(t_obj)
+    tree_text_only = tree_console.export_text()
+    print("\n")
+    # Print Summary to Terminal
+    summary_table = return_summary(file_counts)
+    summary_console = Console(record=True)
+    summary_console.print(summary_table)
+    summary_console.print("\n")
+    summary_console.print(f"[bold cyan]Total files scanned:[/bold cyan] {total_files}")
+    summary_console.print(f"[bold cyan]Total folders scanned:[/bold cyan] {total_folders}")
+    summary_console.print(f"[bold cyan]Total size:[/bold cyan] {decimal(total_size)}")
+    summary_text_only = summary_console.export_text()
+    handle_copy(tree_text_only)
+    handle_markdown(summary_text_only, tree_text_only)
+
+
+
+    

pytree_stats-1.0.0/app/core.py

@@ -0,0 +1,68 @@
+from __future__ import annotations
+
+from pathlib import Path
+from rich.tree import Tree 
+from rich.filesize import decimal
+from rich.markup import escape
+from rich.text import Text
+from rich.console import Console
+
+console = Console(record=True)
+def generate_tree(directory: Path, node: Tree, ignore_dirs: set)->None:
+    """Function that builds a file structure tree"""
+    # Sort folders first then files
+    paths = sorted(Path(directory).iterdir(), key=lambda p: (p.is_file(), p.name.lower()))
+
+    for path in paths:
+        # Ignore hidden maps like .git .gitignore
+        if path.name.startswith(".") or path.name in ignore_dirs:
+            continue
+
+        if path.is_dir():
+            # New branch for folders
+            style = "bold blue"
+            branch = node.add(
+                f"[bold blue]📂 {escape(path.name)}[/bold blue]",
+                guide_style="bright_blue"
+            )
+            generate_tree(path, branch, ignore_dirs)
+        else:
+            # Handle files with icons
+            text_filename = Text(path.name)
+            
+            # File extension colors
+            if path.suffix == ".py":
+                text_filename.stylize("green")
+                icon = "🐍"
+            elif path.suffix in [".md", ".txt"]:
+                text_filename.stylize("yellow")
+                icon = "📄"
+            elif path.suffix in [".json", ".yaml", ".yml"]:
+                text_filename.stylize("magenta")
+                icon = "⚙️"
+            elif path.suffix in [".java"]:
+                text_filename.stylize("magenta")
+                icon = "☕️"
+            elif path.suffix in [".kt"]:
+                text_filename.stylize("magenta")
+                icon = "🟣"
+            elif path.suffix in [".class"]:
+                text_filename.stylize("magenta")
+                icon = "🛡️"
+            else:
+                icon = "📄"
+
+            # Add file size for convenience
+            try:
+                file_size = decimal(path.stat().st_size)
+            except PermissionError:
+                console.print(f"[yellow]WARNING:[/yellow] Skipping file (permission denied): {path}")
+                continue
+            
+            text_filename.append(f" ({file_size})", "italic white")
+
+            # Add file size for convenience
+            
+            
+            node.add(Text(f"{icon} ") + text_filename)
+

pytree_stats-1.0.0/app/export.py

@@ -0,0 +1,47 @@
+from __future__ import annotations
+
+from pathlib import Path
+from rich.console import Console
+from rich.prompt import Confirm
+import pyperclip
+
+from app.global_ import HEADING
+
+console = Console(record=True)
+
+def handle_copy(tree_text) -> None:
+    """Ask if the user want the information copy to his/her clipboard"""
+    print("")
+    if Confirm.ask("Do you want to copy the tree structure to clipboard?"):
+        try:
+            
+            pyperclip.copy(tree_text)
+            console.print("[bold green] Copied to clipboard![/bold green]")
+        except Exception as e:
+            console.print(f"[bold red] Failed to copy to clipboard: {e}[/bold red]")
+    else:
+        console.print("[yellow]Skip copying to clipboard.[/yellow]")        
+
+def handle_markdown(summary_text_only:str, tree_text_only:str) ->None:
+    """Ask if the user wants the information delivered in a markdown file"""
+    print("")
+    if Confirm.ask("Do you want to download the tree structure as a Markdown?"):
+        try:
+            file_name = input("Name your file: ")
+            print("")
+            while not Confirm.ask(f"Are you sure you want to name the file {file_name}?"):
+                file_name = input("Name your file: ")
+                print("")
+            if Path(file_name).suffix.lower() != ".md":
+                file_name += ".md"
+            with open(file_name, "w", encoding="utf-8") as f:
+                f.write(f"{HEADING}\n")
+                
+                f.write(f"```text\n{tree_text_only}\n```\n\n")
+                    
+                f.write(f"```text\n{summary_text_only}\n```\n")
+
+        except Exception as e:
+            console.print(f"[bold red] Failed to download the markdown file: {e}[/bold red]")
+    else:
+        console.print("[yellow]Skip downloading markdown file.[/yellow]")

pytree_stats-1.0.0/app/global_.py

@@ -0,0 +1,3 @@
+"""Just a Helper File"""
+IGNORE_DIRS = {".git", "__pycache__", "node_modules", "venv", ".venv", ".DS_Store"}
+HEADING = "## Project Structure"

pytree_stats-1.0.0/app/stats.py

@@ -0,0 +1,32 @@
+from __future__ import annotations
+from typing import Tuple
+from pathlib import Path
+from collections import Counter
+
+
+
+def collect_stats(directory: Path, ignore: set)->Tuple[int,int,list]:
+    """Calculates total_folders and total_size"""
+    all_extensions = []
+    total_size = 0
+    total_folders = 1
+    for path in directory.rglob("*"):
+        if any(part.startswith('.') or part in ignore for part in path.parts):
+            continue
+        if path.is_dir():
+            total_folders += 1
+        elif path.is_file():
+            all_extensions.append(path.suffix.lower())
+            total_size += path.stat().st_size
+    
+    return total_size, total_folders, all_extensions
+
+def calc_helper(root:Path, ignore:set)->Tuple[int,Counter,int,int]:
+    """Helps combining crucial values in one return"""
+    total_size, total_folder, all_extensions= collect_stats(root, ignore)
+    total_files = len(all_extensions)
+    file_counts = Counter(all_extensions)
+
+    return total_files, file_counts, total_size, total_folder
+
+   

pytree_stats-1.0.0/pyproject.toml

@@ -0,0 +1,22 @@
+[build-system]
+requires = ["setuptools>=61"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pytree-stats"
+version = "1.0.0"
+description = "Analyze files and folders fast"
+readme = "README.md"
+requires-python = ">=3.8"
+
+authors = [
+    { name = "" }
+]
+
+dependencies = [
+    "rich",
+    "pyperclip"
+]
+
+[project.scripts]
+pytree-stats = "main:main"

pytree_stats-1.0.0/pytree_stats.egg-info/PKG-INFO

@@ -0,0 +1,73 @@
+Metadata-Version: 2.4
+Name: pytree-stats
+Version: 1.0.0
+Summary: Analyze files and folders fast
+Author: 
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: rich
+Requires-Dist: pyperclip
+Dynamic: license-file
+
+# pytree-stats
+![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)
+
+<p align="center">
+<img width="128" height="128" src="https://github.com/user-attachments/assets/4b45c09f-1aa2-4277-a760-94b916b9e829" />
+</p>
+
+A small Python command-line utility for generating directory tree listings. Use it to inspect folder hierarchies, share file structure snapshots, or compare directory layouts across projects.
+
+<img alt="screenshot" src="https://github.com/user-attachments/assets/afccc1ae-e935-4f32-ae22-1fe169294009" width="400" alt="pytree-stats screenshot" />
+
+## What the project does
+
+`pytree-stats` reads a filesystem path and prints a tree-style view of the directory contents. It is designed as a lightweight, easy-to-run Python script that works without complex setup.
+
+## Why the project is useful
+
+- Quickly inspect folder structure from the terminal
+- **AI-Friendly:** Generates structured output that is easy for LLMs to parse.
+- Useful for documentation, code reviews, and project audits
+- Works cross-platform with Python
+- Simple, no heavy dependencies
+
+## Get started
+
+### Prerequisites
+
+- Python 3.7+
+- [Rich](https://github.com/Textualize/rich) library
+- [pyperclip](https://github.com/asweigart/pyperclip) library
+
+### Installation
+
+1. Clone the repository:
+
+```bash
+git clone https://github.com/JohannesL2/pytree-stats.git
+cd pytree-stats
+```
+
+2. Install dependencies using the requirements file:
+
+```bash
+pip install -r requirements.txt
+```
+
+3. Run the script
+
+```bash
+python tree.py
+```
+
+## Contributing
+
+Contributions are welcome and greatly appreciated! Here is how you can help:
+
+1. Look at the open issues labeled [good first issue](https://github.com/JohannesL2/pytree-stats/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
+2. Fork the repository and create a new branch for your feature or bugfix.
+3. Open a Pull Request (PR) and describe your changes.
+
+Thanks for helping make `pytree-stats` better! 🚀

pytree_stats-1.0.0/pytree_stats.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+LICENSE
+README.md
+pyproject.toml
+app/__init__.py
+app/cli.py
+app/core.py
+app/export.py
+app/global_.py
+app/stats.py
+pytree_stats.egg-info/PKG-INFO
+pytree_stats.egg-info/SOURCES.txt
+pytree_stats.egg-info/dependency_links.txt
+pytree_stats.egg-info/entry_points.txt
+pytree_stats.egg-info/requires.txt
+pytree_stats.egg-info/top_level.txt

pytree_stats-1.0.0/pytree_stats.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pytree_stats-1.0.0/pytree_stats.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+pytree-stats = main:main

pytree_stats-1.0.0/pytree_stats.egg-info/requires.txt

@@ -0,0 +1,2 @@
+rich
+pyperclip

pytree_stats-1.0.0/pytree_stats.egg-info/top_level.txt

@@ -0,0 +1 @@
+app

pytree_stats-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+