Hooks Completely Re-written

- Removed Task from post_gen_project.py
- Renamed hook files:
  - pre_prompt.py -> pre_prompt.uv
  - pre_gen_project.py -> pre_gen_project.uv
  - post_gen_project.py -> post_gen_project.uv
- Added uv shebang magic to hooks.
- Added inline script metadata to add dependencies
- Call commands using `sh` module
- Customized the logger from loguru
- Added logging for optional and required events.
- Added a README to explain further.

I want the hooks to emit useful messages when things
go bad but remain mostly silent otherwise.

Author: JnyJny

README.md

@@ -26,26 +26,36 @@ you and people that interact with your project repository.
 - Automatically creates an initial git commit.
 - Optionally creates an upstream repository and pushes (GitHub only, requires [gh][gh]).
 
-## Package Features
+## So Many Package Features
 
-- Python project designed to be managed with [uv][uv].
-- Exposes a command line interface built with [typer][typer].
-- Package is callable via `python -m <package>`.
+### Code Features
+- Python `src` style project designed to be managed with [uv][uv].
+- Includes a command line interface built with [typer][typer].
+  - Application settings optionally managed with [pydantic-settings][pydantic-settings].
+  - Preconfigured with a `self` subcommand like all the cool kids.
+- Logging handled by [loguru][loguru] with optional logging to a file.
+- Package is also callable via `python -m <package>` magic.
+
+
+### Quality Of Life Features
 - [Poe the Poet][poe] tasks integrated into pyproject.toml:
-  - Test with pytest.
+  - Test with pytest, tests started for you!
   - Generate HTML code coverage reports.
   - Run code quality checks using `mypy`, `ruff`, and `ty`.
   - Publish to PyPI via GitHub Actions with `poe publish`.
 - Development tool options integrated into pyproject.toml.
+
+### GitHub Integrations
 - Generic GitHub Issue and Pull Request templates.
-- Configured to use [dependabot][dependabot] dependency checker.
-  - Checks project dependencies.
-  - Checks project GitHub action dependencies.
+- The [dependabot][dependabot] checks:
+  - Project dependencies.
+  - Project GitHub action dependencies (these never age out right?).
 - Operating System and Python version test matrices.
+
+### Miscellaneous
 - Configured to use [direnv][direnv] to automatically activate & deactivate venvs.
 - Optionally configured badges in README.md for cool points.
-- Optionally managed CLI settings using [pydantic-settings][pydantic-settings].
-- Optionally logs to a file.
+
 
 ## Prerequisites
 
@@ -66,8 +76,6 @@ you and people that interact with your project repository.
 
 ## Creating Your Project
 
-
-
 If you haven't authenticated to GitHub with `gh` yet and you plan to
 ask `cookiecutter` to create the upstream repository, you should do
 that now:
@@ -87,26 +95,14 @@ After answering the `cookiecutter` prompts, you should see the
 following:
 
 ```console
-Task [Install Dev Python............] 🟢
-Task [Create .venv..................] 🟢
-Task [Enable Direnv.................] 🟢
-Task [Sync Project Deps.............] 🟢
-Task [Ruff Check Source.............] 🟢
-Task [Initialize Git................] 🟢
-Task [Add Files.....................] 🟢
-Task [Initial Commit................] 🟢
-Task [Create Upstream Repo .........] 🟢
+✨ Your new project is ready to use! ✨
 $ 
 ```
 
