xgic-payload-cms-cli 0.2.1__tar.gz → 0.2.2__tar.gz

{xgic_payload_cms_cli-0.2.1 → xgic_payload_cms_cli-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: xgic-payload-cms-cli
-Version: 0.2.1
+Version: 0.2.2
 Summary: XGIC CLI Payload CMS module - product commands and helpers (xgic.cli.payload).
 Project-URL: Homepage, https://github.com/xgic/payload-cms-cli
 Project-URL: Repository, https://github.com/xgic/payload-cms-cli
@@ -90,7 +90,7 @@ One brand (`xgic`), clear ownership, and dry-run-friendly destructive paths.
 uv pip install \
   "xgic-cli>=0.2.0,<0.3" \
   "xgic-dev-cli>=0.2.0,<0.3" \
-  "xgic-payload-cms-cli>=0.2.1,<0.3"
+  "xgic-payload-cms-cli>=0.2.2,<0.3"
 xgic payload --help
 ```
 
@@ -105,14 +105,21 @@ xgic payload --help
 
 ### Typical Payload session (inside a Dev Container)
 
+**First session** (one setup command — creates `.devcontainer/.env` if missing, starts the DB profile, scaffolds the app):
+
 ```bash
-xgic check
-xgic payload env --regenerate --yes   # once
-xgic payload setup                    # scaffold app (layout from config)
-xgic up --profile postgres            # DB if needed
+xgic payload setup
 xgic payload dev
 ```
 
+**Daily** (after the app exists):
+
+```bash
+xgic payload dev
+```
+
+Optional: `xgic payload env` (status), `xgic payload env --regenerate --yes` (rotate credentials only — not required for first setup).
+
 Prefer the end-user template for application work: [payload-cms](https://github.com/xgic/payload-cms).
 
 ---
@@ -124,9 +131,9 @@ All product commands nest under **`xgic payload`**:
 | Command | Purpose |
 |---------|---------|
 | `xgic payload dev` | **Primary daily command** — smart start (up if needed, DB check, `pnpm dev`) |
-| `xgic payload setup [--quiet]` | Ensure Payload project directory (idempotent) |
+| `xgic payload setup [--quiet]` | **First-run one-shot:** env (if missing) + DB profile + scaffold (idempotent) |
 | `xgic payload env [--json]` | Product env status (project name, `.env`, services) |
-| `xgic payload env --regenerate --yes` | Fresh credentials in `.devcontainer/.env` |
+| `xgic payload env --regenerate --yes` | Rotate credentials in `.devcontainer/.env` (optional; setup creates env when absent) |
 | `xgic payload schema` | Run template schema generator when present |
 | `xgic payload reset` | Fast targeted reset (project folder + active DB volume) |
 

{xgic_payload_cms_cli-0.2.1 → xgic_payload_cms_cli-0.2.2}/README.md

@@ -55,7 +55,7 @@ One brand (`xgic`), clear ownership, and dry-run-friendly destructive paths.
 uv pip install \
   "xgic-cli>=0.2.0,<0.3" \
   "xgic-dev-cli>=0.2.0,<0.3" \
-  "xgic-payload-cms-cli>=0.2.1,<0.3"
+  "xgic-payload-cms-cli>=0.2.2,<0.3"
 xgic payload --help
 ```
 
@@ -70,14 +70,21 @@ xgic payload --help
 
 ### Typical Payload session (inside a Dev Container)
 
+**First session** (one setup command — creates `.devcontainer/.env` if missing, starts the DB profile, scaffolds the app):
+
 ```bash
-xgic check
-xgic payload env --regenerate --yes   # once
-xgic payload setup                    # scaffold app (layout from config)
-xgic up --profile postgres            # DB if needed
+xgic payload setup
 xgic payload dev
 ```
 
+**Daily** (after the app exists):
+
+```bash
+xgic payload dev
+```
+
+Optional: `xgic payload env` (status), `xgic payload env --regenerate --yes` (rotate credentials only — not required for first setup).
+
 Prefer the end-user template for application work: [payload-cms](https://github.com/xgic/payload-cms).
 
 ---
@@ -89,9 +96,9 @@ All product commands nest under **`xgic payload`**:
 | Command | Purpose |
 |---------|---------|
 | `xgic payload dev` | **Primary daily command** — smart start (up if needed, DB check, `pnpm dev`) |
-| `xgic payload setup [--quiet]` | Ensure Payload project directory (idempotent) |
+| `xgic payload setup [--quiet]` | **First-run one-shot:** env (if missing) + DB profile + scaffold (idempotent) |
 | `xgic payload env [--json]` | Product env status (project name, `.env`, services) |
-| `xgic payload env --regenerate --yes` | Fresh credentials in `.devcontainer/.env` |
+| `xgic payload env --regenerate --yes` | Rotate credentials in `.devcontainer/.env` (optional; setup creates env when absent) |
 | `xgic payload schema` | Run template schema generator when present |
 | `xgic payload reset` | Fast targeted reset (project folder + active DB volume) |
 

{xgic_payload_cms_cli-0.2.1 → xgic_payload_cms_cli-0.2.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "xgic-payload-cms-cli"
-version = "0.2.1"
+version = "0.2.2"
 description = "XGIC CLI Payload CMS module - product commands and helpers (xgic.cli.payload)."
 readme = "README.md"
 license = { text = "Apache-2.0" }

{xgic_payload_cms_cli-0.2.1 → xgic_payload_cms_cli-0.2.2}/src/xgic/cli/payload/__init__.py

@@ -5,6 +5,7 @@ from xgic.cli.payload.config import (
     DEFAULT_CONFIG_FILE,
     DEFAULT_PRIMARY_SERVICE,
     db_ready,
+    get_compose_project_name,
     get_db_config,
     get_db_profile,
     get_payload_project_name,
@@ -20,7 +21,7 @@ from xgic.cli.payload.project import (
     load_create_payload_config,
 )
 
-__version__ = "0.2.0"
+__version__ = "0.2.2"
 
 __all__ = [
     "DEFAULT_COMPOSE_PROJECT",
@@ -30,6 +31,7 @@ __all__ = [
     "db_ready",
     "ensure_payload_project",
     "generate_fresh_env_content",
+    "get_compose_project_name",
     "get_db_config",
     "get_db_profile",
     "get_payload_project_name",

{xgic_payload_cms_cli-0.2.1 → xgic_payload_cms_cli-0.2.2}/src/xgic/cli/payload/commands/dev.py

@@ -8,9 +8,9 @@ from pathlib import Path
 from xgic.cli.app import CommandContext
 from xgic.cli.core.environment import EnvironmentType
 from xgic.cli.payload.config import (
-    DEFAULT_COMPOSE_PROJECT,
     DEFAULT_PRIMARY_SERVICE,
     db_ready,
+    get_compose_project_name,
     get_db_profile,
     make_payload_docker_controller,
 )
@@ -49,7 +49,7 @@ def run_dev(ctx: CommandContext) -> int:
     print_info(f"App location: {display_project_location(project_dir)}")
 
     docker = make_payload_docker_controller(env)
-    docker.project_name = DEFAULT_COMPOSE_PROJECT
+    docker.project_name = get_compose_project_name()
     profile = get_db_profile()
 
     # Never recreate the primary Dev Container service; only ensure DB.

{xgic_payload_cms_cli-0.2.1 → xgic_payload_cms_cli-0.2.2}/src/xgic/cli/payload/config.py

@@ -35,6 +35,67 @@ def get_payload_project_name(
     return "my-payload-cms"
 
 
+def _is_compose_safe_name(name: str) -> bool:
+    """Return True if *name* looks safe for Docker Compose project names."""
+    if not name or not name[0].isalnum():
+        return False
+    return all(c.isalnum() or c in "_-" for c in name) and len(name) <= 63
+
+
+def _compose_name_from_file(
+    compose_path: Path = Path(DEFAULT_COMPOSE_FILE),
+) -> str | None:
+    """Parse top-level ``name:`` from a Compose file (best-effort)."""
+    if not compose_path.is_file():
+        return None
+    try:
+        for line in compose_path.read_text(encoding="utf-8").splitlines():
+            stripped = line.strip()
+            if stripped.startswith("#") or not stripped.startswith("name:"):
+                continue
+            raw = stripped.split(":", 1)[1].strip().strip("\"'")
+            if raw and _is_compose_safe_name(raw.lower()):
+                return raw.lower()
+    except OSError:
+        return None
+    return None
+
+
+def get_compose_project_name(
+    config_file: Path = DEFAULT_CONFIG_FILE,
+) -> str:
+    """Return Docker Compose project name for this workspace.
+
+    Precedence:
+    1. ``XGIC_COMPOSE_PROJECT`` environment variable
+    2. ``composeProjectName`` in create-payload-config.json
+    3. Top-level ``name:`` in ``.devcontainer/docker-compose.yml``
+    4. ``DEFAULT_COMPOSE_PROJECT`` (producer template default)
+    """
+    import os
+
+    env_name = os.environ.get("XGIC_COMPOSE_PROJECT", "").strip().lower()
+    if env_name and _is_compose_safe_name(env_name):
+        return env_name
+
+    if config_file.exists():
+        try:
+            with open(config_file, encoding="utf-8") as f:
+                data: dict[str, Any] = json.load(f)
+            raw = data.get("composeProjectName")
+            if isinstance(raw, str) and raw.strip():
+                name = raw.strip().lower()
+                if _is_compose_safe_name(name):
+                    return name
+        except (json.JSONDecodeError, OSError):
+            pass
+
+    from_file = _compose_name_from_file()
+    if from_file:
+        return from_file
+
+    return DEFAULT_COMPOSE_PROJECT
+
 def get_payload_project_dir(
     config_file: Path = DEFAULT_CONFIG_FILE,
 ) -> Path:
@@ -101,7 +162,7 @@ def make_payload_docker_controller(
     return DockerComposeController(
         env=env,
         compose_file=DEFAULT_COMPOSE_FILE,
-        project_name=DEFAULT_COMPOSE_PROJECT,
+        project_name=get_compose_project_name(),
         primary_service=DEFAULT_PRIMARY_SERVICE,
     )
 

{xgic_payload_cms_cli-0.2.1 → xgic_payload_cms_cli-0.2.2}/src/xgic/cli/payload/project.py

@@ -13,9 +13,9 @@ from typing import Any
 
 from xgic.cli.payload.config import (
     DEFAULT_COMPOSE_FILE,
-    DEFAULT_COMPOSE_PROJECT,
     DEFAULT_CONFIG_FILE,
     db_ready,
+    get_compose_project_name,
     get_db_profile,
     make_payload_docker_controller,
 )
@@ -35,6 +35,7 @@ def load_create_payload_config(
         "projectName": "my-payload-cms",
         "projectDir": None,
         "layout": "auto",
+        "composeProjectName": None,
         "template": "website",
         "dbAdapter": "postgres",
         "agent": "none",
@@ -269,9 +270,8 @@ def ensure_db_services(*, quiet: bool = False, wait_seconds: float = 45.0) -> in
 
     env = EnvironmentContext.detect()
     docker = make_payload_docker_controller(env)
-    # Prefer stable default project name over config projectName for the
-    # Dev Container stack (matches compose file + VS Code project).
-    docker.project_name = DEFAULT_COMPOSE_PROJECT
+    compose_project = get_compose_project_name()
+    docker.project_name = compose_project
     profile = get_db_profile()
 
     if db_ready(docker):
@@ -281,11 +281,14 @@ def ensure_db_services(*, quiet: bool = False, wait_seconds: float = 45.0) -> in
 
     if not quiet:
         print_info(
-            f"Starting database service only: profile={profile!r}, "
-            f"service={profile!r} (project {DEFAULT_COMPOSE_PROJECT!r})"
+            f"Starting database service only: service={profile!r} "
+            f"(project {compose_project!r})"
         )
     try:
-        docker.up(profile=profile, services=[profile])
+        # Start the named service without forcing --profile. Services that use
+        # profiles still start when listed by name if already enabled; services
+        # without profiles (e.g. always-on postgres) work without a profile flag.
+        docker.up(services=[profile])
     except FileNotFoundError:
         print_warning(
             "docker not found. Run setup inside the Dev Container "
@@ -329,15 +332,17 @@ def ensure_payload_project(*, quiet: bool = False) -> int:
     project_dir = resolve_project_dir(cfg)
     target = create_payload_target_arg(project_dir)
 
+    # First-run: create .devcontainer/.env when missing (no separate
+    # `xgic payload env --regenerate --yes` step required).
     env_rc = ensure_devcontainer_env(quiet=quiet)
     if env_rc != 0:
         return env_rc
 
-    # Keep Compose project name aligned with the Dev Container stack default
-    # (not the npm projectName), so CLI and VS Code share one project.
-    if sync_compose_project_name(DEFAULT_COMPOSE_PROJECT) and not quiet:
+    # Compose project name from config (composeProjectName), not npm projectName.
+    compose_project = get_compose_project_name()
+    if sync_compose_project_name(compose_project) and not quiet:
         print_info(
-            f"Docker Compose project name set to {DEFAULT_COMPOSE_PROJECT!r} "
+            f"Docker Compose project name set to {compose_project!r} "
             f"in {DEFAULT_COMPOSE_FILE}"
         )