python-package-copier-template 0.4.3__py3-none-any.whl → 0.6.0__py3-none-any.whl

python_package_copier_template/__init__.py

@@ -1,3 +1,5 @@
+"""Public package interface."""
+
 from .cli import main
 
 __all__ = ["main"]

python_package_copier_template/cli.py

@@ -1,6 +1,9 @@
+"""Command-line wrapper for copying and updating projects."""
+
 import argparse
 import json
 import os
+import shutil
 import subprocess
 from dataclasses import dataclass
 from importlib.metadata import PackageNotFoundError, distribution, version
@@ -17,11 +20,14 @@ ANSWER_FILES: tuple[str, ...] = (".copier-answers.yml", ".copier-answers.yaml")
 
 @dataclass(frozen=True)
 class TemplateTarget:
+    """Template source and optional version control reference."""
+
     src_path: str
     vcs_ref: str | None = None
 
 
 def get_version() -> str:
+    """Return the installed package version."""
     try:
         return version("python-package-copier-template")
     except PackageNotFoundError:
@@ -29,13 +35,18 @@ def get_version() -> str:
 
 
 def has_answers(dst: Path) -> bool:
+    """Return whether a destination contains Copier answers."""
     return any((dst / filename).exists() for filename in ANSWER_FILES)
 
 
 def get_local_git_head(path: str) -> str | None:
+    """Return the current commit for a local Git repository."""
+    if not (git := shutil.which("git")):
+        return None
+
     try:
