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

rhiza/__init__.py

@@ -29,7 +29,7 @@ Validate your configuration:
 rhiza validate
 ```
 
-Customize `.github/template.yml`, then materialize templates into your project:
+Customize `.github/rhiza/template.yml`, then materialize templates into your project:
 
 ```bash
 rhiza materialize

rhiza/cli.py

@@ -71,10 +71,10 @@ def init(
         help="Target directory (defaults to current directory)",
     ),
 ):
-    r"""Initialize or validate .github/template.yml.
+    r"""Initialize or validate .github/rhiza/template.yml.
 
     \b
-    Creates a default `.github/template.yml` configuration file if one
+    Creates a default `.github/rhiza/template.yml` configuration file if one
     doesn't exist, or validates the existing configuration.
 
     \b
@@ -117,10 +117,10 @@ def materialize(
 
     \b
     Materializes configuration files from the template repository specified
-    in .github/template.yml into your project. This command:
+    in .github/rhiza/template.yml into your project. This command:
 
     \b
-    - Reads .github/template.yml configuration
+    - Reads .github/rhiza/template.yml configuration
     - Performs a sparse clone of the template repository
     - Copies specified files/directories to your project
     - Respects exclusion patterns defined in the configuration
@@ -149,7 +149,7 @@ def validate(
 ):
     r"""Validate Rhiza template configuration.
 
-    Validates the .github/template.yml file to ensure it is syntactically
+    Validates the .github/rhiza/template.yml file to ensure it is syntactically
     correct and semantically valid.
 
     \b

rhiza/commands/__init__.py

@@ -8,7 +8,7 @@ configuration templates for Python projects.
 
 ### init
 
-Initialize or validate `.github/template.yml` in a target directory.
+Initialize or validate `.github/rhiza/template.yml` in a target directory.
 
 Creates a default configuration file if it doesn't exist, or validates
 an existing one. The default configuration includes common Python project
@@ -29,7 +29,7 @@ is used.
 
 Validate Rhiza template configuration.
 
-Validates the `.github/template.yml` file to ensure it is syntactically
+Validates the `.github/rhiza/template.yml` file to ensure it is syntactically
 correct and semantically valid. Performs comprehensive validation including
 YAML syntax checking, required field verification, field type validation,
 and repository format verification.

rhiza/commands/init.py

@@ -1,10 +1,11 @@
-"""Command to initialize or validate .github/template.yml.
+"""Command to initialize or validate .github/rhiza/template.yml.
 
 This module provides the init command that creates or validates the
-.github/template.yml file, which defines where templates come from
+.github/rhiza/template.yml file, which defines where templates come from
 and what paths are governed by Rhiza.
 """
 
+import shutil
 from pathlib import Path
 
 from loguru import logger
@@ -14,9 +15,9 @@ from rhiza.models import RhizaTemplate
 
 
 def init(target: Path):
-    """Initialize or validate .github/template.yml in the target repository.
+    """Initialize or validate .github/rhiza/template.yml in the target repository.
 
-    Creates a default .github/template.yml file if it doesn't exist,
+    Creates a default .github/rhiza/template.yml file if it doesn't exist,
     or validates an existing one.
 
     Args:
@@ -27,16 +28,24 @@ def init(target: Path):
 
     logger.info(f"Initializing Rhiza configuration in: {target}")
 
-    # Create .github directory if it doesn't exist
+    # Create .github/rhiza directory if it doesn't exist
     github_dir = target / ".github"
-    github_dir.mkdir(parents=True, exist_ok=True)
+    rhiza_dir = github_dir / "rhiza"
+    rhiza_dir.mkdir(parents=True, exist_ok=True)
 
-    # Define the template file path
+    # check the old location and copy over if existent
+    # todo: remove this logic later
     template_file = github_dir / "template.yml"
+    if template_file.exists():
+        # move the file into rhiza_dir
+        shutil.copyfile(template_file, rhiza_dir / "template.yml")
+
+    # Define the template file path
+    template_file = rhiza_dir / "template.yml"
 
     if not template_file.exists():
         # Create default template.yml
-        logger.info("Creating default .github/template.yml")
+        logger.info("Creating default .github/rhiza/template.yml")
 
         default_template = RhizaTemplate(
             template_repository="jebel-quant/rhiza",
@@ -53,10 +62,10 @@ def init(target: Path):
 
         default_template.to_yaml(template_file)
 
-        logger.success("✓ Created .github/template.yml")
+        logger.success("✓ Created .github/rhiza/template.yml")
         logger.info("""
 Next steps:
-  1. Review and customize .github/template.yml to match your project needs
+  1. Review and customize .github/rhiza/template.yml to match your project needs
   2. Run 'rhiza materialize' to inject templates into your repository
 """)
 

rhiza/commands/materialize.py

@@ -103,13 +103,17 @@ def materialize(target: Path, branch: str, target_branch: str | None, force: boo
     # -----------------------
     valid = init(target)
 
+    # init will make sure the template_file exists at the new location!
+
     if not valid:
         logger.error(f"Rhiza template is invalid. {target}")
         sys.exit(1)
 
-    template_file = target / ".github" / "template.yml"
+    template_file = target / ".github" / "rhiza" / "template.yml"
     template = RhizaTemplate.from_yaml(template_file)
 
+    # init will make sure the template_file exists at the new location!
+
     rhiza_repo = template.template_repository
     rhiza_branch = template.template_branch or branch
     rhiza_host = template.template_host or "github"

rhiza/commands/validate.py

@@ -1,6 +1,6 @@
 """Command for validating Rhiza template configuration.
 
-This module provides functionality to validate .github/template.yml files
+This module provides functionality to validate .github/rhiza/template.yml files
 to ensure they are syntactically correct and semantically valid.
 """
 
@@ -35,14 +35,23 @@ def validate(target: Path) -> bool:
 
     logger.info(f"Validating template configuration in: {target}")
 
-    # Check if template.yml exists
-    template_file = target / ".github" / "template.yml"
-    if not template_file.exists():
-        logger.error(f"Template file not found: {template_file}")
+    # Check one of the possible template.yml exists
+    template_file = [target / ".github" / "rhiza" / "template.yml", target / ".github" / "template.yml"]
+
+    # Check the exists
+    exists = [file.exists() for file in template_file]
+
+    if not any(exists):
+        logger.error(f"No template file found: {template_file}")
         logger.info("Run 'rhiza init' to create a default template.yml")
         return False
 
-    logger.success(f"Found template file: {template_file}")
+    if exists[0]:
+        logger.success(f"Template file exists: {template_file[0]}")
+        template_file = template_file[0]
+    else:
+        logger.warning(f"Template file exists but in old location: {template_file[1]}")
+        template_file = template_file[1]
 
     # Validate YAML syntax
     try:

rhiza/commands/welcome.py

@@ -19,7 +19,7 @@ def welcome():
     welcome_message = f"""
 ╭───────────────────────────────────────────────────────────────╮
 │                                                               │
-│  🌿 Welcome to Rhiza v{__version__:<43} │
+│  🌿 Welcome to Rhiza v{__version__:<39} │
 │                                                               │
 ╰───────────────────────────────────────────────────────────────╯
 
@@ -38,7 +38,7 @@ Python projects using reusable templates stored in a central repository.
   1. Initialize a project:
      $ rhiza init
 
-  2. Customize .github/template.yml to match your needs
+  2. Customize .github/rhiza/template.yml to match your needs
 
   3. Materialize templates into your project:
      $ rhiza materialize

rhiza/models.py

@@ -13,7 +13,7 @@ import yaml
 
 @dataclass
 class RhizaTemplate:
-    """Represents the structure of .github/template.yml.
+    """Represents the structure of .github/rhiza/template.yml.
 
     Attributes:
         template_repository: The GitHub or GitLab repository containing templates (e.g., "jebel-quant/rhiza").

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rhiza
-Version: 0.5.6
+Version: 0.6.0
 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
@@ -81,6 +81,35 @@ For more detailed information, see:
 pip install rhiza
 ```
 
+To update to the latest version:
+
+```bash
+pip install --upgrade rhiza
+```
+
+### Using uvx (run without installation)
+
+[uvx](https://docs.astral.sh/uv/) is part of the `uv` package manager and allows you to run CLI tools directly without installing them:
+
+```bash
+uvx rhiza --help
+```
+
+With uvx, you don't need to install rhiza globally. Each time you run `uvx rhiza`, it will automatically use the latest version available on PyPI. To ensure you're using the latest version, simply run your command - uvx will fetch updates as needed:
+
+```bash
+# Always uses the latest version
+uvx rhiza init
+uvx rhiza materialize
+uvx rhiza validate
+```
+
+If you want to use a specific version:
+
+```bash
+uvx rhiza@0.5.6 --help
+```
+
 ### From source
 
 ```bash
@@ -112,11 +141,11 @@ rhiza --help
    rhiza init
    ```
 
-   This creates a `.github/template.yml` file with default configuration.
+   This creates a `.github/rhiza/template.yml` file with default configuration.
 
 2. **Customize the template configuration:**
 
-   Edit `.github/template.yml` to specify which files/directories to include from your template repository.
+   Edit `.github/rhiza/template.yml` to specify which files/directories to include from your template repository.
 
 3. **Materialize templates into your project:**
 
@@ -132,13 +161,13 @@ rhiza --help
    rhiza validate
    ```
 
-   This checks that your `.github/template.yml` is correctly formatted and valid.
+   This checks that your `.github/rhiza/template.yml` is correctly formatted and valid.
 
 ## Commands
 
 ### `rhiza init`
 
-Initialize or validate `.github/template.yml` in a target directory.
+Initialize or validate `.github/rhiza/template.yml` in a target directory.
 
 **Usage:**
 
@@ -152,7 +181,7 @@ rhiza init [TARGET]
 
 **Description:**
 
-Creates a default `.github/template.yml` file if it doesn't exist, or validates an existing one. The default configuration includes common Python project files like `.github`, `.editorconfig`, `.gitignore`, `.pre-commit-config.yaml`, `Makefile`, and `pytest.ini`.
+Creates a default `.github/rhiza/template.yml` file if it doesn't exist, or validates an existing one. The default configuration includes common Python project files like `.github`, `.editorconfig`, `.gitignore`, `.pre-commit-config.yaml`, `Makefile`, and `pytest.ini`.
 
 **Examples:**
 
@@ -172,18 +201,18 @@ rhiza init ..
 When creating a new template file:
 ```
 [INFO] Initializing Rhiza configuration in: /path/to/project
-[INFO] Creating default .github/template.yml
-✓ Created .github/template.yml
+[INFO] Creating default .github/rhiza/template.yml
+✓ Created .github/rhiza/template.yml
 
 Next steps:
-  1. Review and customize .github/template.yml to match your project needs
+  1. Review and customize .github/rhiza/template.yml to match your project needs
   2. Run 'rhiza materialize' to inject templates into your repository
 ```
 
 When validating an existing file:
 ```
 [INFO] Validating template configuration in: /path/to/project
-✓ Found template file: /path/to/project/.github/template.yml
+✓ Found template file: /path/to/project/.github/rhiza/template.yml
 ✓ YAML syntax is valid
 ✓ Field 'template-repository' is present and valid
 ✓ Field 'include' is present and valid
@@ -218,7 +247,7 @@ rhiza materialize [OPTIONS] [TARGET]
 
 Materializes template files from the configured template repository into your target project. This command:
 
-1. Reads the `.github/template.yml` configuration
+1. Reads the `.github/rhiza/template.yml` configuration
 2. Performs a sparse clone of the template repository
 3. Copies specified files/directories to your project
 4. Respects exclusion patterns defined in the configuration
@@ -300,7 +329,7 @@ rhiza validate [TARGET]
 
 **Description:**
 
-Validates the `.github/template.yml` file to ensure it is syntactically correct and semantically valid. This performs authoritative validation including:
+Validates the `.github/rhiza/template.yml` file to ensure it is syntactically correct and semantically valid. This performs authoritative validation including:
 
 - Checking if the file exists
 - Validating YAML syntax
@@ -331,7 +360,7 @@ rhiza validate ..
 
 ```
 [INFO] Validating template configuration in: /path/to/project
-✓ Found template file: /path/to/project/.github/template.yml
+✓ Found template file: /path/to/project/.github/rhiza/template.yml
 ✓ YAML syntax is valid
 ✓ Field 'template-repository' is present and valid
 ✓ Field 'include' is present and valid
@@ -355,7 +384,7 @@ rhiza validate ..
 or
 
 ```
-[ERROR] Template file not found: /path/to/project/.github/template.yml
+[ERROR] Template file not found: /path/to/project/.github/rhiza/template.yml
 [INFO] Run 'rhiza materialize' or 'rhiza init' to create a default template.yml
 ```
 
@@ -363,7 +392,7 @@ or
 
 ## Configuration
 
-Rhiza uses a `.github/template.yml` file to define template sources and what to include in your project.
+Rhiza uses a `.github/rhiza/template.yml` file to define template sources and what to include in your project.
 
 ### Configuration File Format
 
@@ -504,7 +533,7 @@ git init
 rhiza init
 
 # Review the generated template.yml
-cat .github/template.yml
+cat .github/rhiza/template.yml
 
 # Materialize templates
 rhiza materialize
@@ -539,7 +568,7 @@ git commit -m "chore: update rhiza templates"
 
 ### Example 3: Using a custom template repository
 
-Edit `.github/template.yml`:
+Edit `.github/rhiza/template.yml`:
 
 ```yaml
 template-repository: myorg/my-templates
@@ -561,7 +590,7 @@ rhiza materialize --force
 
 ### Example 4: Using a GitLab template repository
 
-Edit `.github/template.yml`:
+Edit `.github/rhiza/template.yml`:
 
 ```yaml
 template-repository: mygroup/python-templates
@@ -701,7 +730,7 @@ Releasing and Versioning
   post-release     perform post-release tasks
 
 Meta
-  sync             sync with template repository as defined in .github/template.yml
+  sync             sync with template repository as defined in .github/rhiza/template.yml
   help             Display this help message
   customisations   list available customisation scripts
   update-readme    update README.md with current Makefile help output
@@ -773,7 +802,7 @@ export PATH="$HOME/.local/bin:$PATH"
 ### Template validation fails
 
 Check that:
-1. Your `.github/template.yml` file exists
+1. Your `.github/rhiza/template.yml` file exists
 2. The YAML syntax is valid
 3. Required fields (`template-repository` and `include`) are present
 4. The repository format is `owner/repo`
@@ -805,11 +834,11 @@ A: Yes, as long as you have Git credentials configured that allow access to the
 
 **Q: Does Rhiza support template repositories hosted outside GitHub?**
 
-A: Yes! Rhiza supports both GitHub and GitLab repositories. Use the `template-host` field in your `.github/template.yml` to specify "github" (default) or "gitlab".
+A: Yes! Rhiza supports both GitHub and GitLab repositories. Use the `template-host` field in your `.github/rhiza/template.yml` to specify "github" (default) or "gitlab".
 
 **Q: How do I use a GitLab repository as a template source?**
 
-A: Add `template-host: gitlab` to your `.github/template.yml` file. For example:
+A: Add `template-host: gitlab` to your `.github/rhiza/template.yml` file. For example:
 ```yaml
 template-repository: mygroup/myproject
 template-host: gitlab
@@ -824,15 +853,23 @@ A: Not directly. However, you can run `rhiza materialize` multiple times with di
 
 **Q: What's the difference between `rhiza init` and `rhiza materialize`?**
 
-A: `init` creates or validates the `.github/template.yml` configuration file. `materialize` reads that configuration and actually copies the template files into your project.
+A: `init` creates or validates the `.github/rhiza/template.yml` configuration file. `materialize` reads that configuration and actually copies the template files into your project.
 
 **Q: How do I update my project's templates?**
 
 A: Simply run `rhiza materialize --force` to fetch and overwrite with the latest versions from your template repository.
 
+**Q: How do I update rhiza-cli itself?**
+
+A: The update method depends on how you installed rhiza:
+
+- **Using pip**: Run `pip install --upgrade rhiza`
+- **Using uvx**: No action needed! `uvx` automatically uses the latest version each time you run it. Just run your command: `uvx rhiza <command>`
+- **From source**: Run `git pull` in the repository directory and then `pip install -e .` again
+
 **Q: Can I customize which files are included?**
 
-A: Yes, edit the `include` and `exclude` lists in `.github/template.yml` to control exactly which files are copied.
+A: Yes, edit the `include` and `exclude` lists in `.github/rhiza/template.yml` to control exactly which files are copied.
 
 ## Acknowledgments
 

rhiza-0.6.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+rhiza/__init__.py,sha256=iW3niLBjwRKxcMhIV_1eb78putjUTo2tbZsadofluJk,1939
+rhiza/__main__.py,sha256=Lx0GqVZo6ymm0f18_uYB6E7_SOWwJNYjb73Vr31oLoM,236
+rhiza/cli.py,sha256=faCIOKDzEDRvL4doLZhiIAyHUUGESGrwWLtjLjimCUY,5111
+rhiza/models.py,sha256=fW9lofkkid-bghk2bXEgBdGbZ4scSqG726fMrVfKX_M,3454
+rhiza/commands/__init__.py,sha256=Z5CeMh7ylX27H6dvwqRbEKzYo5pwQq-5TyTxABUSaQg,1848
+rhiza/commands/init.py,sha256=1JFvT-Y8eYcjqhM7xaaRCBmelKlQNmxaVgyCOeDvydw,2310
+rhiza/commands/materialize.py,sha256=aQcBp8VTBt5DPxyDC2VcgngqTdLDxqbYd5F_B2UF2_A,9534
+rhiza/commands/validate.py,sha256=oYCZnTxr39l20jr6DhBpFtMURv7jULSV8Ii6it8KHxs,5628
+rhiza/commands/welcome.py,sha256=gLgahbfBCBhmZPxWKywx7kYGBTMCVyyVVnly9uKdJv0,2007
+rhiza-0.6.0.dist-info/METADATA,sha256=GrFAnXe3MUq0evyRHFQDE4Yv3mUziu2LKz0wrYFN1fQ,22523
+rhiza-0.6.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+rhiza-0.6.0.dist-info/entry_points.txt,sha256=NAwZUpbXvfKv50a_Qq-PxMHl3lcjAyZO63IBeuUNgfY,45
+rhiza-0.6.0.dist-info/licenses/LICENSE,sha256=4m5X7LhqX-6D0Ks79Ys8CLpmza8cxDG34g4S9XSNAGY,1077
+rhiza-0.6.0.dist-info/RECORD,,

rhiza-0.5.6.dist-info/RECORD

@@ -1,14 +0,0 @@
-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,,