Skip to main content

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

Project description

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, etc.
  • Dry Run Mode: Preview what will be created without actual file creation
  • Flexible Output: Specify custom output directories

Installation

pip install foldertree

Usage

Command Line

# From file
foldertree -f structure.tree

# From stdin
echo "api/
  routes.py
core/
  classifier.py" | foldertree

# Dry run (preview only)
foldertree -f structure.tree --dry-run

# Specify output directory
foldertree -f structure.tree -o /path/to/output

# Force specific format
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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

treescaffold-1.0.1.tar.gz (13.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

treescaffold-1.0.1-py3-none-any.whl (8.7 kB view details)

Uploaded Python 3

File details

Details for the file treescaffold-1.0.1.tar.gz.

File metadata

  • Download URL: treescaffold-1.0.1.tar.gz
  • Upload date:
  • Size: 13.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.7

File hashes

Hashes for treescaffold-1.0.1.tar.gz
Algorithm Hash digest
SHA256 3c0d229e75c2b70aab8a2745065226b2c802dbef2ec1636f1525629c32b38b39
MD5 60adb2f97f6e9faa83ed17598f72d881
BLAKE2b-256 51be264efc79fb23f072841debc4e0b0f732e7a06a31f0c5650057a4eb9dadfe

See more details on using hashes here.

File details

Details for the file treescaffold-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: treescaffold-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 8.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.7

File hashes

Hashes for treescaffold-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9375a7189feba0a11c957242176929bca4307b4c7195450cbe199630fb754143
MD5 45204c4ffcee0224a55f0239b8d4e57f
BLAKE2b-256 c206f93440dd80a1e023c118441b17c8ddb76166babc2fee3286e1a2e09ac4a4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page