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