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

[quickscaff] Scaffolding 'my_script' using 'basic' template...
[success] Created project at: /home/user/my_script

Next steps:
  cd my_script

my_script/
├── .gitignore
├── README.md
└── main.py

2. Scaffold a Full Python Package

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

[quickscaff] Scaffolding 'my_package' using 'package' template...
[success] Created project at: /home/user/my_package

Next steps:
  cd my_package

my_package/
├── .gitignore
├── README.md
├── pyproject.toml
├── my_package/
│   ├── __init__.py
│   └── module.py
└── tests/
    ├── __init__.py
    └── test_module.py

3. Scaffold a CLI Application

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

[quickscaff] Scaffolding 'my_cli' using 'cli' template...
[success] Created project at: /home/user/my_cli

Next steps:
  cd my_cli

my_cli/
├── .gitignore
├── README.md
├── pyproject.toml
├── my_cli/
│   ├── __init__.py
│   └── cli.py
└── tests/
    ├── __init__.py
    └── test_cli.py

4. List All Supported Templates

quickscaff list

Available quickscaff Templates:
  - basic
  - package
  - cli

📂 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.