rhiza 0.5.0__py3-none-any.whl → 0.5.2__py3-none-any.whl

rhiza/__init__.py

@@ -4,6 +4,4 @@ This package groups small, user-facing utilities that can be invoked from
 the command line or other automation scripts.
 """
 
-from rhiza.models import RhizaTemplate
-
-__all__ = ["RhizaTemplate"]
+__all__ = ["commands", "models"]

rhiza/cli.py

@@ -8,9 +8,9 @@ from pathlib import Path
 
 import typer
 
-from rhiza.commands.init import init as init_cmd
-from rhiza.commands.materialize import materialize as materialize_cmd
-from rhiza.commands.validate import validate as validate_cmd
+from rhiza.commands import init as init_cmd
+from rhiza.commands import materialize as materialize_cmd
+from rhiza.commands import validate as validate_cmd
 
 app = typer.Typer(
     help="Rhiza - Manage reusable configuration templates for Python projects",

rhiza/commands/__init__.py

@@ -3,3 +3,7 @@
 This package contains the functions that back Typer commands exposed by
 `rhiza.cli`, such as `hello` and `inject`.
 """
+
+from .init import init  # noqa: F401
+from .materialize import materialize  # noqa: F401
+from .validate import validate  # noqa: F401

rhiza/commands/init.py

@@ -19,10 +19,8 @@ def init(target: Path):
     Creates a default .github/template.yml file if it doesn't exist,
     or validates an existing one.
 
-    Parameters
-    ----------
-    target:
-        Path to the target directory. Defaults to the current working directory.
+    Args:
+        target: Path to the target directory. Defaults to the current working directory.
     """
     # Convert to absolute path to avoid surprises
     target = target.resolve()

rhiza/commands/materialize.py

@@ -1,20 +1,11 @@
-"""Command-line helpers for working with Rhiza templates.
-
-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.
-"""
-
 import shutil
 import subprocess
-import sys
 import tempfile
 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 +28,44 @@ 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)
-
-    # Initialize rhiza if not already initialized, e.g. construct a template.yml file
     init(target)
 
-    # -----------------------
-    # 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:
@@ -84,12 +73,10 @@ def materialize(target: Path, branch: str, force: bool):
             [
                 "git",
                 "clone",
-                "--depth",
-                "1",
+                "--depth", "1",
                 "--filter=blob:none",
                 "--sparse",
-                "--branch",
-                rhiza_branch,
+                "--branch", rhiza_branch,
                 f"https://github.com/{rhiza_repo}.git",
                 str(tmp_dir),
             ],
@@ -97,44 +84,98 @@ 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
+        # -----------------------
+        # 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)
+
+            materialized_files.append(relative_path)
+
             if dst_file.exists() and not force:
-                logger.warning(f"{dst_file.relative_to(target)} 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)
             shutil.copy2(src_file, dst_file)
-            logger.success(f"[ADD] {dst_file.relative_to(target)}")
+            logger.success(f"[ADD] {relative_path}")
 
     finally:
         shutil.rmtree(tmp_dir)
 
+    # -----------------------
+    # 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 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")
+        f.write(f"# Template branch: {rhiza_branch}\n")
+        f.write("#\n")
+        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)} "
+        f"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/commands/validate.py

@@ -19,14 +19,10 @@ def validate(target: Path) -> bool:
     - Validates required fields
     - Validates field values are appropriate
 
-    Parameters
-    ----------
-    target:
-        Path to the target Git repository directory.
+    Args:
+        target: Path to the target Git repository directory.
 
     Returns:
-    -------
-    bool
         True if validation passes, False otherwise.
     """
     # Convert to absolute path

rhiza/models.py

