rhiza 0.5.1__tar.gz → 0.5.3__tar.gz

{rhiza-0.5.1 → rhiza-0.5.3}/.github/workflows/sync.yml

@@ -137,6 +137,3 @@ jobs:
 
             Changes were generated automatically using **rhiza**.
 
-      - name: Delete branch
-        if: ${{ steps.sync.outputs.changes_detected == 'false' }}
-        run: git push origin --delete rhiza_update

rhiza-0.5.3/.rhiza.history

@@ -0,0 +1,45 @@
+# Rhiza Template History
+# This file lists all files managed by the Rhiza template.
+# Template repository: jebel-quant/rhiza
+# Template branch: main
+#
+# Files under template control:
+.editorconfig
+.github/README.md
+.github/TOKEN_SETUP.md
+.github/actions/setup-project/action.yml
+.github/renovate.json
+.github/scripts/book.sh
+.github/scripts/bump.sh
+.github/scripts/customisations/build-extras.sh
+.github/scripts/customisations/post-release.sh
+.github/scripts/marimushka.sh
+.github/scripts/release.sh
+.github/scripts/update-readme-help.sh
+.github/workflows/book.yml
+.github/workflows/ci.yml
+.github/workflows/deptry.yml
+.github/workflows/marimo.yml
+.github/workflows/pre-commit.yml
+.github/workflows/release.yml
+.github/workflows/scripts/version_matrix.py
+.github/workflows/scripts/version_max.py
+.github/workflows/sync.yml
+.gitignore
+.pre-commit-config.yaml
+CODE_OF_CONDUCT.md
+CONTRIBUTING.md
+Makefile
+pytest.ini
+ruff.toml
+tests/test_rhiza/README.md
+tests/test_rhiza/conftest.py
+tests/test_rhiza/test_bump_script.py
+tests/test_rhiza/test_docstrings.py
+tests/test_rhiza/test_git_repo_fixture.py
+tests/test_rhiza/test_makefile.py
+tests/test_rhiza/test_marimushka_script.py
+tests/test_rhiza/test_readme.py
+tests/test_rhiza/test_release_script.py
+tests/test_rhiza/test_structure.py
+tests/test_rhiza/test_updatereadme_script.py

{rhiza-0.5.1 → rhiza-0.5.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rhiza
-Version: 0.5.1
+Version: 0.5.3
 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.1 → rhiza-0.5.3}/pyproject.toml

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

{rhiza-0.5.1 → rhiza-0.5.3}/src/rhiza/__init__.py

@@ -4,4 +4,12 @@ This package groups small, user-facing utilities that can be invoked from
 the command line or other automation scripts.
 """
 
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("rhiza")
+except PackageNotFoundError:
+    # Package is not installed, use a fallback version
+    __version__ = "0.0.0+dev"
+
 __all__ = ["commands", "models"]

{rhiza-0.5.1 → rhiza-0.5.3}/src/rhiza/cli.py

@@ -8,6 +8,7 @@ from pathlib import Path
 
 import typer
 
+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
@@ -18,6 +19,41 @@ app = typer.Typer(
 )
 
 
+def version_callback(value: bool):
+    """Print version information and exit.
+
+    Args:
+        value: Whether the --version flag was provided.
+
+    Raises:
+        typer.Exit: Always exits after printing version.
+    """
+    if value:
+        typer.echo(f"rhiza version {__version__}")
+        raise typer.Exit()
+
+
+@app.callback()
+def main(
+    version: bool = typer.Option(
+        False,
+        "--version",
+        "-v",
+        help="Show version and exit",
+        callback=version_callback,
+        is_eager=True,
+    ),
+):
+    """Rhiza CLI main callback.
+
+    This callback is executed before any command. It handles global options
+    like --version.
+
+    Args:
+        version: Version flag (handled by callback).
+    """
+
+
 @app.command()
 def init(
     target: Path = typer.Argument(

{rhiza-0.5.1 → rhiza-0.5.3}/src/rhiza/commands/init.py

@@ -61,4 +61,4 @@ Next steps:
 """)
 
     # the template file exists, so validate it
-    validate(target)
+    return validate(target)

