quickscale-cli 0.57.2__tar.gz → 0.59.0__tar.gz

{quickscale_cli-0.57.2 → quickscale_cli-0.59.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: quickscale-cli
-Version: 0.57.2
+Version: 0.59.0
 Summary: Command-line interface for QuickScale Django project generator
 Home-page: https://github.com/Experto-AI/quickscale
 License: Apache-2.0
@@ -19,7 +19,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: click (>=8.1.0,<9.0.0)
-Requires-Dist: quickscale-core (>=0.57.2,<0.58.0)
+Requires-Dist: quickscale-core (>=0.59.0,<0.60.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
@@ -67,6 +67,7 @@ QuickScale is a **composable Django framework** designed for **solo developers a
 **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
@@ -149,6 +150,28 @@ poetry run python manage.py runserver
 
 **That's it!** Visit http://localhost:8000 to see your new Django project.
 
+### Development Workflow with Docker
+
+QuickScale includes convenient CLI commands for Docker-based development:
+
+```bash
+# Start all services (web + database)
+quickscale up
+
+# View logs
+quickscale logs -f web
+
+# Run Django commands
+quickscale manage migrate
+quickscale manage createsuperuser
+
+# Open a shell in the container
+quickscale shell
+
+# Stop services
+quickscale down
+```
+
 **For complete command reference and workflows**, see the [user_manual.md](./docs/technical/user_manual.md).
 
 ## Learn More

{quickscale_cli-0.57.2 → quickscale_cli-0.59.0}/README.md

@@ -41,6 +41,7 @@ QuickScale is a **composable Django framework** designed for **solo developers a
 **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
@@ -123,6 +124,28 @@ poetry run python manage.py runserver
 
 **That's it!** Visit http://localhost:8000 to see your new Django project.
 
+### Development Workflow with Docker
+
+QuickScale includes convenient CLI commands for Docker-based development:
+
+```bash
+# Start all services (web + database)
+quickscale up
+
+# View logs
+quickscale logs -f web
+
+# Run Django commands
+quickscale manage migrate
+quickscale manage createsuperuser
+
+# Open a shell in the container
+quickscale shell
+
+# Stop services
+quickscale down
+```
+
 **For complete command reference and workflows**, see the [user_manual.md](./docs/technical/user_manual.md).
 
 ## Learn More

{quickscale_cli-0.57.2 → quickscale_cli-0.59.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "quickscale-cli"
-version = "0.57.2"
+version = "0.59.0"
 description = "Command-line interface for QuickScale Django project generator"
 authors = ["Experto AI <victor@experto.ai>"]
 license = "Apache-2.0"
@@ -26,7 +26,7 @@ packages = [{include = "quickscale_cli", from = "src"}]
 [tool.poetry.dependencies]
 python = "^3.10"
 click = "^8.1.0"
-quickscale-core = "^0.57.2"
+quickscale-core = "^0.59.0"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^7.4.0"
@@ -52,6 +52,7 @@ addopts = [
     "--cov=quickscale_cli",
     "--cov-report=term-missing",
     "--cov-report=html",
+    "-m", "not e2e",  # Skip E2E tests by default (run with: pytest -m e2e)
 ]
 
 [tool.ruff]

{quickscale_cli-0.57.2 → quickscale_cli-0.59.0}/src/quickscale_cli/__init__.py

@@ -1,4 +1,5 @@
-"""QuickScale CLI package.
+"""
+QuickScale CLI package.
 
 Reads the canonical version from the repository-level `VERSION` file so the CLI
 stays in sync with other packages when the release is bumped in one place.
@@ -7,14 +8,13 @@ stays in sync with other packages when the release is bumped in one place.
 from __future__ import annotations
 
 from pathlib import Path
-from typing import Tuple
 
 __author__ = "Experto AI"
 __email__ = "victor@experto.ai"
 
 # Prefer an embedded package-level `_version.py` if it exists (build step).
 try:
-    from ._version import __version__  # type: ignore
+    from ._version import __version__
 except Exception:
     _root = Path(__file__).resolve().parents[3]
     _version_file = _root / "VERSION"
@@ -25,7 +25,7 @@ except Exception:
 
 # Version tuple for programmatic access
 parts = __version__.split("-")[0].split(".")
-VERSION: Tuple[int, int, int] = (
+VERSION: tuple[int, int, int] = (
     int(parts[0]) if len(parts) > 0 else 0,
     int(parts[1]) if len(parts) > 1 else 0,
     int(parts[2]) if len(parts) > 2 else 0,

{quickscale_cli-0.57.2 → quickscale_cli-0.59.0}/src/quickscale_cli/_version.py

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

quickscale_cli-0.59.0/src/quickscale_cli/commands/__init__.py

@@ -0,0 +1 @@
+"""CLI commands package for QuickScale."""

quickscale_cli-0.59.0/src/quickscale_cli/commands/development_commands.py

@@ -0,0 +1,237 @@
+"""Development lifecycle commands for QuickScale projects."""
+
+import subprocess
+import sys
+
+import click
+
+from quickscale_cli.utils.docker_utils import (
+    get_docker_compose_command,
+    is_docker_running,
+)
+from quickscale_cli.utils.project_manager import get_web_container_name, is_in_quickscale_project
+
+
+@click.command()
+@click.option("--build", is_flag=True, help="Rebuild containers before starting")
+@click.option("--no-cache", is_flag=True, help="Build without using cache")
+def up(build: bool, no_cache: bool) -> None:
+    """Start Docker services for development."""
+    # Check if in QuickScale project
+    if not is_in_quickscale_project():
+        click.secho("❌ Error: Not in a QuickScale project directory", fg="red", err=True)
+        click.echo(
+            "💡 Tip: Navigate to a project directory or run 'quickscale init <name>' to create one",
+            err=True,
+        )
+        sys.exit(1)
+
+    # Check if Docker is running
+    if not is_docker_running():
+        click.secho("❌ Error: Docker is not running", fg="red", err=True)
+        click.echo("💡 Tip: Start Docker Desktop or the Docker daemon", err=True)
+        sys.exit(1)
+
+    try:
+        compose_cmd = get_docker_compose_command()
+        cmd = compose_cmd + ["up", "-d"]
+
+        if build or no_cache:
+            cmd.append("--build")
+
+        if no_cache:
+            cmd.append("--no-cache")
+
+        click.echo("🚀 Starting Docker services...")
+        subprocess.run(cmd, check=True)
+        click.secho("✅ Services started successfully!", fg="green", bold=True)
+        click.echo("💡 Tip: Use 'quickscale logs' to view service logs")
+
+    except subprocess.CalledProcessError as e:
+        click.secho(
+            f"❌ Error: Failed to start services (exit code: {e.returncode})", fg="red", err=True
+        )
+        click.echo("💡 Tip: Check Docker logs with 'quickscale logs' for details", err=True)
+        sys.exit(1)
+    except KeyboardInterrupt:
+        click.echo("\n⚠️  Interrupted by user")
+        sys.exit(130)
+
+
+@click.command()
+@click.option("--volumes", is_flag=True, help="Remove volumes as well")
+def down(volumes: bool) -> None:
+    """Stop Docker services."""
+    if not is_in_quickscale_project():
+        click.secho("❌ Error: Not in a QuickScale project directory", fg="red", err=True)
+        click.echo("💡 Tip: Navigate to a project directory", err=True)
+        sys.exit(1)
+
+    if not is_docker_running():
+        click.secho("❌ Error: Docker is not running", fg="red", err=True)
+        click.echo("💡 Tip: Start Docker Desktop or the Docker daemon", err=True)
+        sys.exit(1)
+
+    try:
+        compose_cmd = get_docker_compose_command()
+        cmd = compose_cmd + ["down"]
+
+        if volumes:
+            cmd.append("--volumes")
+
+        click.echo("🛑 Stopping Docker services...")
+        subprocess.run(cmd, check=True)
+        click.secho("✅ Services stopped successfully!", fg="green")
+
+    except subprocess.CalledProcessError as e:
+        click.secho(
+            f"❌ Error: Failed to stop services (exit code: {e.returncode})", fg="red", err=True
+        )
+        sys.exit(1)
+    except KeyboardInterrupt:
+        click.echo("\n⚠️  Interrupted by user")
+        sys.exit(130)
+
+
+@click.command()
+@click.option("-c", "--command", "cmd", help="Run a single command instead of interactive shell")
+def shell(cmd: str | None) -> None:
+    """Open an interactive bash shell in the web container."""
+    if not is_in_quickscale_project():
+        click.secho("❌ Error: Not in a QuickScale project directory", fg="red", err=True)
+        click.echo("💡 Tip: Navigate to a project directory", err=True)
+        sys.exit(1)
+
+    if not is_docker_running():
+        click.secho("❌ Error: Docker is not running", fg="red", err=True)
+        click.echo("�� Tip: Start Docker Desktop or the Docker daemon", err=True)
+        sys.exit(1)
+
+    try:
+        container_name = get_web_container_name()
+
+        if cmd:
+            # Run single command
+            docker_cmd = ["docker", "exec", container_name, "bash", "-c", cmd]
+            subprocess.run(docker_cmd, check=True)
+        else:
+            # Interactive shell
+            docker_cmd = ["docker", "exec", "-it", container_name, "bash"]
+            subprocess.run(docker_cmd, check=True)
+
+    except subprocess.CalledProcessError as e:
+        if e.returncode == 1:
+            click.secho("❌ Error: Container not running", fg="red", err=True)
+            click.echo("💡 Tip: Start services with 'quickscale up' first", err=True)
+        else:
+            click.secho(f"❌ Error: Command failed (exit code: {e.returncode})", fg="red", err=True)
+        sys.exit(e.returncode)
+    except KeyboardInterrupt:
+        click.echo("\n⚠️  Exited shell")
+        sys.exit(0)
+
+
+@click.command(context_settings=dict(ignore_unknown_options=True))
+@click.argument("args", nargs=-1, type=click.UNPROCESSED)
+def manage(args: tuple) -> None:
+    """Run Django management commands in the web container."""
+    if not is_in_quickscale_project():
+        click.secho("❌ Error: Not in a QuickScale project directory", fg="red", err=True)
+        click.echo("💡 Tip: Navigate to a project directory", err=True)
+        sys.exit(1)
+
+    if not is_docker_running():
+        click.secho("❌ Error: Docker is not running", fg="red", err=True)
+        click.echo("💡 Tip: Start Docker Desktop or the Docker daemon", err=True)
+        sys.exit(1)
+
+    if not args:
+        click.secho("❌ Error: No Django management command specified", fg="red", err=True)
+        click.echo("💡 Tip: Run 'quickscale manage help' to see available commands", err=True)
+        sys.exit(1)
+
+    try:
+        container_name = get_web_container_name()
+        docker_cmd = ["docker", "exec", "-it", container_name, "python", "manage.py"] + list(args)
+        subprocess.run(docker_cmd, check=True)
+
+    except subprocess.CalledProcessError as e:
+        if e.returncode == 1:
+            click.secho("❌ Error: Container not running or command failed", fg="red", err=True)
+            click.echo("💡 Tip: Start services with 'quickscale up' first", err=True)
+        sys.exit(e.returncode)
+    except KeyboardInterrupt:
+        click.echo("\n⚠️  Interrupted by user")
+        sys.exit(130)
+
+
+@click.command()
+@click.argument("service", required=False)
+@click.option("-f", "--follow", is_flag=True, help="Follow log output")
+@click.option("--tail", default=None, help="Number of lines to show from the end of the logs")
+@click.option("--timestamps", is_flag=True, help="Show timestamps")
+def logs(service: str | None, follow: bool, tail: str | None, timestamps: bool) -> None:
+    """View Docker service logs."""
+    if not is_in_quickscale_project():
+        click.secho("❌ Error: Not in a QuickScale project directory", fg="red", err=True)
+        click.echo("💡 Tip: Navigate to a project directory", err=True)
+        sys.exit(1)
+
+    if not is_docker_running():
+        click.secho("❌ Error: Docker is not running", fg="red", err=True)
+        click.echo("�� Tip: Start Docker Desktop or the Docker daemon", err=True)
+        sys.exit(1)
+
+    try:
+        compose_cmd = get_docker_compose_command()
+        cmd = compose_cmd + ["logs"]
+
+        if follow:
+            cmd.append("--follow")
+
+        if tail:
+            cmd.extend(["--tail", tail])
+
+        if timestamps:
+            cmd.append("--timestamps")
+
+        if service:
+            cmd.append(service)
+
+        subprocess.run(cmd, check=True)
+
+    except subprocess.CalledProcessError as e:
+        click.secho(
+            f"❌ Error: Failed to retrieve logs (exit code: {e.returncode})", fg="red", err=True
+        )
+        sys.exit(1)
+    except KeyboardInterrupt:
+        click.echo("\n⚠️  Stopped following logs")
+        sys.exit(0)
+
+
+@click.command()
+def ps() -> None:
+    """Show service status."""
+    if not is_in_quickscale_project():
+        click.secho("❌ Error: Not in a QuickScale project directory", fg="red", err=True)
+        click.echo("💡 Tip: Navigate to a project directory", err=True)
+        sys.exit(1)
+
+    if not is_docker_running():
+        click.secho("❌ Error: Docker is not running", fg="red", err=True)
+        click.echo("💡 Tip: Start Docker Desktop or the Docker daemon", err=True)
+        sys.exit(1)
+
+    try:
+        compose_cmd = get_docker_compose_command()
+        cmd = compose_cmd + ["ps"]
+        subprocess.run(cmd, check=True)
+
+    except subprocess.CalledProcessError as e:
+        click.secho(
+            f"❌ Error: Failed to get service status (exit code: {e.returncode})",
+            fg="red",
+            err=True,
+        )
+        sys.exit(1)

{quickscale_cli-0.57.2 → quickscale_cli-0.59.0}/src/quickscale_cli/main.py

@@ -6,6 +6,7 @@ import click
 
 import quickscale_cli
 import quickscale_core
+from quickscale_cli.commands.development_commands import down, logs, manage, ps, shell, up
 from quickscale_core.generator import ProjectGenerator
 
 
@@ -23,6 +24,15 @@ def version() -> None:
     click.echo(f"QuickScale Core v{quickscale_core.__version__}")
 
 
+# Register development commands
+cli.add_command(up)
+cli.add_command(down)
+cli.add_command(shell)
+cli.add_command(manage)
+cli.add_command(logs)
+cli.add_command(ps)
+
+
 @cli.command()
 @click.argument("project_name")
 def init(project_name: str) -> None:

quickscale_cli-0.59.0/src/quickscale_cli/utils/__init__.py

@@ -0,0 +1 @@
+"""Utility functions package for QuickScale CLI."""

quickscale_cli-0.59.0/src/quickscale_cli/utils/docker_utils.py

@@ -0,0 +1,76 @@
+"""Docker interaction utilities for QuickScale CLI."""
+
+import subprocess
+from pathlib import Path
+
+
+def is_docker_running() -> bool:
+    """Check if Docker daemon is running."""
+    try:
+        subprocess.run(["docker", "info"], capture_output=True, check=True, timeout=5)
+        return True
+    except (subprocess.SubprocessError, FileNotFoundError, subprocess.TimeoutExpired):
+        return False
+
+
+def find_docker_compose() -> Path | None:
+    """Locate docker-compose.yml in current directory."""
+    compose_file = Path("docker-compose.yml")
+    return compose_file if compose_file.exists() else None
+
+
+def get_docker_compose_command() -> list[str]:
+    """Get the appropriate docker compose command."""
+    # Try docker-compose first, fall back to docker compose
+    try:
+        subprocess.run(["docker-compose", "--version"], capture_output=True, check=True, timeout=2)
+        return ["docker-compose"]
+    except (subprocess.SubprocessError, FileNotFoundError, subprocess.TimeoutExpired):
+        # Fall back to docker compose (newer Docker versions)
+        return ["docker", "compose"]
+
+
+def get_container_status(container_name: str) -> str | None:
+    """Get status of a specific container."""
+    try:
+        result = subprocess.run(
+            ["docker", "ps", "-a", "--filter", f"name={container_name}", "--format", "{{.Status}}"],
+            capture_output=True,
+            text=True,
+            check=True,
+            timeout=5,
+        )
+        return result.stdout.strip() or None
+    except (subprocess.SubprocessError, subprocess.TimeoutExpired):
+        return None
+
+
+def exec_in_container(container_name: str, command: list[str], interactive: bool = False) -> int:
+    """Execute command in a container."""
+    cmd = ["docker", "exec"]
+    if interactive:
+        cmd.append("-it")
+    cmd.append(container_name)
+    cmd.extend(command)
+
+    try:
+        result = subprocess.run(cmd)
+        return result.returncode
+    except subprocess.SubprocessError:
+        return 1
+
+
+def get_running_containers() -> list[str]:
+    """Get list of running QuickScale containers."""
+    try:
+        result = subprocess.run(
+            ["docker", "ps", "--format", "{{.Names}}"],
+            capture_output=True,
+            text=True,
+            check=True,
+            timeout=5,
+        )
+        containers = [c for c in result.stdout.strip().split("\n") if c]
+        return containers
+    except (subprocess.SubprocessError, subprocess.TimeoutExpired):
+        return []

quickscale_cli-0.59.0/src/quickscale_cli/utils/project_manager.py

@@ -0,0 +1,61 @@
+"""Project state detection and management utilities."""
+
+from pathlib import Path
+from typing import Any
+
+from .docker_utils import find_docker_compose, get_running_containers
+
+
+def get_project_state() -> dict[str, Any]:
+    """Get comprehensive project state including directory and containers."""
+    try:
+        current_dir = Path.cwd()
+    except OSError:
+        return {"has_project": False, "project_dir": None, "project_name": None, "containers": []}
+
+    compose_file = find_docker_compose()
+    has_project = compose_file is not None
+    containers = get_running_containers() if has_project else []
+
+    return {
+        "has_project": has_project,
+        "project_dir": current_dir if has_project else None,
+        "project_name": current_dir.name if has_project else None,
+        "containers": containers,
+        "compose_file": compose_file,
+    }
+
+
+def is_in_quickscale_project() -> bool:
+    """Check if current directory is a QuickScale project."""
+    return find_docker_compose() is not None
+
+
+def get_web_container_name() -> str:
+    """Get the name of the web container (dynamically detected)."""
+    project_name = Path.cwd().name
+    containers = get_running_containers()
+
+    # Try different naming patterns used by Docker Compose
+    # Examples: test59_web, test59-web-1, test59_web_1
+    for container in containers:
+        if project_name in container and "web" in container:
+            return container
+
+    # Fallback to common patterns if no running container found
+    return f"{project_name}-web-1"
+
+
+def get_db_container_name() -> str:
+    """Get the name of the database container (dynamically detected)."""
+    project_name = Path.cwd().name
+    containers = get_running_containers()
+
+    # Try different naming patterns used by Docker Compose
+    # Examples: test59_db, test59-db-1, test59_db_1
+    for container in containers:
+        if project_name in container and "db" in container:
+            return container
+
+    # Fallback to common patterns if no running container found
+    return f"{project_name}-db-1"