-If you didn't ask to have the upstream GitHub repository created, the
-last task will not run.  If you don't have `gh` installed or you
-aren't authenticated, the last task will fail but the template
-generation will complete successfully.
-
 ### Example Package Tree
 
 ```console
+$ cd <YOUR_PACKAGE_NAME_HERE>
 $ poe tree
 .
 ├── .cookiecutter.json

hooks/README.md

@@ -0,0 +1,38 @@
+# UV Hooks
+
+Cookiecutter looks for three files to run during the templating process:
+1. `pre_prompt`
+1. `pre_gen_project`
+1. `post_gen_project`
+
+If the file in question has a `.py` suffix, it attempts to run using
+Python otherwise it execs the file with `subprocess`.
+
+It's nice to write the hooks in Python, however the execution
+environment for the hooks is kinds of ambiguous and limits the
+hook implementations to only using the Python standard library.
+
+So I did a thing.
+
+The files in this directory have a suffix `.uv` indicating that they
+are **not** Python programs, so cookiecutter execs them using
+`subprocess`. This lets me run the code in the file using uv to 
+satisfy dependencies without relying on the execution environment
+to supply them.
+
+### `pre_prompt.uv`
+
+```python
+#!/usr/bin/env -S uv run --quiet --script
+# /// script
+# requires-python = ">=3.13"
+# dependencies = [ "sh", "packaging>=25", "loguru" ]
+# ///
+...
+```
+
+## Justification for this Hackery?
+
+I wanted to use `loguru` for logging and `sh` for command execution.
+
+

hooks/post_gen_project.py

@@ -0,0 +1,103 @@
+#!/usr/bin/env -S uv run --quiet --script
+# /// script
+# requires-python = ">=3.13"
+# dependencies = [ "sh", "loguru" ]
+# ///
+"""Post generation tasks for cookiecutter templates."""
+
+import sys
+from pathlib import Path
+from functools import partial
+
+import sh
+from loguru import logger
+
+
+def _logger_setup() -> None:
+    """Setup logger for post-generation tasks."""
+    logger.remove()
+    logger.add(
+        sys.stdout,
+        format="✨ {function:<15} | <level>{level:<8}</level>  | {message}",
+    )
+    logger.level("REQUIRED", no=50, color="<red>", icon="💔")
+    logger.level("OPTIONAL", no=30, color="<blue>", icon="⚠️")
+    logger.required = partial(logger.log, "REQUIRED")
+    logger.optional = partial(logger.log, "OPTIONAL")
+
+
+def _remove_empty_comments(path: Path | str) -> None:
+    """Remove empty comment lines from the given path.
+
+    Cookiecutter template files have Jinja directives in them
+    that are commented out. When the directives are processed,
+    it leaves lines with empty comments (e.g. `# `) in the files.
+    """
+    path = Path(path)
+    lines = path.read_text().splitlines()
+    text = [line for line in lines if line.strip() != "#"]
+    path.write_text("\n".join(text) + "\n")
+
+
+def post_gen_project() -> int:
+    """Things to do after cookiecutter has rendered the template.
+
+    - Remove empty comment lines left over from Jinja processing.
+    - Install requested development python version.
+    - Create a python virtual environment.
+    - Sync project requirements to venv.
+    - Ruff check src and test.
+    - Initialize a git repo.
+    - Add all files to git.
+    - Commit initial state of the repo.
+    - Optionally create a GitHub repository and push the initial commit.
+    """
+    for subdir in ["src", "tests"]:
+        for path in Path(subdir).rglob("*.py"):
+            _remove_empty_comments(path)
+
+    cmds = [
+        (True, sh.uv.python.install.bake("{{ cookiecutter.python_version_dev }}")),
+        (False, sh.direnv.bake("allow")),
+        (True, sh.uv.sync.bake("--quiet", "--no-progress")),
+        (True, sh.uvx.ruff.check.bake("--fix", "src", "tests")),
+        (True, sh.git.init.bake("--quiet", "--initial-branch", "main")),
+        (True, sh.git.add.bake(".")),
+        (True, sh.git.commit.bake("-m", "initial commit")),
+        # {% if cookiecutter.create_github_repo %}
+        (
+            False,
+            sh.gh.repo.create.bake(
+                "{{ cookiecutter.package_name }}",
+                "--public",
+                "--push",
+                "--source=.",
+                "--remote=upstream",
+            ),
+        ),
+        # {% endif %}
+    ]
+
+    for required, cmd in cmds:
+        try:
+            cmd()
+        except sh.CommandNotFound:
+            if required:
+                logger.required("Required command not available: %s" % cmd)
+                raise
+            logger.optional("Command not found: %s" % cmd)
+        except sh.ErrorReturnCode_1 as error:
+            if required:
+                logger.required(f"Command failed: {cmd}")
+                logger.required(error.stderr.decode("utf-8").strip())
+                raise
+            logger.optional(f"Command failed: {cmd}")
+            logger.optional(error.stderr.decode("utf-8").strip())
+
+    print("✨ Your new project is ready to use! ✨")
+    return 0
+
+
+if __name__ == "__main__":
+    _logger_setup()
+    sys.exit(post_gen_project())