treegenix

# 🌳 treegenix

[![PyPI version](https://img.shields.io/pypi/v/treegenix?color=brightgreen)](https://pypi.org/project/treegenix/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
[![Python](https://img.shields.io/badge/python-3.7%2B-blue.svg)](https://www.python.org/)

**treegenix** is a lightweight Python CLI tool to beautifully display the directory structure of any folder — like the classic `tree` command, but written in Python, with customization and clean output.

---

## ✨ Features

- 📁 Visualize any folder's file structure in a clean tree format
- ❌ Easily exclude folders/files (e.g., `venv`, `__pycache__`, `.git`)
- 💻 Command-line interface
- 🙈 Ignores hidden files/folders by default
- 🐍 Pure Python, no external dependencies

---

## 📦 Installation

Install via [PyPI](https://pypi.org/project/treegenix/):

```bash
pip install treegenix

🚀 Usage

After installation, run treegenix from your terminal.

treegenix [path] [--exclude folder1 folder2 ...]

📌 Arguments

• path (optional): Path to the directory you want to scan. Defaults to the current directory.
• --exclude: List of folder or file names to exclude from the tree.

🔍 Examples

1. Show structure of current directory:

treegenix

2. Show structure of a specific directory:

treegenix ./my_project

3. Exclude folders like venv and __pycache__:

treegenix . --exclude venv __pycache__

Output:

my_project/
├── app/
│   ├── __init__.py
│   └── main.py
├── README.md
└── requirements.txt

🧪 Development Setup

If you'd like to contribute:

git clone https://github.com/sujal-1245/treegenix.git
cd treegenix
pip install -e .
python -m treegenix .

📄 License

Licensed under the MIT License.

👤 Author

Sujal Bhagat 🔗 GitHub Profile

---