@@ -16,17 +16,12 @@ class RhizaTemplate:
     """Represents the structure of .github/template.yml.
 
     Attributes:
-    ----------
-    template_repository : str | None
-        The GitHub repository containing templates (e.g., "jebel-quant/rhiza").
-        Can be None if not specified in the template file.
-    template_branch : str | None
-        The branch to use from the template repository.
-        Can be None if not specified in the template file (defaults to "main" when creating).
-    include : list[str]
-        List of paths to include from the template repository.
-    exclude : list[str]
-        List of paths to exclude from the template repository (default: empty list).
+        template_repository: The GitHub repository containing templates (e.g., "jebel-quant/rhiza").
+            Can be None if not specified in the template file.
+        template_branch: The branch to use from the template repository.
+            Can be None if not specified in the template file (defaults to "main" when creating).
+        include: List of paths to include from the template repository.
+        exclude: List of paths to exclude from the template repository (default: empty list).
     """
 
     template_repository: str | None = None
@@ -38,24 +33,16 @@ class RhizaTemplate:
     def from_yaml(cls, file_path: Path) -> "RhizaTemplate":
         """Load RhizaTemplate from a YAML file.
 
-        Parameters
-        ----------
-        file_path : Path
-            Path to the template.yml file.
+        Args:
+            file_path: Path to the template.yml file.
 
         Returns:
-        -------
-        RhizaTemplate
             The loaded template configuration.
 
         Raises:
-        ------
-        FileNotFoundError
-            If the file does not exist.
-        yaml.YAMLError
-            If the YAML is malformed.
-        ValueError
-            If the file is empty.
+            FileNotFoundError: If the file does not exist.
+            yaml.YAMLError: If the YAML is malformed.
+            ValueError: If the file is empty.
         """
         with open(file_path) as f:
             config = yaml.safe_load(f)
@@ -73,10 +60,8 @@ class RhizaTemplate:
     def to_yaml(self, file_path: Path) -> None:
         """Save RhizaTemplate to a YAML file.
 
-        Parameters
-        ----------
-        file_path : Path
-            Path where the template.yml file should be saved.
+        Args:
+            file_path: Path where the template.yml file should be saved.
         """
         # Ensure parent directory exists
         file_path.parent.mkdir(parents=True, exist_ok=True)