-        result = subprocess.run(
-            ["git", "-C", path, "rev-parse", "HEAD"],
+        result = subprocess.run(  # noqa: S603 - arguments are passed without a shell
+            [git, "-C", path, "rev-parse", "HEAD"],
             check=True,
             capture_output=True,
             text=True,
@@ -47,6 +58,7 @@ def get_local_git_head(path: str) -> str | None:
 
 
 def resolve_template_target() -> TemplateTarget:
+    """Resolve the template source matching the installed package."""
     try:
         dist = distribution("python-package-copier-template")
     except PackageNotFoundError:
@@ -72,6 +84,7 @@ def resolve_template_target() -> TemplateTarget:
 
 
 def build_parser() -> argparse.ArgumentParser:
+    """Build the package command-line parser."""
     parser = argparse.ArgumentParser(
         prog="python-package-copier-template",
         description=(
@@ -89,6 +102,7 @@ def build_parser() -> argparse.ArgumentParser:
 
 
 def main(argv: list[str] | None = None) -> int:
+    """Copy or update a project based on its Copier answers file."""
     parser = build_parser()
     args = parser.parse_args(argv)
 

python_package_copier_template/extensions.py

@@ -1,23 +1,41 @@
+"""Jinja extensions and filters used while rendering the template."""
+
+import platform
 import re
 import shutil
 import subprocess
+import sys
 import unicodedata
 import urllib.error
 import urllib.request
+from collections.abc import Iterator
 from contextlib import contextmanager
 from contextvars import ContextVar
-from datetime import date
+from datetime import UTC, datetime
 from pathlib import Path
+from typing import cast
 
+from jinja2 import Environment
 from jinja2.ext import Extension
 
 _UPDATE_MODE: ContextVar[bool] = ContextVar("copier_template_update_mode", default=False)
+MAX_PYPI_SUFFIX = 50
+MIN_PROJECT_PYTHON = (3, 12)
+
+
+class UnsupportedPythonError(RuntimeError):
+    """Raised when Copier runs below the generated project's Python minimum."""
+
+    def __init__(self, minimum: str, running: str) -> None:
+        """Describe the required and running Python versions."""
+        super().__init__(
+            f"Python {minimum} or newer is required to generate a project; Copier is running on Python {running}."
+        )
 
 
 @contextmanager
-def update_mode():
+def update_mode() -> Iterator[None]:
     """Mark the current execution context as an update operation."""
-
     token = _UPDATE_MODE.set(True)
     try:
         yield
@@ -26,19 +44,40 @@ def update_mode():
 
 
 def git_user_name(default: str) -> str:
-    return subprocess.getoutput("git config user.name").strip() or default
+    """Return the configured Git author name or a fallback."""
+    return _git_config_value("user.name", default)
 
 
 def git_user_email(default: str) -> str:
-    return subprocess.getoutput("git config user.email").strip() or default
+    """Return the configured Git author email or a fallback."""
+    return _git_config_value("user.email", default)
+
+
+def _git_config_value(key: str, default: str) -> str:
+    if not (git := shutil.which("git")):
+        return default
+
+    try:
+        completed = subprocess.run(  # noqa: S603 - arguments are passed without a shell
+            [git, "config", key],
+            check=True,
+            capture_output=True,
+            text=True,
+        )
+    except subprocess.CalledProcessError:
+        return default
+
+    return completed.stdout.strip() or default
 
 
 def gh_user_login(default: str) -> str:
     """Return the authenticated GitHub username via the GH CLI when available."""
+    if not (gh := shutil.which("gh")):
+        return default
 
     try:
-        completed = subprocess.run(
-            ["gh", "api", "user", "-q", ".login"],
+        completed = subprocess.run(  # noqa: S603 - arguments are passed without a shell
+            [gh, "api", "user", "-q", ".login"],
             check=True,
             capture_output=True,
             text=True,
@@ -46,7 +85,7 @@ def gh_user_login(default: str) -> str:
         login = completed.stdout.strip()
         if login:
             return login
-    except (FileNotFoundError, subprocess.CalledProcessError):
+    except subprocess.CalledProcessError:
         return default
 
     return default
@@ -54,11 +93,11 @@ def gh_user_login(default: str) -> str:
 
 def command_available(command: str) -> bool:
     """Return True if the command exists on PATH."""
-
     return shutil.which(command) is not None
 
 
-def slugify(value, separator="-"):
+def slugify(value: object, separator: str = "-") -> str:
+    """Normalize a value for use in package and repository names."""
     value = unicodedata.normalize("NFKD", str(value)).encode("ascii", "ignore").decode("ascii")
     value = re.sub(r"[^\w\s-]", "", value.lower())
     return re.sub(r"[-_\s]+", separator, value).strip("-_")
@@ -66,13 +105,11 @@ def slugify(value, separator="-"):
 
 def path_exists(path: str) -> bool:
     """Return True when ``path`` exists relative to the destination."""
-
     return Path(path).expanduser().exists()
 
 
-def is_update(defaults: bool | None = None) -> bool:
+def is_update(defaults: bool | None = None) -> bool:  # noqa: FBT001 - Jinja filters receive positional values
     """Return True when running under `copier update`."""
-
     return bool(defaults)
 
 
@@ -82,7 +119,6 @@ def pypi_distribution_exists(name: str) -> bool:
     Uses the lightweight JSON endpoint and handles network failures gracefully
     by treating them as "not found" so template execution is not blocked.
     """
-
     # During updates we keep the previously selected distribution name and
     # should not block on global PyPI availability checks.
     if _UPDATE_MODE.get():
@@ -94,7 +130,7 @@ def pypi_distribution_exists(name: str) -> bool:
     url = f"https://pypi.org/pypi/{name}/json"
     request = urllib.request.Request(url, method="HEAD")
     try:
-        with urllib.request.urlopen(request, timeout=3):
+        with urllib.request.urlopen(request, timeout=3):  # noqa: S310 - request URL is restricted above
             return True
     except (urllib.error.HTTPError, OSError):
         return False
@@ -102,21 +138,23 @@ def pypi_distribution_exists(name: str) -> bool:
 
 def suggest_pypi_distribution_name(name: str) -> str:
     """Return a PyPI-safe distribution name, adding a suffix if needed."""
-
     base = slugify(name)
     if not base:
         base = "package"
 
     candidate = base
-    suffix = 1
-    while pypi_distribution_exists(candidate) and suffix < 50:
+    for suffix in range(1, MAX_PYPI_SUFFIX + 1):
+        if not pypi_distribution_exists(candidate):
+            return candidate
         candidate = f"{base}-{suffix}"
-        suffix += 1
     return candidate
 
 
 class GitExtension(Extension):
-    def __init__(self, environment):
+    """Register Git, GitHub, command, and path filters."""
+
+    def __init__(self, environment: Environment) -> None:
+        """Register filters in a Jinja environment."""
         super().__init__(environment)
         environment.filters["git_user_name"] = git_user_name
         environment.filters["git_user_email"] = git_user_email
@@ -127,7 +165,10 @@ class GitExtension(Extension):
 
 
 class SlugifyExtension(Extension):
-    def __init__(self, environment):
+    """Register slug and PyPI name filters."""
+
+    def __init__(self, environment: Environment) -> None:
+        """Register filters in a Jinja environment."""
         super().__init__(environment)
         environment.filters["slugify"] = slugify
         environment.filters["pypi_exists"] = pypi_distribution_exists
@@ -135,6 +176,22 @@ class SlugifyExtension(Extension):
 
 
 class CurrentYearExtension(Extension):
-    def __init__(self, environment):
+    """Expose the current UTC year to templates."""
+
+    def __init__(self, environment: Environment) -> None:
+        """Register the current year in a Jinja environment."""
+        super().__init__(environment)
+        cast("dict[str, object]", environment.globals)["current_year"] = datetime.now(tz=UTC).year
+
+
+class PythonVersionExtension(Extension):
+    """Expose the running Python version to templates."""
+
+    def __init__(self, environment: Environment) -> None:
+        """Register the running Python version in a Jinja environment."""
         super().__init__(environment)
-        environment.globals["current_year"] = date.today().year
+        running_python = (sys.version_info.major, sys.version_info.minor)
+        if running_python < MIN_PROJECT_PYTHON:
+            minimum = ".".join(str(part) for part in MIN_PROJECT_PYTHON)
+            raise UnsupportedPythonError(minimum, platform.python_version())
+        cast("dict[str, object]", environment.globals)["python_version"] = platform.python_version()

{python_package_copier_template-0.4.3.dist-info → python_package_copier_template-0.6.0.dist-info}/METADATA

@@ -1,12 +1,11 @@
 Metadata-Version: 2.3
 Name: python-package-copier-template
-Version: 0.4.3
+Version: 0.6.0
 Summary: A Copier template for modern Python projects.
 Author: Martín Gaitán
 Author-email: Martín Gaitán <gaitan@gmail.com>
-Requires-Dist: copier>=9.11.0
+Requires-Dist: copier>=9.17.0
 Requires-Dist: copier-templates-extensions>=0.3.2
-Requires-Dist: ruff>=0.14.9
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 
@@ -14,18 +13,22 @@ Description-Content-Type: text/markdown
 
 [![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-purple.json)](https://github.com/copier-org/copier)
 [![CI](https://github.com/mgaitan/python-package-copier-template/actions/workflows/ci.yml/badge.svg)](https://github.com/mgaitan/python-package-copier-template/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/python-package-copier-template)](https://pypi.org/project/python-package-copier-template/)
 [![Changelog](https://img.shields.io/github/v/release/mgaitan/python-package-copier-template)](https://github.com/mgaitan/python-package-copier-template/releases)
 
 A [Copier](https://github.com/copier-org/copier) template
 for modern Python projects. 
 
-Demo repo generated from this template: [mgaitan/yet-another-demo](https://github.com/mgaitan/yet-another-demo)
+Canonical example repo generated from this template: [mgaitan/yet-another-demo](https://github.com/mgaitan/yet-another-demo)
+
+Documentation: <https://mgaitan.github.io/python-package-copier-template/>
 
 ## Features
 
 - 🐍 Modern Python package (3.12+)
 - 📦 Build and dependency management with [uv](https://docs.astral.sh/uv/), split by groups (dev/qa/docs)
 - 🧊 Dependency cooldowns enabled by default in `uv` (`[tool.uv].exclude-newer = "1 week"`), with targeted overrides when needed (for example `ty`) to reduce supply-chain risk without blocking QA tools
+- 🛡️ uv malware checks enabled in Make targets and GitHub Actions to reject locked dependencies with known malicious-package advisories
 - 🧹 Linting and formatting via [Ruff](https://docs.astral.sh/ruff/) with a broad set of rules enabled
 - ✅ Type checking via [ty](https://github.com/astral-sh/ty)
 - 🪝 Optional pre-commit style QA orchestration via [prek](https://github.com/j178/prek) as an external tool (`uv tool install prek`; hooks include `check-ast`, `check-yaml`, `check-toml`, Ruff, Ty)
@@ -38,23 +41,17 @@ Demo repo generated from this template: [mgaitan/yet-another-demo](https://githu
 - 🚀 Automated releases to PyPI via [Trusted Publishing](https://docs.pypi.org/trusted-publishers/creating-a-project-through-oidc/)
 - 🧠 Sensible defaults via introspection to minimize answers during the initial setup
 - 🛠️ Makefile with shortcuts for common tasks
-- 📄 Generation of generic docs such as `LICENSE`, `CODE_OF_CONDUCT`, etc.
+- 📄 Generation of generic docs such as `CODE_OF_CONDUCT`, plus an optional `LICENSE`
 - 🤖 Heavily curated [AGENTS.md](https://agents.md/)
 - 🌀 Initial setup of the development environment and git repo
 - 🔁 Scheduled template refresh workflow that opens a PR every 20 days when updates are available
 - ♻️ Projects updatable with [`copier update`](https://copier.readthedocs.io/en/stable/updating/)
 
-Please read [my blog post](https://mgaitan.github.io/en/posts/opinionated-python-project-scaffolding/) to learn about the details of the decisions I made and the alternatives I considered.
-
-## Package Documentation
+> [!NOTE]
+> Sister project for Django internal management systems:
+> [mgaitan/django-unfold-copier-template](https://github.com/mgaitan/django-unfold-copier-template).
 
-The package now includes a Diataxis-based docs set under `docs/` that expands this README:
-
-- [Tutorial: Getting started](docs/getting_started.md)
-- [How-to: Maintain the template](docs/maintain_template.md)
-- [Reference: Configuration](docs/configuration.md)
-- [Explanation: About these docs](docs/about_the_docs.md)
-- [Explanation: Design decisions](docs/design_decisions.md)
+Please read [my blog post](https://mgaitan.github.io/en/posts/opinionated-python-project-scaffolding/) to learn about the details of the decisions I made and the alternatives I considered.
 
 ## Quick setup and usage
 
@@ -88,7 +85,11 @@ To upgrade an existing project created from this template to the latest version,
 uvx --with=copier-template-extensions copier update . --trust 
 ```
 
-This will fetch the latest template version and guide you through updating your project, preserving your customizations whenever possible.
+This fetches the latest template version and guides you through updating your project.
+Existing `README.md` and `docs/**` files are left untouched so project-specific
+documentation is not replaced. New documentation files are still added when the
+template introduces them; adopt later changes to existing pages manually from the
+template diff when they are relevant to your project.
 
 The generated project also ships a `Template Update` GitHub Actions workflow that runs every 20 days (or on manual dispatch) to execute `uvx copier update --trust --defaults .` and open a pull request with the changes and template version bump.
 
@@ -99,7 +100,11 @@ uv sync
 uv run copier copy --trust  --vcs-ref=HEAD . /path/to/your/test/project
 ```
 
-If you create the GitHub repository via the `gh` CLI prompt, the template will attempt to enable GitHub Pages (using the Actions build type) so documentation deployments succeed. If Pages is unavailable (for example, with some private repositories or account policies), the docs workflow will keep failing until Pages is allowed.
+If you create the GitHub repository via the `gh` CLI prompt, the template will
+attempt to enable immutable releases and GitHub Pages (using the Actions build
+type). Immutability protects assets and tags for future releases. If Pages is
+unavailable (for example, with some private repositories or account policies),
+the docs workflow will keep failing until Pages is allowed.
 
 
 To publish a release of your project to PyPI, you need to [register the project with trusted publishing](https://docs.pypi.org/trusted-publishers/creating-a-project-through-oidc/). Read more about how this workflow works [here](https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/).

python_package_copier_template-0.6.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+python_package_copier_template/__init__.py,sha256=OinvQVj2ZByb1RmK5MQiILujuV2mELHY_A_e_FsAN-Q,75
+python_package_copier_template/cli.py,sha256=p9cpaajf4MS_2UnNf3iKRcyvoZoS-a7oumRxh3UNMqY,4144
+python_package_copier_template/extensions.py,sha256=ffCU_Xe7VDCf9fMFmjSCYWyxJq2SVsdkQL6p82emV4I,6696
+python_package_copier_template-0.6.0.dist-info/WHEEL,sha256=l3MmIxu8qaet7ng2J9fFoJnYGj8IREj7jXTbgsuzmy4,81
+python_package_copier_template-0.6.0.dist-info/entry_points.txt,sha256=lCOiBcuDIsrwQCy6P_6xfD47lOp_ES7WcLfh95QxmAo,92
+python_package_copier_template-0.6.0.dist-info/METADATA,sha256=YYJ2t9SuT_O7AoiMRO0Lz0SuZ0-DnBCaae1uML2RwDc,7252
+python_package_copier_template-0.6.0.dist-info/RECORD,,

{python_package_copier_template-0.4.3.dist-info → python_package_copier_template-0.6.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: uv 0.11.3
+Generator: uv 0.11.32
 Root-Is-Purelib: true
 Tag: py3-none-any

python_package_copier_template-0.4.3.dist-info/RECORD

@@ -1,7 +0,0 @@
-python_package_copier_template/__init__.py,sha256=oKsCpoiQSSXx57DGs2VfYzeO1ukJQxdGnV-2hC3BI0M,42
-python_package_copier_template/cli.py,sha256=S5IWoX4G0vUD4kXkG9bATI0-D_hslLrmrhRj1l3DWHc,3523
-python_package_copier_template/extensions.py,sha256=Or7j8l44CaiKiWZaA01n0rhOC14YqmW0F6NgmGr7eXw,4098
-python_package_copier_template-0.4.3.dist-info/WHEEL,sha256=bEhYrD-rjlF0iRRHiAnfJ0mEjMsRwm29hhDD7yRgWCY,80
-python_package_copier_template-0.4.3.dist-info/entry_points.txt,sha256=lCOiBcuDIsrwQCy6P_6xfD47lOp_ES7WcLfh95QxmAo,92
-python_package_copier_template-0.4.3.dist-info/METADATA,sha256=3hCr7teo_OMZb7Q347v495i1SIyXfMPmu4VEfdCCfhc,6856
-python_package_copier_template-0.4.3.dist-info/RECORD,,