rhiza 0.5.4__py3-none-any.whl → 0.5.6__py3-none-any.whl

rhiza/cli.py

@@ -12,6 +12,7 @@ from rhiza import __version__
 from rhiza.commands import init as init_cmd
 from rhiza.commands import materialize as materialize_cmd
 from rhiza.commands import validate as validate_cmd
+from rhiza.commands.welcome import welcome as welcome_cmd
 
 app = typer.Typer(
     help=(
@@ -171,3 +172,17 @@ def validate(
     """
     if not validate_cmd(target):
         raise typer.Exit(code=1)
+
+
+@app.command()
+def welcome():
+    r"""Display a friendly welcome message and explain what Rhiza is.
+
+    Shows a welcome message, explains Rhiza's purpose, key features,
+    and provides guidance on getting started with the tool.
+
+    \b
+    Examples:
+        rhiza welcome
+    """
+    welcome_cmd()

rhiza/commands/materialize.py

@@ -6,6 +6,7 @@ into the target Git repository, and records managed files in
 `.rhiza.history`. Use this to take a one-shot snapshot of template files.
 """
 
+import os
 import shutil
 import subprocess
 import sys
@@ -18,7 +19,7 @@ from rhiza.commands import init
 from rhiza.models import RhizaTemplate
 
 
-def expand_paths(base_dir: Path, paths: list[str]) -> list[Path]:
+def __expand_paths(base_dir: Path, paths: list[str]) -> list[Path]:
     """Expand files/directories relative to base_dir into a flat list of files.
 
     Given a list of paths relative to ``base_dir``, return a flat list of all
@@ -40,26 +41,26 @@ def expand_paths(base_dir: Path, paths: list[str]) -> list[Path]:
 def materialize(target: Path, branch: str, target_branch: str | None, force: bool) -> None:
     """Materialize Rhiza templates into the target repository.
 
-    This performs a sparse checkout of the template repository and copies
-    the selected files into the target repository, recording all files
-    under template control in `.rhiza.history`.
-
-    Parameters
-    ----------
-    target:
-        Path to the target repository.
-    branch:
-        The Rhiza template branch to use.
-    target_branch:
-        Optional branch name to create/checkout in target repository.
-    force:
-        Whether to overwrite existing files.
+    This performs a sparse checkout of the template repository and copies the
+    selected files into the target repository, recording all files under
+    template control in `.rhiza.history`.
+
+    Args:
+        target (Path): Path to the target repository.
+        branch (str): The Rhiza template branch to use.
+        target_branch (str | None): Optional branch name to create/checkout in
+            the target repository.
+        force (bool): Whether to overwrite existing files.
     """
     target = target.resolve()
 
     logger.info(f"Target repository: {target}")
     logger.info(f"Rhiza branch: {branch}")
 
+    # Set environment to prevent git from prompting for credentials
+    git_env = os.environ.copy()
+    git_env["GIT_TERMINAL_PROMPT"] = "0"
+
     # -----------------------
     # Handle target branch creation/checkout if specified
     # -----------------------
@@ -72,6 +73,7 @@ def materialize(target: Path, branch: str, target_branch: str | None, force: boo
                 cwd=target,
                 capture_output=True,
                 text=True,
+                env=git_env,
             )
 
             if result.returncode == 0:
@@ -81,6 +83,7 @@ def materialize(target: Path, branch: str, target_branch: str | None, force: boo
                     ["git", "checkout", target_branch],
                     cwd=target,
                     check=True,
+                    env=git_env,
                 )
             else:
                 # Branch doesn't exist, create and checkout
@@ -89,6 +92,7 @@ def materialize(target: Path, branch: str, target_branch: str | None, force: boo
                     ["git", "checkout", "-b", target_branch],
                     cwd=target,
                     check=True,
+                    env=git_env,
                 )
         except subprocess.CalledProcessError as e:
             logger.error(f"Failed to create/checkout branch '{target_branch}': {e}")
@@ -138,41 +142,70 @@ def materialize(target: Path, branch: str, target_branch: str | None, force: boo
     logger.info(f"Cloning {rhiza_repo}@{rhiza_branch} from {rhiza_host} into temporary directory")
 
     try:
-        subprocess.run(
-            [
-                "git",
-                "clone",
-                "--depth",
-                "1",
-                "--filter=blob:none",
-                "--sparse",
-                "--branch",
-                rhiza_branch,
-                git_url,
-                str(tmp_dir),
-            ],
-            check=True,
-            stdout=subprocess.DEVNULL,
-        )
+        # Clone the repository - capture output to avoid blocking
+        try:
+            subprocess.run(
+                [
+                    "git",
+                    "clone",
+                    "--depth",
+                    "1",
+                    "--filter=blob:none",
+                    "--sparse",
+                    "--branch",
+                    rhiza_branch,
+                    git_url,
+                    str(tmp_dir),
+                ],
+                check=True,
+                capture_output=True,
+                text=True,
+                env=git_env,
+            )
+        except subprocess.CalledProcessError as e:
+            logger.error(f"Failed to clone repository: {e}")
+            if e.stderr:
+                logger.error(f"Git error: {e.stderr.strip()}")
+            raise
 
-        subprocess.run(
-            ["git", "sparse-checkout", "init", "--cone"],
-            cwd=tmp_dir,
-            check=True,
-        )
+        # Initialize sparse checkout
+        try:
+            subprocess.run(
+                ["git", "sparse-checkout", "init", "--cone"],
+                cwd=tmp_dir,
+                check=True,
+                capture_output=True,
+                text=True,
+                env=git_env,
+            )
+        except subprocess.CalledProcessError as e:
+            logger.error(f"Failed to initialize sparse checkout: {e}")
+            if e.stderr:
+                logger.error(f"Git error: {e.stderr.strip()}")
+            raise
 
-        subprocess.run(
-            ["git", "sparse-checkout", "set", "--skip-checks", *include_paths],
-            cwd=tmp_dir,
-            check=True,
-        )
+        # Set sparse checkout paths
+        try:
+            subprocess.run(
+                ["git", "sparse-checkout", "set", "--skip-checks", *include_paths],
+                cwd=tmp_dir,
+                check=True,
+                capture_output=True,
+                text=True,
+                env=git_env,
+            )
+        except subprocess.CalledProcessError as e:
+            logger.error(f"Failed to set sparse checkout paths: {e}")
+            if e.stderr:
+                logger.error(f"Git error: {e.stderr.strip()}")
+            raise
 
         # -----------------------
         # Expand include/exclude paths
         # -----------------------
-        all_files = expand_paths(tmp_dir, include_paths)
+        all_files = __expand_paths(tmp_dir, include_paths)
 
-        excluded_files = {f.resolve() for f in expand_paths(tmp_dir, excluded_paths)}
+        excluded_files = {f.resolve() for f in __expand_paths(tmp_dir, excluded_paths)}
 
         files_to_copy = [f for f in all_files if f.resolve() not in excluded_files]
 

rhiza/commands/welcome.py

@@ -0,0 +1,55 @@
+# This file is part of the jebel-quant/rhiza repository
+# (https://github.com/jebel-quant/rhiza).
+#
+"""Command to display a welcome message and explain Rhiza.
+
+This module provides the welcome command that displays a friendly greeting
+and explains what Rhiza is and how it can help manage configuration templates.
+"""
+
+from rhiza import __version__
+
+
+def welcome():
+    """Display a welcome message and explain what Rhiza is.
+
+    Shows a friendly greeting, explains Rhiza's purpose, and provides
+    next steps for getting started with the tool.
+    """
+    welcome_message = f"""
+╭───────────────────────────────────────────────────────────────╮
+│                                                               │
+│  🌿 Welcome to Rhiza v{__version__:<43} │
+│                                                               │
+╰───────────────────────────────────────────────────────────────╯
+
+Rhiza helps you maintain consistent configuration across multiple
+Python projects using reusable templates stored in a central repository.
+
+✨ What Rhiza can do for you:
+
+  • Initialize projects with standard configuration templates
+  • Materialize (inject) templates into target repositories
+  • Validate template configurations
+  • Keep project configurations synchronized
+
+🚀 Getting started:
+
+  1. Initialize a project:
+     $ rhiza init
+
+  2. Customize .github/template.yml to match your needs
+
+  3. Materialize templates into your project:
+     $ rhiza materialize
+
+📚 Learn more:
+
+  • View all commands:    rhiza --help
+  • Project repository:   https://github.com/jebel-quant/rhiza-cli
+  • Documentation:        https://jebel-quant.github.io/rhiza-cli/
+
+Happy templating! 🎉
+"""
+
+    print(welcome_message)

{rhiza-0.5.4.dist-info → rhiza-0.5.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rhiza
-Version: 0.5.4
+Version: 0.5.6
 Summary: Reusable configuration templates for modern Python projects
 Project-URL: Homepage, https://github.com/jebel-quant/rhiza-cli
 Project-URL: Repository, https://github.com/jebel-quant/rhiza-cli

rhiza-0.5.6.dist-info/RECORD

@@ -0,0 +1,14 @@
+rhiza/__init__.py,sha256=1jfkGAONm7dH4KwYjvNEyuxrQ-1m2YncxREYCJnTrHA,1933
+rhiza/__main__.py,sha256=Lx0GqVZo6ymm0f18_uYB6E7_SOWwJNYjb73Vr31oLoM,236
+rhiza/cli.py,sha256=Jqe285OWOvbvembO5DXTVITfnFefsjVGZCJuK3EKRT8,5081
+rhiza/models.py,sha256=R2nu_bf-j-U0kPfQXg6u-MSykrdGO9ixOzZoWy8mLCc,3448
+rhiza/commands/__init__.py,sha256=lIkN15MIat-wn9CB1cgUjTzTUQB95LBBAKFK1sGHdCc,1836
+rhiza/commands/init.py,sha256=QsOV_VBnRfSPebydH-fMe3haadboNIAYlOpAIYHtgUs,1936
+rhiza/commands/materialize.py,sha256=FUStZGUr2oDEC-M8V61JnV3W7USj-VS0EHI10a0Mn6Y,9378
+rhiza/commands/validate.py,sha256=_0t9kfylMncm9JmKULn5e7V71XcQdFjlrtuOqZeshPM,5282
+rhiza/commands/welcome.py,sha256=GpDbRSIUigaxS7Di9RIpl2jCOFOlhlQT2vNvCzBR-8U,2001
+rhiza-0.5.6.dist-info/METADATA,sha256=PI_8F886fva98V4uq_toyZ9O8gC8tnOPy-FPSUn0eE4,21278
+rhiza-0.5.6.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+rhiza-0.5.6.dist-info/entry_points.txt,sha256=NAwZUpbXvfKv50a_Qq-PxMHl3lcjAyZO63IBeuUNgfY,45
+rhiza-0.5.6.dist-info/licenses/LICENSE,sha256=4m5X7LhqX-6D0Ks79Ys8CLpmza8cxDG34g4S9XSNAGY,1077
+rhiza-0.5.6.dist-info/RECORD,,

rhiza-0.5.4.dist-info/RECORD

@@ -1,13 +0,0 @@
-rhiza/__init__.py,sha256=1jfkGAONm7dH4KwYjvNEyuxrQ-1m2YncxREYCJnTrHA,1933
-rhiza/__main__.py,sha256=Lx0GqVZo6ymm0f18_uYB6E7_SOWwJNYjb73Vr31oLoM,236
-rhiza/cli.py,sha256=orVHOn569qHm-TffRLpSoJlF5x59dNfQsC2pX7VppYA,4721
-rhiza/models.py,sha256=R2nu_bf-j-U0kPfQXg6u-MSykrdGO9ixOzZoWy8mLCc,3448
-rhiza/commands/__init__.py,sha256=lIkN15MIat-wn9CB1cgUjTzTUQB95LBBAKFK1sGHdCc,1836
-rhiza/commands/init.py,sha256=QsOV_VBnRfSPebydH-fMe3haadboNIAYlOpAIYHtgUs,1936
-rhiza/commands/materialize.py,sha256=PcJT7Cq1eXoUZjAe_X1TXn4yUXt1Kft7rCedEe2P-44,7921
-rhiza/commands/validate.py,sha256=_0t9kfylMncm9JmKULn5e7V71XcQdFjlrtuOqZeshPM,5282
-rhiza-0.5.4.dist-info/METADATA,sha256=2Dh1FhzIIHbDvGu2FSPGHJCG8PQonP9rcZvO4D3MH-M,21278
-rhiza-0.5.4.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-rhiza-0.5.4.dist-info/entry_points.txt,sha256=NAwZUpbXvfKv50a_Qq-PxMHl3lcjAyZO63IBeuUNgfY,45
-rhiza-0.5.4.dist-info/licenses/LICENSE,sha256=4m5X7LhqX-6D0Ks79Ys8CLpmza8cxDG34g4S9XSNAGY,1077
-rhiza-0.5.4.dist-info/RECORD,,