{rhiza-0.5.0.dist-info → rhiza-0.5.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rhiza
-Version: 0.5.0
+Version: 0.5.2
 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
@@ -25,7 +25,7 @@ Requires-Dist: typer>=0.20.0
 Provides-Extra: dev
 Requires-Dist: marimo==0.18.4; extra == 'dev'
 Requires-Dist: pdoc>=16.0.0; extra == 'dev'
-Requires-Dist: pre-commit==4.5.0; extra == 'dev'
+Requires-Dist: pre-commit==4.5.1; extra == 'dev'
 Requires-Dist: pytest-cov>=7.0.0; extra == 'dev'
 Requires-Dist: pytest-html>=4.1.1; extra == 'dev'
 Requires-Dist: pytest==9.0.2; extra == 'dev'
@@ -35,6 +35,9 @@ Description-Content-Type: text/markdown
 
 [![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![PyPI version](https://img.shields.io/pypi/v/rhiza.svg)](https://pypi.org/project/rhiza/)
+[![Coverage](https://img.shields.io/badge/coverage-report-brightgreen.svg)](https://jebel-quant.github.io/rhiza-cli/tests/html-coverage/index.html)
+[![Downloads](https://static.pepy.tech/personalized-badge/rhiza?period=month&units=international_system&left_color=black&right_color=orange&left_text=PyPI%20downloads%20per%20month)](https://pepy.tech/project/rhiza)
 
 Command-line interface for managing reusable configuration templates for modern Python projects.
 
@@ -675,9 +678,11 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
 
 ## Links
 
+- **PyPI:** https://pypi.org/project/rhiza/
 - **Repository:** https://github.com/jebel-quant/rhiza-cli
 - **Issues:** https://github.com/jebel-quant/rhiza-cli/issues
 - **Documentation:** Generated with `make docs`
+- **Companion Book:** https://jebel-quant.github.io/rhiza-cli/ (includes coverage report, API docs, and notebooks)
 
 ## Architecture
 

rhiza-0.5.2.dist-info/RECORD

@@ -0,0 +1,13 @@
+rhiza/__init__.py,sha256=1AECbLiERqRhdcFkVxHk3vEK4KPWll-D05CTAHZDI2A,224
+rhiza/__main__.py,sha256=Lx0GqVZo6ymm0f18_uYB6E7_SOWwJNYjb73Vr31oLoM,236
+rhiza/cli.py,sha256=v7VaGUEnfuGRMOGh8I7Luh-QiUHj0to7tsSXVFuUyts,3458
+rhiza/models.py,sha256=-n5eyPcU35IVsbvy7F-kyKR343TkOrx25kooLCF9whg,3001
+rhiza/commands/__init__.py,sha256=KcoFX52xQ1NFdgVeGsAkIaqmJrRso1GOq0vFL0WEB44,300
+rhiza/commands/init.py,sha256=K8NN9x_gMWeoD1gx9PCDkGUCN3luxZgp7tVD2jCqT94,1929
+rhiza/commands/materialize.py,sha256=6dE5uG41HkSERFqupS29PaHh32lveHRvbxEttaCfBpk,5525
+rhiza/commands/validate.py,sha256=itcLg44GiuZ7hZ67Bscj1RavdERlWgq40rJDaYOp2zM,4829
+rhiza-0.5.2.dist-info/METADATA,sha256=3X4vrQOv-eb1Znj_VAq8J5OmHAPI3V6vgM4dNTSasaw,19938
+rhiza-0.5.2.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+rhiza-0.5.2.dist-info/entry_points.txt,sha256=NAwZUpbXvfKv50a_Qq-PxMHl3lcjAyZO63IBeuUNgfY,45
+rhiza-0.5.2.dist-info/licenses/LICENSE,sha256=4m5X7LhqX-6D0Ks79Ys8CLpmza8cxDG34g4S9XSNAGY,1077
+rhiza-0.5.2.dist-info/RECORD,,

rhiza-0.5.0.dist-info/RECORD

@@ -1,13 +0,0 @@
-rhiza/__init__.py,sha256=fxaeT_K8bQAX5qt1DtRKWmyKpk7ABLomxhzZwL6Rml8,259
-rhiza/__main__.py,sha256=Lx0GqVZo6ymm0f18_uYB6E7_SOWwJNYjb73Vr31oLoM,236
-rhiza/cli.py,sha256=P130eveGtBUTby3A5LNDvgtJ2ekWcAiv84GqZ5kLcw4,3484
-rhiza/models.py,sha256=HbWgHPS-sWur4ax7a8tu2B6apr6YEdbGoxOpWxyeP9s,3220
-rhiza/commands/__init__.py,sha256=X5ZRDDl37X8mEbiMWoqjTGlLhebkYhZ2SaLJd4KcHdw,166
-rhiza/commands/init.py,sha256=wAVlcTdCiU8bN98Gsx8MGryo8fraFLQCvDl5ZlR1ySg,1953
-rhiza/commands/materialize.py,sha256=G1pDraC2gqIFuqC9nmIeXPnAHMna2KBIPfPAuLDllec,4412
-rhiza/commands/validate.py,sha256=rY04vz71C4ILAcLDaf4y4AtP3Bs5KcaIPCLoA074SA8,4874
-rhiza-0.5.0.dist-info/METADATA,sha256=OG-KEbNrDEd802tVMSUacQKuUH8SPOFV8pVxUbrAM3U,19323
-rhiza-0.5.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-rhiza-0.5.0.dist-info/entry_points.txt,sha256=NAwZUpbXvfKv50a_Qq-PxMHl3lcjAyZO63IBeuUNgfY,45
-rhiza-0.5.0.dist-info/licenses/LICENSE,sha256=4m5X7LhqX-6D0Ks79Ys8CLpmza8cxDG34g4S9XSNAGY,1077
-rhiza-0.5.0.dist-info/RECORD,,