scaffold-kit

A comprehensive toolkit for project initialization and structure management. Create projects from structured data definitions, generate file checklists for tracking progress, and visualize directory hierarchies with ASCII trees.

Installation

Install from PyPI:

pip install scaffold-kit

Install with uv:

uv add scaffold-kit

Install development releases from TestPyPI:

pip install -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ scaffold-kit

Install development releases from TestPyPI with uv:

uv add --index https://test.pypi.org/simple/ --index https://pypi.org/simple/ scaffold-kit

Usage

scaffold-kit provides four main commands for project management:

Initialize a project with example files:

scaffold-kit init [ignore-file|config-file|scaffold-file]

Create project structure from YAML/JSON definition:

scaffold-kit scaffold [--root]

Generate a file checklist for progress tracking:

scaffold-kit checklist

Create an ASCII tree of directory structure:

scaffold-kit tree [directory] [--ignore-file FILE]

Links

• Repository - Main GitHub repository
• Package - PyPI package page
• Test Package - TestPyPI package page for development releases
• Getting Started - This README with basic usage and examples
• Full Documentation - Complete guides, tutorials, and examples
• API Reference - Detailed API documentation and code reference
• Issues & Bug Reports - Report bugs or request features

Acknowledgments

• uv - Fast Python package installer and resolver
• asdf - Multi-language version manager
• Semantic Release - Automated versioning
• Pre-commit - Git hooks for code quality
• MkDocs - Documentation generator
• Sphinx - API documentation generator