quickscale 0.71.0__tar.gz

quickscale-0.71.0/PKG-INFO

@@ -0,0 +1,220 @@
+Metadata-Version: 2.1
+Name: quickscale
+Version: 0.71.0
+Summary: Meta-package that installs quickscale-core and quickscale-cli together
+Home-page: https://github.com/Experto-AI/quickscale
+License: Apache-2.0
+Keywords: django,cli,scaffolding,project-generator
+Author: Experto AI
+Author-email: victor@experto.ai
+Requires-Python: >=3.10,<4.0
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: quickscale-cli (>=0.71.0,<0.72.0)
+Requires-Dist: quickscale-core (>=0.71.0,<0.72.0)
+Project-URL: Documentation, https://github.com/Experto-AI/quickscale/tree/main/docs
+Project-URL: Repository, https://github.com/Experto-AI/quickscale
+Description-Content-Type: text/markdown
+
+# 🚀 QuickScale
+
+<!--
+README.md - User-Focused Introduction
+
+PURPOSE: This file serves as the first contact point for users, developers, and evaluators visiting the QuickScale project.
+
+CONTENT GUIDELINES:
+- Keep content user-facing and accessible to newcomers
+- Focus on "what" and "how to get started" rather than "why" or technical details
+- Include quick examples and development workflows
+- Avoid deep architectural explanations (those belong in DECISIONS.md)
+- Avoid competitive analysis or strategic context (those belong in QUICKSCALE.md)
+- Maximum length: ~200 lines to ensure quick readability
+- Link to other documents for detailed information
+
+TARGET AUDIENCE: New users, potential adopters, GitHub visitors, developers evaluating QuickScale
+-->
+
+---
+
+## QuickScale: Compose your Django SaaS.
+
+QuickScale is a **composable Django framework** for building client SaaS applications. Start with a stable core, add reusable modules, customize themes, and deploy faster—while maintaining the flexibility to create commercial extensions and build a community ecosystem.
+
+---
+
+## What is QuickScale?
+
+QuickScale is a **Django project generator** that creates production-ready SaaS applications with one command. Designed for **solo developers and development agencies**, it gives you:
+
+- **Production-ready foundations**: Docker, PostgreSQL, testing, CI/CD, and security out-of-the-box
+- **One-command deployment**: Deploy to Railway with `quickscale deploy railway`
+- **Full ownership**: Generated projects are 100% yours to customize—no vendor lock-in
+- **Standardized stack**: Build multiple client projects faster with consistent best practices
+
+🧭 **Future Vision**: QuickScale will evolve to support reusable modules and themes. Today it's a personal toolkit; tomorrow it becomes a community platform when demand emerges. [Read the full evolution strategy](./docs/overview/quickscale.md#evolution-strategy-personal-toolkit-first).
+
+## Documentation Guide
+
+**Start here for your needs:**
+- 📖 **New user?** You're in the right place. This README shows you what QuickScale is and how to get started.
+- 🔧 **Need commands?** See [user_manual.md](./docs/technical/user_manual.md) for all commands and workflows
+- 🚀 **Deploying to Railway?** See [railway.md](./docs/deployment/railway.md) for Railway deployment guide
+- 📋 **Planning a feature?** Check [decisions.md](./docs/technical/decisions.md) for the authoritative MVP scope and technical rules
+- 🗓️ **Timeline & tasks?** See [roadmap.md](./docs/technical/roadmap.md)
+- 🏗️ **Project structure?** See [scaffolding.md](./docs/technical/scaffolding.md) for complete directory layouts
+- 🎯 **Why QuickScale?** See [quickscale.md](./docs/overview/quickscale.md) for competitive positioning
+
+**Quick Reference:**
+- **MVP** = Phase 1 (Personal Toolkit)
+- **Post-MVP** = Phase 2+ (Modules & Themes)
+- **Generated Project** = Output of `quickscale init`
+
+See [decisions.md - Glossary section](./docs/technical/decisions.md#document-responsibilities-short) for complete terminology and Single Source of Truth reference
+
+
+### Primary Use Cases (MVP):
+- **Solo Developer**: Build client projects faster with production-ready foundations
+- **Development Agency**: Standardize your tech stack across client engagements
+
+### Future Use Cases (Post-MVP):
+- **Commercial Extension Developer**: Create and sell premium modules/themes
+- **Open Source Contributor**: Extend the ecosystem with modules and themes
+
+### Development Flow (MVP)
+1. `quickscale init myapp`
+  - Generates the minimal Django starter described in the MVP Feature Matrix
+  - Ships with standalone `settings.py` by default; there is NO automatic settings inheritance. Advanced users who manually embed `quickscale_core` via git subtree may opt-in to inherit from `quickscale_core.settings` (see [decisions.md](./docs/technical/decisions.md#mvp-feature-matrix-authoritative)).
+  - **Optional**: Embed `quickscale_core` via git subtree after generation; follow the [Personal Toolkit workflow](./docs/technical/decisions.md#integration-note-personal-toolkit-git-subtree) for canonical commands and helper roadmap
+2. Add your custom Django apps and features
+3. Adopt optional inheritance or module extraction patterns only when you embed the core; the rules and best practices stay centralized in `DECISIONS.md`
+4. Build your unique client application
+5. Deploy to Railway with `quickscale deploy railway` (or use standard Django deployment)
+
+ℹ️ QuickScale's MVP centers on the personal toolkit workflow. Extraction patterns, module packaging, and subtree helper command plans stay documented in `docs/technical/decisions.md` so this README can stay concise.
+
+🔎 **Scope note**: The [MVP Feature Matrix](./docs/technical/decisions.md#mvp-feature-matrix-authoritative) is the single source of truth for what's in or out.
+
+### What You Get
+
+Running `quickscale init myapp` generates a **production-ready Django project** with:
+
+- ✅ **Docker** setup (development + production)
+- ✅ **PostgreSQL** configuration
+- ✅ **Environment-based** settings (dev/prod split)
+- ✅ **Security** best practices (SECRET_KEY, ALLOWED_HOSTS, etc.)
+- ✅ **Testing** infrastructure (pytest + factory_boy)
+- ✅ **CI/CD** pipeline (GitHub Actions)
+- ✅ **Code quality** hooks (ruff format + ruff check)
+- ✅ **Poetry** for dependency management
+- ✅ **One-Command Deployment**: Deploy to Railway with `quickscale deploy railway` - fully automated setup
+
+**See the complete project structure:** [scaffolding.md - Generated Project Output](./docs/technical/scaffolding.md#5-generated-project-output)
+
+The generated project is **yours to own and modify** - no vendor lock-in, just Django best practices.
+
+## Why QuickScale vs. Alternatives?
+
+✅ **Faster than Cookiecutter** - One command vs. 30+ interactive prompts
+✅ **More flexible than SaaS Pegasus** - Open source with full code ownership ($0 vs. $349+)
+✅ **Simpler than building from scratch** - Production-ready in 5 minutes vs. days of setup
+✅ **Railway deployment automation** - Competitors require manual platform configuration
+
+**QuickScale is a development accelerator**, not a complete solution. You start with production-ready foundations and build your unique client application on top.
+
+See [competitive_analysis.md](./docs/overview/competitive_analysis.md) for detailed comparison with SaaS Pegasus and Cookiecutter.
+
+---
+
+
+## Quick Start
+
+### Option A: Interactive Plan/Apply Workflow (Recommended)
+
+```bash
+# Install QuickScale globally
+./scripts/install_global.sh
+
+# Create a configuration interactively
+quickscale plan myapp
+# → Select theme, modules, Docker options
+# → Generates quickscale.yml
+
+# Execute the configuration
+quickscale apply quickscale.yml
+cd myapp
+```
+
+### Option B: Direct Init (Legacy)
+
+```bash
+# Install QuickScale globally
+./scripts/install_global.sh
+
+# Create your first project directly
+quickscale init myapp
+cd myapp
+
+# Or choose a specific theme (v0.61.0+)
+# quickscale init myapp --theme showcase_html # Default Showcase HTML theme
+# quickscale init myapp --theme showcase_htmx  # HTMX theme (coming in v0.70.0)
+# quickscale init myapp --theme showcase_react # React theme (coming in v0.71.0)
+```
+
+> **Note**: The `init` and `embed` commands are deprecated and will be removed in v0.70.0. Use `plan` + `apply` instead.
+
+**Choose your development workflow:**
+
+### Option 1: Docker (Recommended for production parity)
+
+```bash
+# Start all services (web + database)
+quickscale up
+
+# Run migrations
+quickscale manage migrate
+
+# Create superuser
+quickscale manage createsuperuser
+
+# View logs
+quickscale logs -f web
+
+# Open a shell in the container
+quickscale shell
+
+# Stop services
+quickscale down
+```
+
+**Visit http://localhost:8000** - Your app is running in Docker with PostgreSQL!
+
+### Option 2: Native Poetry (Simpler for quick testing)
+
+```bash
+# Install dependencies
+poetry install
+
+# Run migrations
+poetry run python manage.py migrate
+
+# Start development server
+poetry run python manage.py runserver
+```
+
+**Visit http://localhost:8000** - Your app is running natively!
+
+**For complete command reference and workflows**, see the [user_manual.md](./docs/technical/user_manual.md).
+
+## Learn More
+
+- **[decisions.md](./docs/technical/decisions.md)** - Technical specifications and implementation rules
+- **[quickscale.md](./docs/overview/quickscale.md)** - Strategic vision and competitive positioning
+- **[competitive_analysis.md](./docs/overview/competitive_analysis.md)** - Comparison vs SaaS Pegasus and alternatives
+- **[roadmap.md](./docs/technical/roadmap.md)** - Development roadmap and implementation plan
+- **[user_manual.md](./docs/technical/user_manual.md)** - Commands and workflows
+- **[contributing.md](./docs/contrib/contributing.md)** - Development workflow and coding standards
+

quickscale-0.71.0/README.md

@@ -0,0 +1,198 @@
+# 🚀 QuickScale
+
+<!--
+README.md - User-Focused Introduction
+
+PURPOSE: This file serves as the first contact point for users, developers, and evaluators visiting the QuickScale project.
+
+CONTENT GUIDELINES:
+- Keep content user-facing and accessible to newcomers
+- Focus on "what" and "how to get started" rather than "why" or technical details
+- Include quick examples and development workflows
+- Avoid deep architectural explanations (those belong in DECISIONS.md)
+- Avoid competitive analysis or strategic context (those belong in QUICKSCALE.md)
+- Maximum length: ~200 lines to ensure quick readability
+- Link to other documents for detailed information
+
+TARGET AUDIENCE: New users, potential adopters, GitHub visitors, developers evaluating QuickScale
+-->
+
+---
+
+## QuickScale: Compose your Django SaaS.
+
+QuickScale is a **composable Django framework** for building client SaaS applications. Start with a stable core, add reusable modules, customize themes, and deploy faster—while maintaining the flexibility to create commercial extensions and build a community ecosystem.
+
+---
+
+## What is QuickScale?
+
+QuickScale is a **Django project generator** that creates production-ready SaaS applications with one command. Designed for **solo developers and development agencies**, it gives you:
+
+- **Production-ready foundations**: Docker, PostgreSQL, testing, CI/CD, and security out-of-the-box
+- **One-command deployment**: Deploy to Railway with `quickscale deploy railway`
+- **Full ownership**: Generated projects are 100% yours to customize—no vendor lock-in
+- **Standardized stack**: Build multiple client projects faster with consistent best practices
+
+🧭 **Future Vision**: QuickScale will evolve to support reusable modules and themes. Today it's a personal toolkit; tomorrow it becomes a community platform when demand emerges. [Read the full evolution strategy](./docs/overview/quickscale.md#evolution-strategy-personal-toolkit-first).
+
+## Documentation Guide
+
+**Start here for your needs:**
+- 📖 **New user?** You're in the right place. This README shows you what QuickScale is and how to get started.
+- 🔧 **Need commands?** See [user_manual.md](./docs/technical/user_manual.md) for all commands and workflows
+- 🚀 **Deploying to Railway?** See [railway.md](./docs/deployment/railway.md) for Railway deployment guide
+- 📋 **Planning a feature?** Check [decisions.md](./docs/technical/decisions.md) for the authoritative MVP scope and technical rules
+- 🗓️ **Timeline & tasks?** See [roadmap.md](./docs/technical/roadmap.md)
+- 🏗️ **Project structure?** See [scaffolding.md](./docs/technical/scaffolding.md) for complete directory layouts
+- 🎯 **Why QuickScale?** See [quickscale.md](./docs/overview/quickscale.md) for competitive positioning
+
+**Quick Reference:**
+- **MVP** = Phase 1 (Personal Toolkit)
+- **Post-MVP** = Phase 2+ (Modules & Themes)
+- **Generated Project** = Output of `quickscale init`
+
+See [decisions.md - Glossary section](./docs/technical/decisions.md#document-responsibilities-short) for complete terminology and Single Source of Truth reference
+
+
+### Primary Use Cases (MVP):
+- **Solo Developer**: Build client projects faster with production-ready foundations
+- **Development Agency**: Standardize your tech stack across client engagements
+
+### Future Use Cases (Post-MVP):
+- **Commercial Extension Developer**: Create and sell premium modules/themes
+- **Open Source Contributor**: Extend the ecosystem with modules and themes
+
+### Development Flow (MVP)
+1. `quickscale init myapp`
+  - Generates the minimal Django starter described in the MVP Feature Matrix
+  - Ships with standalone `settings.py` by default; there is NO automatic settings inheritance. Advanced users who manually embed `quickscale_core` via git subtree may opt-in to inherit from `quickscale_core.settings` (see [decisions.md](./docs/technical/decisions.md#mvp-feature-matrix-authoritative)).
+  - **Optional**: Embed `quickscale_core` via git subtree after generation; follow the [Personal Toolkit workflow](./docs/technical/decisions.md#integration-note-personal-toolkit-git-subtree) for canonical commands and helper roadmap
+2. Add your custom Django apps and features
+3. Adopt optional inheritance or module extraction patterns only when you embed the core; the rules and best practices stay centralized in `DECISIONS.md`
+4. Build your unique client application
+5. Deploy to Railway with `quickscale deploy railway` (or use standard Django deployment)
+
+ℹ️ QuickScale's MVP centers on the personal toolkit workflow. Extraction patterns, module packaging, and subtree helper command plans stay documented in `docs/technical/decisions.md` so this README can stay concise.
+
+🔎 **Scope note**: The [MVP Feature Matrix](./docs/technical/decisions.md#mvp-feature-matrix-authoritative) is the single source of truth for what's in or out.
+
+### What You Get
+
+Running `quickscale init myapp` generates a **production-ready Django project** with:
+
+- ✅ **Docker** setup (development + production)
+- ✅ **PostgreSQL** configuration
+- ✅ **Environment-based** settings (dev/prod split)
+- ✅ **Security** best practices (SECRET_KEY, ALLOWED_HOSTS, etc.)
+- ✅ **Testing** infrastructure (pytest + factory_boy)
+- ✅ **CI/CD** pipeline (GitHub Actions)
+- ✅ **Code quality** hooks (ruff format + ruff check)
+- ✅ **Poetry** for dependency management
+- ✅ **One-Command Deployment**: Deploy to Railway with `quickscale deploy railway` - fully automated setup
+
+**See the complete project structure:** [scaffolding.md - Generated Project Output](./docs/technical/scaffolding.md#5-generated-project-output)
+
+The generated project is **yours to own and modify** - no vendor lock-in, just Django best practices.
+
+## Why QuickScale vs. Alternatives?
+
+✅ **Faster than Cookiecutter** - One command vs. 30+ interactive prompts
+✅ **More flexible than SaaS Pegasus** - Open source with full code ownership ($0 vs. $349+)
+✅ **Simpler than building from scratch** - Production-ready in 5 minutes vs. days of setup
+✅ **Railway deployment automation** - Competitors require manual platform configuration
+
+**QuickScale is a development accelerator**, not a complete solution. You start with production-ready foundations and build your unique client application on top.
+
+See [competitive_analysis.md](./docs/overview/competitive_analysis.md) for detailed comparison with SaaS Pegasus and Cookiecutter.
+
+---
+
+
+## Quick Start
+
+### Option A: Interactive Plan/Apply Workflow (Recommended)
+
+```bash
+# Install QuickScale globally
+./scripts/install_global.sh
+
+# Create a configuration interactively
+quickscale plan myapp
+# → Select theme, modules, Docker options
+# → Generates quickscale.yml
+
+# Execute the configuration
+quickscale apply quickscale.yml
+cd myapp
+```
+
+### Option B: Direct Init (Legacy)
+
+```bash
+# Install QuickScale globally
+./scripts/install_global.sh
+
+# Create your first project directly
+quickscale init myapp
+cd myapp
+
+# Or choose a specific theme (v0.61.0+)
+# quickscale init myapp --theme showcase_html # Default Showcase HTML theme
+# quickscale init myapp --theme showcase_htmx  # HTMX theme (coming in v0.70.0)
+# quickscale init myapp --theme showcase_react # React theme (coming in v0.71.0)
+```
+
+> **Note**: The `init` and `embed` commands are deprecated and will be removed in v0.70.0. Use `plan` + `apply` instead.
+
+**Choose your development workflow:**
+
+### Option 1: Docker (Recommended for production parity)
+
+```bash
+# Start all services (web + database)
+quickscale up
+
+# Run migrations
+quickscale manage migrate
+
+# Create superuser
+quickscale manage createsuperuser
+
+# View logs
+quickscale logs -f web
+
+# Open a shell in the container
+quickscale shell
+
+# Stop services
+quickscale down
+```
+
+**Visit http://localhost:8000** - Your app is running in Docker with PostgreSQL!
+
+### Option 2: Native Poetry (Simpler for quick testing)
+
+```bash
+# Install dependencies
+poetry install
+
+# Run migrations
+poetry run python manage.py migrate
+
+# Start development server
+poetry run python manage.py runserver
+```
+
+**Visit http://localhost:8000** - Your app is running natively!
+
+**For complete command reference and workflows**, see the [user_manual.md](./docs/technical/user_manual.md).
+
+## Learn More
+
+- **[decisions.md](./docs/technical/decisions.md)** - Technical specifications and implementation rules
+- **[quickscale.md](./docs/overview/quickscale.md)** - Strategic vision and competitive positioning
+- **[competitive_analysis.md](./docs/overview/competitive_analysis.md)** - Comparison vs SaaS Pegasus and alternatives
+- **[roadmap.md](./docs/technical/roadmap.md)** - Development roadmap and implementation plan
+- **[user_manual.md](./docs/technical/user_manual.md)** - Commands and workflows
+- **[contributing.md](./docs/contrib/contributing.md)** - Development workflow and coding standards

quickscale-0.71.0/pyproject.toml

@@ -0,0 +1,20 @@
+[tool.poetry]
+name = "quickscale"
+version = "0.71.0"
+description = "Meta-package that installs quickscale-core and quickscale-cli together"
+authors = ["Experto AI <victor@experto.ai>"]
+license = "Apache-2.0"
+homepage = "https://github.com/Experto-AI/quickscale"
+repository = "https://github.com/Experto-AI/quickscale"
+documentation = "https://github.com/Experto-AI/quickscale/tree/main/docs"
+keywords = ["django", "cli", "scaffolding", "project-generator"]
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.10"
+quickscale-core = "^0.71.0"
+quickscale-cli = "^0.71.0"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

quickscale-0.71.0/src/quickscale/__init__.py

@@ -0,0 +1,8 @@
+"""
+QuickScale meta package
+
+This package is intentionally empty; it only exists to group the quickscale-core
+and quickscale-cli packages so a single install pulls both.
+"""
+
+__all__ = []