pyqtrapid

A modern CLI scaffolding tool and architecture boilerplate generator for PyQt6, PySide6, and PyQt5 applications.

pyqtrapid empowers Python developers to launch clean, scalable desktop GUI applications in seconds using proven software design patterns (MVP/MVVM), modern dark themes, built-in resource management, and test suites out of the box.

🚀 Features

• Multi-Binding Support: Seamlessly scaffold projects targeting PyQt6, PySide6 (Qt for Python 6), or legacy PyQt5.
• Clean Architecture (MVP): Enforces Model-View-Presenter architecture out of the box to separate UI layouts from domain logic and state.
• Dynamic Jinja2 Scaffolding: Fast, customizable template engine generating modern package configurations (pyproject.toml).
• Included Dark Theme: Comes pre-configured with a sleek modern QSS dark theme stylesheet.
• Built-in Test Suite: Pre-configured pytest suite for testing domain models without Qt UI dependencies.

📦 Installation

Install pyqtrapid via pip:

pip install pyqtrapid

Or install locally in editable mode:

pip install -e .

⚡ Quick Start

1. Scaffold a New Project

To create a new project using the default PyQt6 binding:

pyqtrapid startproject my_app

2. Choose Your Qt Binding

Specify your preferred Qt Python binding (pyqt6, pyside6, or pyqt5):

# Target PySide6 (Official Qt for Python 6)
pyqtrapid startproject my_app --binding pyside6

# Target PyQt5
pyqtrapid startproject my_app --binding pyqt5

3. Run Your Scaffolded Application

cd my_app
pip install -e .
python main.py

🏗️ Generated Architecture

pyqtrapid scaffolds projects structured for long-term scalability and clean maintenance:

my_app/
├── main.py                   # Entry point (QApplication & window runner)
├── pyproject.toml            # Project dependencies and pytest settings
├── src/
│   ├── app.py                # Component wiring & factory function
│   ├── models/               # Pure Python domain state & models
│   ├── views/                # Qt Widgets & visual layouts
│   ├── presenters/           # Presentation logic connecting Views & Models
│   └── resources/            # QSS stylesheets, icons & static assets
├── ui/                       # Qt Designer .ui files
└── tests/                    # Unit tests (pytest)

👤 Author

• Eden Iyanda - Twitter/X | Email | GitHub

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.