treescaffold 1.4.4

Generate folder structures from various input formats (tree, YAML, simple indentation)

treescaffold (foldertree)

A Python tool to generate folder structures from tree-like format.

Features

• Multiple Input Formats: Supports tree-like structures, YAML, and simple indentation
• Auto-detection: Automatically detects input format
• Comment Support: Adds comments to generated files based on file extensions
• Python Package Detection: Automatically creates __init__.py files in Python packages
• Smart Skipping: Skips common files like __pycache__, .git, node_modules, etc.
• Dry Run Mode: Preview what will be created without actual file creation
• Flexible Output: Specify custom output directories

Installation

Directly from PyPI:

pip install treescaffold

Or from GitHub:

git clone https://github.com/sree-sphere/foldertree.git
cd foldertree
pip install -e .

Usage

Command Line

# From a structure file
treescaffold -f structure.tree
# (alias: `foldertree -f structure.tree`)


# From stdin
echo "api/
  routes.py
core/
  classifier.py" | treescaffold
# (alias: `foldertree`)

# Specify output directory (recommended)
treescaffold -f structure.tree -o project_output
# (alias: `foldertree -f structure.tree -o project_output`)

# Dry run (preview only)
treescaffold -f structure.tree --dry-run
# (alias: `foldertree -f structure.tree --dry-run`)

# Force specific format
treescaffold -f structure.yaml --format yaml
# (alias: `foldertree -f structure.yaml --format yaml`)

Python

from foldertree import TreeParser, TreeGenerator

# Parse structure
parser = TreeParser()
tree = parser.parse("""
api/
  routes.py    # FastAPI endpoints
core/
  classifier.py  # ML model
""")

# Generate structure
generator = TreeGenerator("./output")
result = generator.generate(tree)
print(f"Created {len(result['created_files'])} files")

Input Formats

• Tree Format (with symbols)

├── api/
│   ├── __init__.py
│   └── routes.py
├── core/
│   ├── __init__.py
│   └── classifier.py
├── data/
│   ├── chunks_head/
│   └── highlight.json
└── main.py

• Simple Indentation

api/
  routes.py                  # FastAPI endpoints
core/
  classifier.py              # ML model
main.py

• YAML Format

structure:
  api:
    - routes.py
    - __init__.py
  core:
    - classifier.py
    - __init__.py
  main.py: null

---

Comment Support

The tool automatically adds appropriate comments to files based on their extensions:

• .py files: # Comment
• .js/.ts files: // Comment
• .css files: /* Comment */
• .html/.xml files:
• And many more...

Smart Features

Automatic __init__.py Creation

When directories contain .py files, __init__.py is automatically created to make them proper Python packages.

Intelligent Skipping

Automatically skips common files and directories:

• __pycache__
• .git
• node_modules
• .env
• Build/dist directories
• And more...

Options

• -f, --file: Input file containing folder structure
• -o, --output: Output directory (default: current directory)
• --format: Force input format (tree, yaml, simple, auto)
• --dry-run: Show what would be created without creating files
• -v, --verbose: Verbose output
• --version: Show version