{rhiza-0.5.1 → rhiza-0.5.3}/src/rhiza/commands/materialize.py

@@ -1,9 +1,9 @@
-"""Command-line helpers for working with Rhiza templates.
+"""Command for materializing Rhiza template files into a repository.
 
-This module currently exposes a thin wrapper that shells out to the
-`tools/inject_rhiza.sh` script. It exists so the functionality can be
-invoked via a Python entry point while delegating the heavy lifting to
-the maintained shell script.
+This module implements the `materialize` command. It performs a sparse
+checkout of the configured template repository, copies the selected files
+into the target Git repository, and records managed files in
+`.rhiza.history`. Use this to take a one-shot snapshot of template files.
 """
 
 import shutil
@@ -14,7 +14,7 @@ from pathlib import Path
 
 from loguru import logger
 
-from rhiza.commands.init import init
+from rhiza.commands import init
 from rhiza.models import RhizaTemplate
 
 
@@ -37,46 +37,48 @@ def expand_paths(base_dir: Path, paths: list[str]) -> list[Path]:
     return all_files
 
 
-def materialize(target: Path, branch: str, force: bool):
-    """Materialize rhiza templates into TARGET repository."""
-    # Convert to absolute path to avoid surprises
+def materialize(target: Path, branch: str, 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`.
+    """
     target = target.resolve()
 
     logger.info(f"Target repository: {target}")
     logger.info(f"Rhiza branch: {branch}")
 
     # -----------------------
-    # Ensure template.yml
+    # Ensure Rhiza is initialized
     # -----------------------
-    template_file = target / ".github" / "template.yml"
-    # template_file.parent.mkdir(parents=True, exist_ok=True)
+    valid = init(target)
 
-    # Initialize rhiza if not already initialized, e.g. construct a template.yml file
-    init(target)
+    if not valid:
+        logger.error(f"Rhiza template is invalid. {target}")
+        sys.exit(1)
 
-    # -----------------------
-    # Load template.yml
-    # -----------------------
+    template_file = target / ".github" / "template.yml"
     template = RhizaTemplate.from_yaml(template_file)
 
     rhiza_repo = template.template_repository
-    # Use template branch if specified, otherwise fall back to CLI parameter
-    rhiza_branch = template.template_branch if template.template_branch else branch
+    rhiza_branch = template.template_branch or branch
     include_paths = template.include
     excluded_paths = template.exclude
 
     if not include_paths:
-        logger.error("No include paths found in template.yml")
-        raise sys.exit(1)
+        raise RuntimeError("No include paths found in template.yml")
 
     logger.info("Include paths:")
     for p in include_paths:
         logger.info(f"  - {p}")
 
     # -----------------------
-    # Sparse clone rhiza
+    # Sparse clone template repo
     # -----------------------
     tmp_dir = Path(tempfile.mkdtemp())
+    materialized_files: list[Path] = []
+
     logger.info(f"Cloning {rhiza_repo}@{rhiza_branch} into temporary directory")
 
     try:
@@ -97,30 +99,38 @@ def materialize(target: Path, branch: str, force: bool):
             stdout=subprocess.DEVNULL,
         )
 
-        subprocess.run(["git", "sparse-checkout", "init"], cwd=tmp_dir, check=True)
-        subprocess.run(["git", "sparse-checkout", "set", "--skip-checks", *include_paths], cwd=tmp_dir, check=True)
+        subprocess.run(
+            ["git", "sparse-checkout", "init", "--cone"],
+            cwd=tmp_dir,
+            check=True,
+        )
 
-        # After sparse-checkout
+        subprocess.run(
+            ["git", "sparse-checkout", "set", "--skip-checks", *include_paths],
+            cwd=tmp_dir,
+            check=True,
+        )
+
+        # -----------------------
+        # Expand include/exclude paths
+        # -----------------------
         all_files = expand_paths(tmp_dir, include_paths)
 
-        # Filter out excluded files
-        # excluded_set = {tmp_dir / e for e in excluded_paths}
-        excluded_files = 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 not in excluded_files]
-        # print(files_to_copy)
+        files_to_copy = [f for f in all_files if f.resolve() not in excluded_files]
 
