quickscale-cli 0.73.0__tar.gz → 0.75.0__tar.gz

{quickscale_cli-0.73.0 → quickscale_cli-0.75.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: quickscale-cli
-Version: 0.73.0
+Version: 0.75.0
 Summary: Command-line interface for QuickScale Django project generator
 License: Apache-2.0
 Keywords: django,cli,project-generator,saas
@@ -17,7 +17,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Requires-Dist: click (>=8.3.1,<9.0.0)
-Requires-Dist: quickscale-core (>=0.73.0,<0.74.0)
+Requires-Dist: quickscale-core (>=0.75.0,<0.76.0)
 Project-URL: Documentation, https://github.com/Experto-AI/quickscale/tree/main/docs
 Project-URL: Homepage, https://github.com/Experto-AI/quickscale
 Project-URL: Repository, https://github.com/Experto-AI/quickscale
@@ -25,6 +25,14 @@ Description-Content-Type: text/markdown
 
 # 🚀 QuickScale
 
+[![PyPI version](https://img.shields.io/pypi/v/quickscale.svg)](https://pypi.org/project/quickscale/)
+[![CI](https://github.com/Experto-AI/quickscale/actions/workflows/ci.yml/badge.svg)](https://github.com/Experto-AI/quickscale/actions/workflows/ci.yml)
+[![Coverage](https://img.shields.io/badge/coverage-90%25-green.svg)](https://github.com/Experto-AI/quickscale/actions/workflows/ci.yml)
+[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![GitHub release (latest by date)](https://img.shields.io/github/v/release/Experto-AI/quickscale?color=green)](https://github.com/Experto-AI/quickscale/releases)
+[![Code style: Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
 > **You are here**: **QuickScale README** (Project Overview)
 > **Related docs**: [Start Here](START_HERE.md) | [Glossary](GLOSSARY.md) | [Decisions](docs/technical/decisions.md) | [User Manual](docs/technical/user_manual.md)
 
@@ -93,10 +101,15 @@ See [decisions.md - Glossary section](./docs/technical/decisions.md#document-res
 
 ### Development Flow
 1. `quickscale plan myapp` → Interactive configuration wizard
-2. `quickscale apply` → Generates production-ready Django project
-3. Add your custom Django apps and features
-4. Build your unique client application
-5. Deploy to Railway with `quickscale deploy railway` (or use standard Django deployment)
+2. `cd myapp` → Navigate to your project directory
+3. `quickscale apply` → Generates production-ready Django project
+4. Add your custom Django apps and features
+5. Build your unique client application
+6. Deploy to Railway with `quickscale deploy railway` (or use standard Django deployment)
+
+`quickscale.yml` now uses explicit identity fields:
+- `project.slug`: filesystem/service slug (for directory names)
+- `project.package`: Python package/import name (for Django module paths)
 
 ℹ️ The [MVP Feature Matrix](./docs/technical/decisions.md#mvp-feature-matrix-authoritative) is the single source of truth for what's in or out.
 
@@ -104,6 +117,7 @@ See [decisions.md - Glossary section](./docs/technical/decisions.md#document-res
 
 Running `quickscale plan myapp && quickscale apply` generates a **production-ready Django project** with:
 
+- ✅ **React + shadcn/ui** frontend (TypeScript, Vite, Tailwind CSS) — **NEW in v0.74.0**
 - ✅ **Docker** setup (development + production)
 - ✅ **PostgreSQL** configuration
 - ✅ **Environment-based** settings (dev/prod split)
@@ -115,6 +129,8 @@ Running `quickscale plan myapp && quickscale apply` generates a **production-rea
 - ✅ **Poetry** for dependency management
 - ✅ **One-Command Deployment**: Deploy to Railway with `quickscale deploy railway` - fully automated setup
 
+**Alternative**: Use `quickscale plan myapp --theme showcase_html` for pure HTML/CSS (simpler projects).
+
 **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.
@@ -132,8 +148,148 @@ See [competitive_analysis.md](./docs/overview/competitive_analysis.md) for detai
 
 ---
 
+## Installation
+
+QuickScale can be installed in two ways:
+
+### Method 1: Install from PyPI (Recommended)
+
+**Quick install:**
+```bash
+pip install quickscale
+```
+
+**Or with Poetry:**
+```bash
+poetry add quickscale
+```
+
+**Then use directly:**
+```bash
+quickscale plan myapp
+cd myapp
+quickscale apply
+```
 
-## Quick Start
+### Method 2: Install from Source
+
+**For those who prefer building from source:**
+```bash
+git clone https://github.com/Experto-AI/quickscale.git
+cd quickscale
+./scripts/install_global.sh
+```
+
+**Then use directly:**
+```bash
+quickscale plan myapp
+cd myapp
+quickscale apply
+```
+
+**Both methods use the same command syntax:** `quickscale plan`, `quickscale apply`, etc.
+
+---
+
+### For Contributors
+
+If you want to contribute to QuickScale development, see the [Development Guide](./docs/technical/development.md) for setup instructions.
+
+---
+
+## 🚀 5-Minute Quickstart
+
+**Want to see QuickScale in action right now?** Here's the fastest path to a working Django SaaS:
+
+```bash
+# 1. Install QuickScale
+./scripts/install_global.sh
+
+# 2. Create your project configuration
+quickscale plan myapp
+# → Accept defaults: theme (showcase_react), no modules, Docker enabled
+
+# 3. Generate and enter the project
+cd myapp
+quickscale apply
+# → Docker services auto-start! (default: docker.start=true)
+
+# 4. Setup and verify
+quickscale manage migrate
+quickscale manage createsuperuser
+quickscale ps  # Check services are running
+
+# 5. Open http://localhost:8000
+```
+
+**That's it!** 🎉 You now have a production-ready Django SaaS running with Docker + PostgreSQL.
+
+**Note**: Services started automatically during `quickscale apply`. No need to run `quickscale up` manually!
+
+**Prefer native Python?** After step 3, run:
+```bash
+poetry install
+poetry run python manage.py migrate
+poetry run python manage.py runserver
+# Open http://localhost:8000
+```
+
+---
+
+## Understanding Docker Auto-Start
+
+**When does `quickscale apply` start Docker automatically?**
+
+✅ **Services auto-start** (no `quickscale up` needed):
+- First-time project generation
+- When `docker.start: true` in quickscale.yml (**default**)
+- When `--no-docker` flag is NOT used
+
+❌ **Manual start required** (`quickscale up` needed):
+- You set `docker.start: false` during `quickscale plan` wizard
+- After stopping services with `quickscale down`
+- When running `quickscale apply --no-docker`
+- Adding modules to existing project (incremental apply)
+
+**Example - No manual start needed:**
+```bash
+quickscale plan myapp  # Accept defaults (docker.start: true)
+cd myapp
+quickscale apply       # ← Docker services auto-start!
+
+# Already running - just check status:
+quickscale ps
+curl http://localhost:8000  # ✅ Works immediately
+```
+
+**Example - Manual start needed:**
+```bash
+quickscale plan myapp
+# During wizard, set: "Docker start? [Y/n]: n"
+cd myapp
+quickscale apply       # Services do NOT start
+
+# Must start manually:
+quickscale up
+```
+
+**Docker configuration options** in quickscale.yml:
+
+```yaml
+docker:
+  start: true   # Auto-start services during apply?
+  build: true   # Rebuild images? (slower but ensures latest)
+```
+
+- `start: true` + `build: true` → Full rebuild + start (slowest, most reliable)
+- `start: true` + `build: false` → Start with cached images (faster)
+- `start: false` → Manual control with `quickscale up`
+
+**Need more details?** See [Docker Workflows Guide](./docs/technical/docker_workflows.md) for comprehensive scenarios and troubleshooting.
+
+---
+
+## Full Documentation & Setup
 
 ```bash
 # Install QuickScale globally
@@ -142,11 +298,11 @@ See [competitive_analysis.md](./docs/overview/competitive_analysis.md) for detai
 # Create a configuration interactively
 quickscale plan myapp
 # → Select theme, modules, Docker options
-# → Generates quickscale.yml
+# → Generates quickscale.yml in myapp/ directory
 
-# Execute the configuration
-quickscale apply
+# Navigate to project and execute the configuration
 cd myapp
+quickscale apply
 ```
 
 **Choose your development workflow:**
@@ -154,7 +310,7 @@ cd myapp
 ### Option 1: Docker (Recommended for production parity)
 
 ```bash
-# Start all services (web + database)
+# Start all services (backend + database)
 quickscale up
 
 # Run migrations
@@ -164,7 +320,7 @@ quickscale manage migrate
 quickscale manage createsuperuser
 
 # View logs
-quickscale logs -f web
+quickscale logs -f backend
 
 # Open a shell in the container
 quickscale shell

{quickscale_cli-0.73.0 → quickscale_cli-0.75.0}/README.md

@@ -1,5 +1,13 @@
 # 🚀 QuickScale
 
+[![PyPI version](https://img.shields.io/pypi/v/quickscale.svg)](https://pypi.org/project/quickscale/)
+[![CI](https://github.com/Experto-AI/quickscale/actions/workflows/ci.yml/badge.svg)](https://github.com/Experto-AI/quickscale/actions/workflows/ci.yml)
+[![Coverage](https://img.shields.io/badge/coverage-90%25-green.svg)](https://github.com/Experto-AI/quickscale/actions/workflows/ci.yml)
+[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![GitHub release (latest by date)](https://img.shields.io/github/v/release/Experto-AI/quickscale?color=green)](https://github.com/Experto-AI/quickscale/releases)
+[![Code style: Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
 > **You are here**: **QuickScale README** (Project Overview)
 > **Related docs**: [Start Here](START_HERE.md) | [Glossary](GLOSSARY.md) | [Decisions](docs/technical/decisions.md) | [User Manual](docs/technical/user_manual.md)
 
@@ -68,10 +76,15 @@ See [decisions.md - Glossary section](./docs/technical/decisions.md#document-res
 
 ### Development Flow
 1. `quickscale plan myapp` → Interactive configuration wizard
-2. `quickscale apply` → Generates production-ready Django project
-3. Add your custom Django apps and features
-4. Build your unique client application
-5. Deploy to Railway with `quickscale deploy railway` (or use standard Django deployment)
+2. `cd myapp` → Navigate to your project directory
+3. `quickscale apply` → Generates production-ready Django project
+4. Add your custom Django apps and features
+5. Build your unique client application
+6. Deploy to Railway with `quickscale deploy railway` (or use standard Django deployment)
+
+`quickscale.yml` now uses explicit identity fields:
+- `project.slug`: filesystem/service slug (for directory names)
+- `project.package`: Python package/import name (for Django module paths)
 
 ℹ️ The [MVP Feature Matrix](./docs/technical/decisions.md#mvp-feature-matrix-authoritative) is the single source of truth for what's in or out.
 
@@ -79,6 +92,7 @@ See [decisions.md - Glossary section](./docs/technical/decisions.md#document-res
 
 Running `quickscale plan myapp && quickscale apply` generates a **production-ready Django project** with:
 
+- ✅ **React + shadcn/ui** frontend (TypeScript, Vite, Tailwind CSS) — **NEW in v0.74.0**
 - ✅ **Docker** setup (development + production)
 - ✅ **PostgreSQL** configuration
 - ✅ **Environment-based** settings (dev/prod split)
@@ -90,6 +104,8 @@ Running `quickscale plan myapp && quickscale apply` generates a **production-rea
 - ✅ **Poetry** for dependency management
 - ✅ **One-Command Deployment**: Deploy to Railway with `quickscale deploy railway` - fully automated setup
 
+**Alternative**: Use `quickscale plan myapp --theme showcase_html` for pure HTML/CSS (simpler projects).
+
 **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.
@@ -107,8 +123,148 @@ See [competitive_analysis.md](./docs/overview/competitive_analysis.md) for detai
 
 ---
 
+## Installation
+
+QuickScale can be installed in two ways:
+
+### Method 1: Install from PyPI (Recommended)
+
+**Quick install:**
+```bash
+pip install quickscale
+```
+
+**Or with Poetry:**
+```bash
+poetry add quickscale
+```
+
+**Then use directly:**
+```bash
+quickscale plan myapp
+cd myapp
+quickscale apply
+```
 
-## Quick Start
+### Method 2: Install from Source
+
+**For those who prefer building from source:**
+```bash
+git clone https://github.com/Experto-AI/quickscale.git
+cd quickscale
+./scripts/install_global.sh
+```
+
+**Then use directly:**
+```bash
+quickscale plan myapp
+cd myapp
+quickscale apply
+```
+
+**Both methods use the same command syntax:** `quickscale plan`, `quickscale apply`, etc.
+
+---
+
+### For Contributors
+
+If you want to contribute to QuickScale development, see the [Development Guide](./docs/technical/development.md) for setup instructions.
+
+---
+
+## 🚀 5-Minute Quickstart
+
+**Want to see QuickScale in action right now?** Here's the fastest path to a working Django SaaS:
+
+```bash
+# 1. Install QuickScale
+./scripts/install_global.sh
+
+# 2. Create your project configuration
+quickscale plan myapp
+# → Accept defaults: theme (showcase_react), no modules, Docker enabled
+
+# 3. Generate and enter the project
+cd myapp
+quickscale apply
+# → Docker services auto-start! (default: docker.start=true)
+
+# 4. Setup and verify
+quickscale manage migrate
+quickscale manage createsuperuser
+quickscale ps  # Check services are running
+
+# 5. Open http://localhost:8000
+```
+
+**That's it!** 🎉 You now have a production-ready Django SaaS running with Docker + PostgreSQL.
+
+**Note**: Services started automatically during `quickscale apply`. No need to run `quickscale up` manually!
+
+**Prefer native Python?** After step 3, run:
+```bash
+poetry install
+poetry run python manage.py migrate
+poetry run python manage.py runserver
+# Open http://localhost:8000
+```
+
+---
+
+## Understanding Docker Auto-Start
+
+**When does `quickscale apply` start Docker automatically?**
+
+✅ **Services auto-start** (no `quickscale up` needed):
+- First-time project generation
+- When `docker.start: true` in quickscale.yml (**default**)
+- When `--no-docker` flag is NOT used
+
+❌ **Manual start required** (`quickscale up` needed):
+- You set `docker.start: false` during `quickscale plan` wizard
+- After stopping services with `quickscale down`
+- When running `quickscale apply --no-docker`
+- Adding modules to existing project (incremental apply)
+
+**Example - No manual start needed:**
+```bash
+quickscale plan myapp  # Accept defaults (docker.start: true)
+cd myapp
+quickscale apply       # ← Docker services auto-start!
+
+# Already running - just check status:
+quickscale ps
+curl http://localhost:8000  # ✅ Works immediately
+```
+
+**Example - Manual start needed:**
+```bash
+quickscale plan myapp
+# During wizard, set: "Docker start? [Y/n]: n"
+cd myapp
+quickscale apply       # Services do NOT start
+
+# Must start manually:
+quickscale up
+```
+
+**Docker configuration options** in quickscale.yml:
+
+```yaml
+docker:
+  start: true   # Auto-start services during apply?
+  build: true   # Rebuild images? (slower but ensures latest)
+```
+
+- `start: true` + `build: true` → Full rebuild + start (slowest, most reliable)
+- `start: true` + `build: false` → Start with cached images (faster)
+- `start: false` → Manual control with `quickscale up`
+
+**Need more details?** See [Docker Workflows Guide](./docs/technical/docker_workflows.md) for comprehensive scenarios and troubleshooting.
+
+---
+
+## Full Documentation & Setup
 
 ```bash
 # Install QuickScale globally
@@ -117,11 +273,11 @@ See [competitive_analysis.md](./docs/overview/competitive_analysis.md) for detai
 # Create a configuration interactively
 quickscale plan myapp
 # → Select theme, modules, Docker options
-# → Generates quickscale.yml
+# → Generates quickscale.yml in myapp/ directory
 
-# Execute the configuration
-quickscale apply
+# Navigate to project and execute the configuration
 cd myapp
+quickscale apply
 ```
 
 **Choose your development workflow:**
@@ -129,7 +285,7 @@ cd myapp
 ### Option 1: Docker (Recommended for production parity)
 
 ```bash
-# Start all services (web + database)
+# Start all services (backend + database)
 quickscale up
 
 # Run migrations
@@ -139,7 +295,7 @@ quickscale manage migrate
 quickscale manage createsuperuser
 
 # View logs
-quickscale logs -f web
+quickscale logs -f backend
 
 # Open a shell in the container
 quickscale shell

{quickscale_cli-0.73.0 → quickscale_cli-0.75.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "quickscale-cli"
-version = "0.73.0"
+version = "0.75.0"
 description = "Command-line interface for QuickScale Django project generator"
 authors = ["Experto AI <victor@experto.ai>"]
 license = "Apache-2.0"
@@ -25,7 +25,7 @@ packages = [{include = "quickscale_cli", from = "src"}]
 [tool.poetry.dependencies]
 python = "^3.12"
 click = "^8.3.1"
-quickscale-core = "^0.73.0"
+quickscale-core = "^0.75.0"
 
 [tool.poetry.group.dev.dependencies]
 # Dev dependencies centralized in root pyproject.toml
@@ -49,6 +49,7 @@ addopts = [
     "--cov=quickscale_cli",
     "--cov-report=term-missing",
     "--cov-report=html",
+    "--cov-fail-under=90",
     "-m", "not e2e",  # Skip E2E tests by default (run with: pytest -m e2e)
 ]
 markers = [
@@ -57,6 +58,10 @@ markers = [
     "e2e: end-to-end tests",
 ]
 
+[tool.coverage.report]
+fail_under = 90
+# Per-file minimum target: 80% (enforced via code review)
+
 # Ruff and mypy configurations centralized in root ruff.toml and mypy.ini
 # Package-specific isort override
 [tool.ruff.lint.isort]

{quickscale_cli-0.73.0 → quickscale_cli-0.75.0}/src/quickscale_cli/_version.py

@@ -1,2 +1,2 @@
 # Auto-generated by scripts/version_tool.sh
-__version__ = "0.73.0"
+__version__ = "0.75.0"