pytree-stats

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.

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 library
• pyperclip library

Installation

1. Clone the repository:

git clone https://github.com/JohannesL2/pytree-stats.git
cd pytree-stats

2. Install dependencies using the requirements file:

pip install -r requirements.txt

3. Run the script

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.
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! 🚀