rhiza 0.5.4__tar.gz → 0.5.6__tar.gz

{rhiza-0.5.4 → rhiza-0.5.6}/PKG-INFO

@@ -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.4 → rhiza-0.5.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "rhiza"
-version = "0.5.4"
+version = "0.5.6"
 description = "Reusable configuration templates for modern Python projects"
 readme = "README.md"
 requires-python = ">=3.11"

{rhiza-0.5.4 → rhiza-0.5.6}/src/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-0.5.4 → rhiza-0.5.6}/src/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-0.5.6/src/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 → rhiza-0.5.6}/tests/test_cli_commands.py

@@ -14,7 +14,6 @@ import typer
 
 from rhiza import __version__
 from rhiza.cli import version_callback
-from rhiza.commands.materialize import expand_paths
 
 
 class TestCliApp:
@@ -59,67 +58,6 @@ class TestCliApp:
         version_callback(False)  # Should not raise
 
 
-class TestExpandPaths:
-    """Tests for the expand_paths utility function."""
-
-    def test_expand_single_file(self, tmp_path):
-        """Test expanding a single file path."""
-        test_file = tmp_path / "test.txt"
-        test_file.write_text("content")
-
-        result = expand_paths(tmp_path, ["test.txt"])
-        assert result == [test_file]
-
-    def test_expand_directory(self, tmp_path):
-        """Test expanding a directory into all its files."""
-        test_dir = tmp_path / "dir"
-        test_dir.mkdir()
-        file1 = test_dir / "file1.txt"
-        file2 = test_dir / "file2.txt"
-        file1.write_text("content1")
-        file2.write_text("content2")
-
-        result = expand_paths(tmp_path, ["dir"])
-        assert len(result) == 2
-        assert file1 in result
-        assert file2 in result
-
-    def test_expand_nested_directory(self, tmp_path):
-        """Test expanding a directory with nested subdirectories."""
-        test_dir = tmp_path / "dir"
-        sub_dir = test_dir / "subdir"
-        sub_dir.mkdir(parents=True)
-        file1 = test_dir / "file1.txt"
-        file2 = sub_dir / "file2.txt"
-        file1.write_text("content1")
-        file2.write_text("content2")
-
-        result = expand_paths(tmp_path, ["dir"])
-        assert len(result) == 2
-        assert file1 in result
-        assert file2 in result
-
-    def test_expand_nonexistent_path(self, tmp_path):
-        """Test that nonexistent paths are skipped."""
-        result = expand_paths(tmp_path, ["nonexistent.txt"])
-        assert result == []
-
-    def test_expand_mixed_paths(self, tmp_path):
-        """Test expanding a mix of files and directories."""
-        file1 = tmp_path / "file1.txt"
-        file1.write_text("content1")
-
-        test_dir = tmp_path / "dir"
-        test_dir.mkdir()
-        file2 = test_dir / "file2.txt"
-        file2.write_text("content2")
-
-        result = expand_paths(tmp_path, ["file1.txt", "dir"])
-        assert len(result) == 2
-        assert file1 in result
-        assert file2 in result
-
-
 class TestMainEntry:
     """Tests for the __main__.py entry point."""
 
@@ -153,3 +91,35 @@ class TestMainEntry:
             assert "rhiza" in captured.out.lower()
         finally:
             sys.argv = original_argv
+
+
+class TestWelcomeCommand:
+    """Tests for the welcome command."""
+
+    def test_welcome_command(self, capsys):
+        """Test that the welcome command displays welcome message."""
+        result = subprocess.run(
+            [sys.executable, "-m", "rhiza", "welcome"],
+            capture_output=True,
+            text=True,
+        )
+        assert result.returncode == 0
+        output = result.stdout
+
+        # Check for key elements of the welcome message
+        assert "Welcome to Rhiza" in output
+        assert __version__ in output
+        assert "What Rhiza can do" in output
+        assert "Getting started" in output
+        assert "rhiza init" in output
+        assert "rhiza materialize" in output
+
+    def test_welcome_command_function_coverage(self, capsys):
+        """Test the welcome command function directly for coverage."""
+        from rhiza.commands.welcome import welcome
+
+        welcome()
+
+        captured = capsys.readouterr()
+        assert "Welcome to Rhiza" in captured.out
+        assert __version__ in captured.out

{rhiza-0.5.4 → rhiza-0.5.6}/uv.lock

@@ -771,7 +771,7 @@ wheels = [
 
 [[package]]
 name = "rhiza"
-version = "0.5.4"
+version = "0.5.6"
 source = { editable = "." }
 dependencies = [
     { name = "loguru" },