-        # Copy loop
-        materialized_files = []
+        # -----------------------
+        # Copy files into target repo
+        # -----------------------
         for src_file in files_to_copy:
             dst_file = target / src_file.relative_to(tmp_dir)
             relative_path = dst_file.relative_to(target)
 
-            # Track this file as being under template control
             materialized_files.append(relative_path)
 
             if dst_file.exists() and not force:
-                logger.warning(f"{relative_path} already exists — use force=True to overwrite")
+                logger.warning(f"{relative_path} already exists — use --force to overwrite")
                 continue
 
             dst_file.parent.mkdir(parents=True, exist_ok=True)
@@ -130,9 +140,22 @@ def materialize(target: Path, branch: str, force: bool):
     finally:
         shutil.rmtree(tmp_dir)
 
-    # Write .rhiza.history file listing all files under template control
+    # -----------------------
+    # Warn about workflow files
+    # -----------------------
+    workflow_files = [p for p in materialized_files if p.parts[:2] == (".github", "workflows")]
+
+    if workflow_files:
+        logger.warning(
+            "Workflow files were materialized. Updating these files requires "
+            "a token with the 'workflow' permission in GitHub Actions."
+        )
+
+    # -----------------------
+    # Write .rhiza.history
+    # -----------------------
     history_file = target / ".rhiza.history"
-    with open(history_file, "w") as f:
+    with history_file.open("w", encoding="utf-8") as f:
         f.write("# Rhiza Template History\n")
         f.write("# This file lists all files managed by the Rhiza template.\n")
         f.write(f"# Template repository: {rhiza_repo}\n")
@@ -141,19 +164,19 @@ def materialize(target: Path, branch: str, force: bool):
         f.write("# Files under template control:\n")
         for file_path in sorted(materialized_files):
             f.write(f"{file_path}\n")
+
     logger.info(f"Created {history_file.relative_to(target)} with {len(materialized_files)} files")
 
     logger.success("Rhiza templates materialized successfully")
-    logger.info("""
-Next steps:
-  1. Review changes:
-       git status
-       git diff
-
-  2. Commit:
-       git add .
-       git commit -m "chore: import rhiza templates"
-
-This is a one-shot snapshot.
-Re-run this script to update templates explicitly.
-""")
+
+    logger.info(
+        "Next steps:\n"
+        "  1. Review changes:\n"
+        "       git status\n"
+        "       git diff\n\n"
+        "  2. Commit:\n"
+        "       git add .\n"
+        '       git commit -m "chore: import rhiza templates"\n\n'
+        "This is a one-shot snapshot.\n"
+        "Re-run this command to update templates explicitly."
+    )

{rhiza-0.5.1 → rhiza-0.5.3}/src/rhiza/commands/validate.py

@@ -133,4 +133,5 @@ def validate(target: Path) -> bool:
         return True
     else:
         logger.error("✗ Validation failed: template.yml has errors")
+        # raise AssertionError("Invalid template.yml")
         return False

{rhiza-0.5.1 → rhiza-0.5.3}/tests/test_cli_commands.py

@@ -9,12 +9,35 @@ This module tests:
 import subprocess
 import sys
 
+from rhiza import __version__
 from rhiza.commands.materialize import expand_paths
 
 
 class TestCliApp:
     """Tests for the CLI Typer app."""
 
+    def test_version_flag(self):
+        """Test that --version flag shows version information."""
+        result = subprocess.run(
+            [sys.executable, "-m", "rhiza", "--version"],
+            capture_output=True,
+            text=True,
+        )
+        assert result.returncode == 0
+        assert "rhiza version" in result.stdout
+        assert __version__ in result.stdout
+
+    def test_version_short_flag(self):
+        """Test that -v flag shows version information."""
+        result = subprocess.run(
+            [sys.executable, "-m", "rhiza", "-v"],
+            capture_output=True,
+            text=True,
+        )
+        assert result.returncode == 0
+        assert "rhiza version" in result.stdout
+        assert __version__ in result.stdout
+
 
 class TestExpandPaths:
     """Tests for the expand_paths utility function."""

{rhiza-0.5.1 → rhiza-0.5.3}/uv.lock

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