branchify 1.0.0

Generate an ASCII folder structure of a directory

Branchify 📂

Branchify generates an ASCII folder structure from any directory. Works for Python>=3.4 Documentation : Check out the documentation here: https://pypi.org/project/branchify/

Features

✅ Command-line Interface (CLI) & Python API
✅ Smart Ignoring of common directories and file types
✅ Explicit Inclusions for directories or file patterns
✅ Configurable File Limit

---

Installation

pip install branchify

---

CLI Usage

1️⃣ Generate a Folder Structure (Default)

branchify

2️⃣ Specify a Directory

branchify --path my_project

3️⃣ Ignore Specific Directories

branchify --ignore node_modules venv

4️⃣ Explicitly Include Some Directories or Files

branchify --include-dir logs --include-pattern '*.json'

5️⃣ Set a Custom File Limit

branchify --file-limit 5

6️⃣ Save Output to a File

branchify --output structure.txt

7️⃣ Update Branchify to the latest version

branchify --update

---

Python API Usage

from branchify import FolderStructureGenerator

generator = FolderStructureGenerator(root_dir="my_project", file_limit=5)
print(generator.generate())

With custom ignores:

ignores = {"directories": ["build"], "patterns": ["*.log"]}
generator = FolderStructureGenerator(root_dir="my_project", ignores=ignores, file_limit=3)
print(generator.generate())

---

Sample Usage

---

Example Output

sample_project/
├── src/
│   ├── main.py
│   ├── utils.py
│   ├── config/
│   │   ├── settings.json
│   │   ├── defaults.yml
│   ├── __init__.py
├── README.md
└── tests/
    ├── test_main.py
    ├── test_utils.py
    └── ...

---

LICENSE

This project is licensed under the BSD 3-Clause License

---

Contributing

If you'd like to contribute to Branchify, please open an issue or a pull request at the repository