caffeinated-whale-cli 2.3.1__tar.gz → 2.4.0__tar.gz

{caffeinated_whale_cli-2.3.1 → caffeinated_whale_cli-2.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: caffeinated-whale-cli
-Version: 2.3.1
+Version: 2.4.0
 Summary: A CLI tool to help manage Frappe Docker instances.
 Author-email: Christopher McKay <mckay.christopher73@outlook.com>
 License: MIT
@@ -201,6 +201,7 @@ cwcli init [OPTIONS] [PROJECT_NAME]
 | `--bench-parent TEXT` | Directory inside container where bench is created (default: /workspace); also the container mount point for the persisted host `data/` directory, fixed for the life of the instance - changing it on a re-init errors, naming the mounted directory |
 | `--frappe-branch TEXT` | Frappe branch or tag for bench init, e.g. `version-16` or `v16.26.3` (default: version-16). Mutually exclusive with `--version` |
 | `--version TEXT` | Frappe version for bench init, resolved by shape: a bare major (`16` → `version-16` branch) or a full semantic version (`16.26.3` → `v16.26.3` tag). Malformed values are rejected with a non-zero exit. Mutually exclusive with `--frappe-branch` |
+| `--frappe-url TEXT` | Custom Frappe repository URL to build from (a fork), passed to `bench init --frappe-path`. Omit to use the default `frappe/frappe` repo. Pair with `--frappe-branch` to check out the fork's branch. A private fork authenticates through the same credential bridge as `apps install`/`apps update` (host `gh`/`glab`, no token in the container); sign in on the host first |
 | `--db-root-password TEXT` | MariaDB root password (default: 123) |
 | `--admin-password TEXT` | Administrator password for the site, used verbatim. If omitted, a strong password is generated and printed once (interactive runs only); a non-interactive run must supply this flag |
 | `--install-erpnext` | Install ERPNext application after initialization |
@@ -271,6 +272,9 @@ cwcli init my-project --version 16
 # ...or a full semantic version -> vX.Y.Z tag
 cwcli init my-project --version 16.26.3
 
+# Build from a Frappe fork, checking out its branch
+cwcli init my-project --frappe-url https://github.com/me/frappe --frappe-branch my-feature
+
 # Full customization
 cwcli init my-project \
   --port 12000 \

{caffeinated_whale_cli-2.3.1 → caffeinated_whale_cli-2.4.0}/README.md

@@ -161,6 +161,7 @@ cwcli init [OPTIONS] [PROJECT_NAME]
 | `--bench-parent TEXT` | Directory inside container where bench is created (default: /workspace); also the container mount point for the persisted host `data/` directory, fixed for the life of the instance - changing it on a re-init errors, naming the mounted directory |
 | `--frappe-branch TEXT` | Frappe branch or tag for bench init, e.g. `version-16` or `v16.26.3` (default: version-16). Mutually exclusive with `--version` |
 | `--version TEXT` | Frappe version for bench init, resolved by shape: a bare major (`16` → `version-16` branch) or a full semantic version (`16.26.3` → `v16.26.3` tag). Malformed values are rejected with a non-zero exit. Mutually exclusive with `--frappe-branch` |
+| `--frappe-url TEXT` | Custom Frappe repository URL to build from (a fork), passed to `bench init --frappe-path`. Omit to use the default `frappe/frappe` repo. Pair with `--frappe-branch` to check out the fork's branch. A private fork authenticates through the same credential bridge as `apps install`/`apps update` (host `gh`/`glab`, no token in the container); sign in on the host first |
 | `--db-root-password TEXT` | MariaDB root password (default: 123) |
 | `--admin-password TEXT` | Administrator password for the site, used verbatim. If omitted, a strong password is generated and printed once (interactive runs only); a non-interactive run must supply this flag |
 | `--install-erpnext` | Install ERPNext application after initialization |
@@ -231,6 +232,9 @@ cwcli init my-project --version 16
 # ...or a full semantic version -> vX.Y.Z tag
 cwcli init my-project --version 16.26.3
 
+# Build from a Frappe fork, checking out its branch
+cwcli init my-project --frappe-url https://github.com/me/frappe --frappe-branch my-feature
+
 # Full customization
 cwcli init my-project \
   --port 12000 \

{caffeinated_whale_cli-2.3.1 → caffeinated_whale_cli-2.4.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "caffeinated-whale-cli"
-version = "2.3.1"
+version = "2.4.0"
 authors = [
   { name = "Christopher McKay", email = "mckay.christopher73@outlook.com" },
 ]

caffeinated_whale_cli-2.4.0/src/caffeinated_whale_cli/__init__.py

@@ -0,0 +1 @@
+__version__ = "2.4.0"

{caffeinated_whale_cli-2.3.1 → caffeinated_whale_cli-2.4.0}/src/caffeinated_whale_cli/commands/axi.py

@@ -2157,6 +2157,13 @@ def axi_init(
         help="Frappe version resolved by shape: a bare major (16 -> version-16) or a full "
         "semantic version (16.26.3 -> v16.26.3). Mutually exclusive with --frappe-branch.",
     ),
+    frappe_url: str = typer.Option(
+        None,
+        "--frappe-url",
+        help="Custom Frappe repository URL to build from (a fork), passed to 'bench init "
+        "--frappe-path'. Omit for the default frappe/frappe repo. Pair with --frappe-branch "
+        "to check out the fork's branch.",
+    ),
     db_root_password: str = typer.Option(
         None,
         "--db-root-password",
@@ -2283,6 +2290,7 @@ def axi_init(
             site_name=site,
             bench_parent=bench_parent,
             frappe_ref=frappe_ref,
+            frappe_url=frappe_url,
             db_root_password=db_root,
             admin_password=resolved_admin,
             reuse_bench=reuse_bench,

{caffeinated_whale_cli-2.3.1 → caffeinated_whale_cli-2.4.0}/src/caffeinated_whale_cli/commands/init.py

@@ -487,6 +487,15 @@ def init(
             "(16.26.3 -> v16.26.3 tag). Mutually exclusive with --frappe-branch."
         ),
     ),
+    frappe_url: str | None = typer.Option(
+        None,
+        "--frappe-url",
+        help=(
+            "Custom Frappe repository URL to build from (a fork), passed to "
+            "'bench init --frappe-path'. Omit to use the default frappe/frappe repo. "
+            "Pair with --frappe-branch to check out the fork's branch."
+        ),
+    ),
     db_root_password: str = typer.Option(
         "123",
         "--db-root-password",
@@ -562,6 +571,7 @@ def init(
         cwcli init my-project --version 16 --install-erpnext
         cwcli init my-project --version 16.26.3
         cwcli init my-project --frappe-branch version-16 --admin-password mypass
+        cwcli init my-project --frappe-url https://github.com/me/frappe --frappe-branch my-feature
     """
     # Resolve the Frappe git ref first so a malformed --version fails fast,
     # before any project dir / container work.
@@ -644,6 +654,7 @@ def init(
                     site_name=site,
                     bench_parent=bench_parent,
                     frappe_ref=frappe_branch,
+                    frappe_url=frappe_url,
                     db_root_password=db_root_password,
                     admin_password=admin_password,
                     reuse_bench=reuse_answer,

{caffeinated_whale_cli-2.3.1 → caffeinated_whale_cli-2.4.0}/src/caffeinated_whale_cli/core/init.py

@@ -30,6 +30,7 @@ value the old path did not print.
 
 from __future__ import annotations
 
+import contextlib
 import json
 import re
 import shlex
@@ -42,8 +43,8 @@ from pathlib import Path
 
 from ..utils import config_utils, db_utils
 from ..utils.port_utils import check_ports_in_use, format_port_list
+from . import credbridge, resolvers
 from . import docker as core_docker
-from . import resolvers
 from .envelope import Choice, Message, Result, Status
 from .errors import CwcliError, ErrorKind
 from .exec_stream import ExecChunk, ExecDone, exec_stream
@@ -866,6 +867,7 @@ def init_bench(
     site_name: str,
     bench_parent: str = "/workspace",
     frappe_ref: str = DEFAULT_FRAPPE_BRANCH,
+    frappe_url: str | None = None,
     db_root_password: str = "123",
     admin_password: str,
     reuse_bench: bool | None = None,
@@ -887,6 +889,16 @@ def init_bench(
     it mirrors - the downloaded compose's hardcoded ``MYSQL_ROOT_PASSWORD:
     123`` - lives in the compose file the core itself downloads; it is
     shielded off the argv/echo, not randomized.
+
+    ``frappe_url`` is the optional custom Frappe repository (a fork) passed
+    through to ``bench init --frappe-path``; ``None`` (the default) builds from
+    the upstream ``frappe/frappe`` repo exactly as before. ``frappe_ref`` is the
+    branch/tag within that repo, so a fork tracking a custom branch pairs the two
+    (``frappe_url=<fork>``, ``frappe_ref=<branch>``). When ``frappe_url`` is a
+    PRIVATE fork, the ``bench init`` clone is wrapped in the same
+    :func:`core.credbridge.credential_bridge` context ``apps`` install/update
+    use, so it authenticates through the host's ``gh``/``glab`` with no token
+    ever entering the container.
     """
     emit = on_event or _noop
     warnings: list[Message] = []
@@ -1041,31 +1053,44 @@ def init_bench(
                 else:
                     emit(InitTrace(text="yarn installed successfully."))
 
+        bench_init_args = [
+            "bench",
+            "init",
+            "--skip-redis-config-generation",
+            "--frappe-branch",
+            shlex.quote(frappe_ref),
+        ]
+        # A custom Frappe repo (a fork) rides bench's own --frappe-path; frappe_ref
+        # above is the branch/tag to check out within it. Omitted -> upstream repo.
+        if frappe_url:
+            bench_init_args += ["--frappe-path", shlex.quote(frappe_url)]
+        bench_init_args += [shlex.quote(bench_name), "--verbose"]
         bench_init_cmd = _build_cd_command(
-            bench_parent_path,
-            nvm_prefix
-            + env_prefix
-            + " ".join(
-                [
-                    "bench",
-                    "init",
-                    "--skip-redis-config-generation",
-                    "--frappe-branch",
-                    shlex.quote(frappe_ref),
-                    shlex.quote(bench_name),
-                    "--verbose",
-                ]
-            ),
+            bench_parent_path, nvm_prefix + env_prefix + " ".join(bench_init_args)
         )
 
         emit(InitStepStart(phase="bench_init", item=bench_name))
-        _run_exec(
-            frappe_container,
-            bench_init_cmd,
-            phase="bench_init",
-            emit=emit,
-            collect=not stream_output,
+        # A custom Frappe fork may be a PRIVATE repo, so bridge the container's
+        # git back to the host's gh/glab for the clone `bench init` performs -
+        # the same context apps install/update wrap their get-app fetch in
+        # (see core.credbridge). The upstream default (frappe_url is None) is the
+        # public frappe/frappe repo and needs no bridge, so that common path is
+        # left untouched; the bridge is inert for a public fork too (git only
+        # calls a credential helper on a 401). bench_full_path is under the
+        # workspace mount, which is what credbridge resolves against.
+        bridge: contextlib.AbstractContextManager[None] = (
+            credbridge.credential_bridge(frappe_container, bench_full_path)
+            if frappe_url
+            else contextlib.nullcontext()
         )
+        with bridge:
+            _run_exec(
+                frappe_container,
+                bench_init_cmd,
+                phase="bench_init",
+                emit=emit,
+                collect=not stream_output,
+            )
         emit(InitStepEnd(phase="bench_init"))
         bench_created = True
 

caffeinated_whale_cli-2.3.1/src/caffeinated_whale_cli/__init__.py

@@ -1 +0,0 @@
-__version__ = "2.3.1"