quickscaff 🚀

quickscaff is a modern, lightweight Python CLI tool designed to instantly scaffold project file trees, directory structures, and boilerplate templates.

✨ Features

• ⚡ Fast Scaffolding: Create production-ready folder structures in milliseconds.
• 📦 Built-in Templates: Choose from pre-configured layouts (basic, package, cli).
• 🎨 Template Engine: Dynamic variable substitution ($name, $author, $version, $year).
• 🛡️ Safe Filesystem Operations: Cross-platform path handling using Python's pathlib.
• 🧪 Tested & Reliable: 100% automated unit test coverage with pytest.

💻 Installation

Install via pip:

pip install quickscaff

For local development:

git clone https://github.com/Abdulla/quickscaff.git
cd quickscaff
pip install -e .

🚀 Quick Start

1. Scaffold a Basic Project

quickscaff new my_script --type basic

2. Scaffold a Full Python Package

quickscaff new my_package --type package --author "Abdulla" --description "A custom Python library"

3. Scaffold a CLI Application

quickscaff new my_cli --type cli --author "Abdulla"

4. List All Supported Templates

quickscaff list

📂 Supported Templates

🛠️ Development & Testing

Run unit tests with pytest:

pytest -v

Lint and format code with ruff:

ruff check .
ruff format .

📜 License

Distributed under the MIT License.