copier-project 0.28.0__py3-none-any.whl

copier_project/__init__.py

@@ -0,0 +1,9 @@
+"""Copier template for software projects with modern tooling."""
+
+from importlib.metadata import PackageNotFoundError
+from importlib.metadata import version as import_version
+
+try:
+    version = import_version(__name__)
+except PackageNotFoundError:  # pragma: no cover
+    version = "0.0.0"

copier_project/__main__.py

@@ -0,0 +1,145 @@
+from __future__ import annotations
+
+import os
+import shutil
+from dataclasses import dataclass
+from enum import Enum
+from typing import TYPE_CHECKING, Annotated
+
+from rich import print  # noqa: A004
+from rich.console import Console
+from rich.panel import Panel
+from rich.table import Table
+from rich.text import Text
+from typer import Argument, Context, Exit, Option, Typer
+
+from .repo import RepoTarget
+from .update import UpdateAction
+
+if TYPE_CHECKING:
+    from collections.abc import Sequence
+
+
+console = Console()
+
+
+class Args:
+    Repos = Annotated[
+        list[str],
+        Argument(
+            help=(
+                "Repositories to update. Accepts gh:user/repo"
+                " or github.com/user/repo."
+            )
+        ),
+    ]
+    DryRun = Annotated[
+        bool, Option("--dry-run", "-n", help="Skip push and PR creation.")
+    ]
+
+
+cli = Typer(
+    help="copier-project utilities",
+    add_completion=False,
+    no_args_is_help=True,
+    pretty_exceptions_enable=False,
+)
+
+
+@cli.callback()
+def setup(ctx: Context) -> None:
+    pass
+
+
+class UpdateStatus(Enum):
+    UPDATED = "bold green"
+    CURRENT = "bold blue"
+    FAILED = "bold red"
+
+    @property
+    def formatted_name(self) -> Text:
+        return Text(f"{self.name:<7}", style=self.value)
+
+
+@dataclass
+class UpdateResult:
+    repo: RepoTarget
+    status: UpdateStatus
+    exception: Exception | None = None
+    pr_url: str | None = None
+
+
+@cli.command()
+def update(
+    repos: Args.Repos,
+    *,
+    vcs_ref: Annotated[
+        str | None, Option("--vcs-ref", "-r", help="Template ref to update to")
+    ] = None,
+    dry_run: Args.DryRun = False,
+    branch: Annotated[str, Option(help="Branch name to create.")] = "updates",
+) -> None:
+    """Apply copier-project template updates to downstream repositories."""
+    results = []
+
+    repo_targets = {(target := RepoTarget(repo)).url: target for repo in repos}
+    for target in repo_targets.values():
+        try:
+            pr_url = UpdateAction(
+                target, branch=branch, vcs_ref=vcs_ref, dry_run=dry_run
+            )()
+            if pr_url:
+                results.append(
+                    UpdateResult(target, UpdateStatus.UPDATED, pr_url=pr_url)
+                )
+            else:
+                results.append(UpdateResult(target, UpdateStatus.CURRENT))
+        except Exception as exc:  # noqa: BLE001
+            console.print_exception()
+            results.append(
+                UpdateResult(target, status=UpdateStatus.FAILED, exception=exc)
+            )
+
+    _print_summary(results, dry_run=dry_run)
+    if any(r.status == UpdateStatus.FAILED for r in results):
+        raise Exit(1)
+
+
+def _print_summary(results: Sequence[UpdateResult], *, dry_run: bool) -> None:
+    if not results:
+        return
+    grid = Table.grid(padding=(0, 1), expand=True)
+    grid.add_column()
+    grid.add_column()
+    grid.add_column()
+    for result in sorted(results, key=lambda r: r.repo.github_repo):
+        grid.add_row(
+            result.status.formatted_name,
+            Text.from_markup(
+                f"[link={result.repo.url}]{result.repo.github_repo}[/link]",
+                style="bold",
+            ),
+            Text(str(result.pr_url or result.exception)),
+        )
+    title = Text("Update Results", style="bold")
+    if dry_run:
+        title += Text(" (dry run)", style="green")
+    print(
+        Panel(grid, title=title, title_align="left", expand=False, padding=1)
+    )
+
+
+def setup_env() -> None:
+    os.environ.pop("VIRTUAL_ENV", default=None)
+    os.environ["TERMINAL_WIDTH"] = str(
+        min(shutil.get_terminal_size().columns, 100)
+    )
+
+
+def main() -> None:
+    setup_env()
+    cli()
+
+
+if __name__ == "__main__":
+    main()

copier_project/repo.py

@@ -0,0 +1,176 @@
+from __future__ import annotations
+
+import os
+import re
+import subprocess
+import tempfile
+from contextlib import contextmanager, suppress
+from dataclasses import InitVar, dataclass, field
+from functools import cached_property
+from pathlib import Path
+from typing import TYPE_CHECKING, Any, ClassVar, Self
+
+import yaml
+from rich import print  # noqa: A004
+from rich.panel import Panel
+from rich.text import Text
+
+if TYPE_CHECKING:
+    from collections.abc import Generator, Sequence
+
+
+@dataclass(unsafe_hash=True)
+class RepoTarget:
+    arg: InitVar[str | Path]
+    github_repo: str = field(init=False)
+
+    _GITHUB_REGEXES: ClassVar[Sequence[str]] = [
+        r"(\.git)?/?$",
+        r"^gh\:",
+        r"^(https?://)?github.com/",
+        r"^((git\+)?ssh://)?([a-zA-Z0-9]+)@github.com:",
+    ]
+
+    def __post_init__(self, arg: str | Path) -> None:
+        arg = str(arg).strip()
+        if ((path := Path(arg)).is_dir()) and (root := self.repo_root(path)):
+            arg = root
+        for regex in self._GITHUB_REGEXES:
+            arg = re.sub(regex, "", arg)
+        if not re.fullmatch(r"[\w-]+\/[\w-]+", arg):
+            raise ValueError(arg)
+        self.github_repo = arg
+
+    def repo_root(self, path: Path) -> str | None:
+        with suppress(subprocess.CalledProcessError):
+            return subprocess.check_output(
+                ["git", "config", "--local", "remote.origin.url"],
+                text=True,
+                cwd=path,
+            ).strip()
+        return None
+
+    @cached_property
+    def name(self) -> str:
+        return self.github_repo.split("/")[-1]
+
+    @property
+    def url(self) -> str:
+        return f"https://github.com/{self.github_repo}"
+
+    @cached_property
+    def push_url(self) -> str:
+        return f"git@github.com:{self.github_repo}.git"
+
+
+@dataclass
+class RepoWorktree:
+    path: Path
+    repo: RepoTarget
+    branch: str
+
+    @classmethod
+    @contextmanager
+    def clone(
+        cls, repo: RepoTarget, branch: str
+    ) -> Generator[Self, None, None]:
+        with tempfile.TemporaryDirectory() as td:
+            repo_dir = Path(td) / "worktree"
+            cls.run_in(["git", "clone", repo.url, str(repo_dir)], repo=repo)
+            cls.run_in(
+                [
+                    *["git", "remote", "set-url", "--push", "origin"],
+                    repo.push_url,
+                ],
+                repo=repo,
+                cwd=repo_dir,
+            )
+            cls.run_in(
+                (
+                    ["mise", "install"]
+                    if (repo_dir / "mise.toml").is_file()
+                    else ["poe", "setup"]
+                ),
+                repo=repo,
+                cwd=repo_dir,
+            )
+            cls.run_in(
+                ["git", "checkout", "-b", branch], repo=repo, cwd=repo_dir
+            )
+            yield cls(path=repo_dir, repo=repo, branch=branch)
+
+    @classmethod
+    def run_in(
+        cls, cmd: list[str], *, repo: RepoTarget, **kwargs: Any
+    ) -> subprocess.CompletedProcess[str]:
+        kwargs.setdefault("check", True)
+        kwargs.setdefault("text", True)
+        cmd_text = Text(" ".join(cmd), style="color(153)")
+        txt = Text.assemble(
+            Text(f"{repo.github_repo} => ", style="bold"),
+            cmd_text,
+        )
+        print(Panel(txt, expand=False, border_style="white dim"))
+        return subprocess.run(cmd, **kwargs)  # noqa: S603 PLW1510
+
+    def run(
+        self, cmd: list[str], **kwargs: Any
+    ) -> subprocess.CompletedProcess[str]:
+        kwargs.setdefault("cwd", self.path)
+        return self.run_in(cmd, repo=self.repo, **kwargs)
+
+    def run_task(
+        self, name: str, **kwargs: Any
+    ) -> subprocess.CompletedProcess[str]:
+        task_runner = (
+            ["mise", "run"]
+            if (self.path / "mise.toml").is_file()
+            else ["uv", "run", "poe"]
+        )
+        return self.run([*task_runner, name], **kwargs)
+
+    def git_status(self) -> list[str]:
+        return self.run(
+            ["git", "status", "--porcelain"], capture_output=True
+        ).stdout.splitlines()
+
+    @staticmethod
+    def has_conflicts(status: list[str]) -> bool:
+        conflict_codes = {"UU", "AA", "DD", "AU", "UA", "DU", "UD"}
+        return any(line[:2] in conflict_codes for line in status)
+
+    @property
+    def template_ref(self) -> str:
+        return yaml.safe_load(  # type: ignore[no-any-return]
+            (self.path / ".copier-answers.yml").read_text()
+        ).get("_commit")
+
+    def shell(self) -> None:
+        self.run([os.environ.get("SHELL", "/bin/bash")])
+
+    def open_pr(self, title: str, body: str) -> str:
+        result = self.run(
+            [
+                "gh",
+                "pr",
+                "create",
+                "--title",
+                title,
+                "--body",
+                body,
+                "--head",
+                self.branch,
+            ],
+            capture_output=True,
+            check=False,
+        )
+        if result.returncode == 0:
+            return result.stdout.strip()
+        view = self.run(
+            ["gh", "pr", "view", "--json", "url", "--jq", ".url"],
+            capture_output=True,
+            check=False,
+        )
+        if view.returncode == 0:
+            return view.stdout.strip()
+        raise RuntimeError(f"gh pr create failed: {result.stderr.strip()}")

copier_project/update.py

@@ -0,0 +1,88 @@
+from __future__ import annotations
+
+import json
+import subprocess
+from contextlib import contextmanager
+from dataclasses import dataclass, field
+from typing import TYPE_CHECKING
+
+from .repo import RepoWorktree
+
+if TYPE_CHECKING:
+    from collections.abc import Generator
+
+    from .repo import RepoTarget
+
+TEMPLATE_REPO_URL = "https://github.com/smkent/copier-project"
+
+
+@dataclass
+class UpdateAction:
+    repo: RepoTarget
+    branch: str
+    vcs_ref: str | None = None
+    dry_run: bool = field(default=False, kw_only=True)
+
+    def __call__(self) -> str | None:
+        with RepoWorktree.clone(self.repo, branch=self.branch) as worktree:
+            return self._run(worktree)
+
+    @contextmanager
+    def _success_or_shell(
+        self, repo: RepoWorktree, name: str
+    ) -> Generator[None]:
+        try:
+            yield
+        except subprocess.CalledProcessError:
+            print(  # noqa: T201
+                f"{name} failed. Fix errors and exit the shell to continue."
+            )
+            repo.shell()
+
+    def _run(self, repo: RepoWorktree) -> str | None:
+        """Run copier update in the repo worktree."""
+        copier_status = json.loads(
+            repo.run(
+                ["copier", "check-update", "--output-format", "json"],
+                capture_output=True,
+            ).stdout.strip()
+        )
+        start_ref = "v" + copier_status["current_version"]
+        end_ref = self.vcs_ref or ("v" + copier_status["latest_version"])
+        if not copier_status.get("update_available", False):
+            return None
+        repo.run(["copier", "update", "--skip-answered", "--vcs-ref", end_ref])
+
+        status = repo.git_status()
+        if not status:
+            return None
+
+        if repo.has_conflicts(status):
+            print(  # noqa: T201
+                "Conflicts detected."
+                " Resolve them and exit the shell to continue."
+            )
+            repo.shell()
+            status = repo.git_status()
+            if repo.has_conflicts(status):
+                raise RuntimeError("Conflicts remain, aborting")
+
+        with self._success_or_shell(repo, "`mise install`"):
+            repo.run(["mise", "install"])
+        with self._success_or_shell(repo, "Lint/test"):
+            repo.run_task("lt")
+
+        title = f"Apply template updates from {start_ref} to {end_ref}"
+        body = ""
+        if start_ref and end_ref and start_ref != end_ref:
+            body = f"{TEMPLATE_REPO_URL}/compare/{start_ref}...{end_ref}"
+        repo.run(["git", "add", "-A"])
+        repo.run(["git", "commit", "-m", f"{title}\n\n{body}".strip()])
+
+        if self.dry_run:
+            return None
+
+        repo.run(
+            ["git", "push", "-u", "origin", repo.branch, "--force-with-lease"]
+        )
+        return repo.open_pr(title, body)

copier_project-0.28.0.dist-info/METADATA

@@ -0,0 +1,139 @@
+Metadata-Version: 2.5
+Name: copier-project
+Version: 0.28.0
+Summary: Copier template for software projects with modern tooling
+Project-URL: Homepage, https://smkent.github.io/copier-project
+Project-URL: Repository, https://github.com/smkent/copier-project
+Project-URL: Issues, https://github.com/smkent/copier-project/issues
+Author-email: Stephen Kent <smkent@smkent.net>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Topic :: Documentation
+Classifier: Topic :: Software Development
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: pyyaml>=6
+Requires-Dist: rich>=15
+Requires-Dist: typer>=0.9
+Requires-Dist: typing-extensions>=4.1; python_version < '3.12'
+Description-Content-Type: text/markdown
+
+# copier-project
+
+[Copier][copier] template for software projects with modern tooling
+
+[![Copier][copier-badge]][copier]
+[![License](https://img.shields.io/github/license/smkent/copier-project)](https://github.com/smkent/copier-project/blob/main/LICENSE)
+[![PyPI](https://img.shields.io/pypi/v/copier-project)](https://pypi.org/project/copier-project/)
+[![Python](https://img.shields.io/pypi/pyversions/copier-project)](https://pypi.org/project/copier-project/)
+[![GitHub stars](https://img.shields.io/github/stars/smkent/copier-project?style=social)](https://github.com/smkent/copier-project)
+
+## Quick start
+
+Install required software:
+
+- [**mise-en-place**][mise]: `curl https://mise.run | sh` or
+  [alternate installation method][mise-installation]
+- [**Copier**][copier]: `mise use -g copier` or `uv tool install copier`
+
+Create a new project from the template:
+
+```sh
+copier copy "gh:smkent/copier-project" /new/project/path
+```
+
+**[For more details, see the documentation!][docs-usage]**
+
+## Variants and features
+
+The **Generic** project variant is a language-agnostic project template with
+features common to all project variants:
+
+* [**mise-en-place**][mise] ("mise") for development toolchain management
+
+    [![mise][mise-badge]][mise]
+
+* [**prek**][prek] for [pre-commit][pre-commit] compatible git hooks, with
+  [**GitHub Actions**][github-actions] CI workflow
+
+    [![prek][prek-badge]][prek]
+
+* Contribution terms including selectable LLM use policy, with commit message
+  checks by [**commit-check**][commit-check]
+
+    [![commit-check][commit-check-badge]][commit-check]
+
+* Update automation with [**Renovate**][renovate] and
+  [**`copier update`**][copier-update]
+
+    [![Copier][copier-badge]][copier-update]
+    [![renovate][renovate-badge]][renovate]
+
+### Python
+
+The **Python** project variant adds Python-specific features:
+
+* [Astral][astral] toolset: [**uv**][uv], [**ruff**][ruff], and [**ty**][ty]
+
+    [![uv][uv-badge]][uv]
+    [![ruff][ruff-badge]][ruff]
+    [![ty][ty-badge]][ty]
+
+* [**PyPI package**][pypi] and [**container image**][ghcr-docs] release
+  automation via [**GitHub Actions**][github-actions]
+* [**pytest**][pytest] test framework with [**codecov.io**][codecovio] support
+* [**Zensical**][zensical] project documentation with automatic deployment to
+  [**GitHub Pages**][github-pages]
+
+## Credits
+
+This template was inspired by [pawamoy/copier-uv][copier-uv] and
+[ritwiktiwari/copier-astral][copier-astral] -- Thanks!
+
+## License
+
+Copyright (C) 2026 Stephen Kent and contributors
+
+Licensed under the MIT License
+([`MIT`](https://github.com/smkent/copier-project/blob/main/LICENSE)).
+
+[astral]: https://astral.sh
+[codecovio]: https://codecov.io
+[commit-check]: https://commit-check.com
+[commit-check-badge]: https://commit-check.com/badge.svg
+[copier-astral]: https://ritwiktiwari.github.io/copier-astral/
+[copier-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-purple.json
+[copier-update]: https://copier.readthedocs.io/en/stable/updating/
+[copier-uv]: https://pawamoy.github.io/copier-uv/
+[copier]: https://copier.readthedocs.io
+[docs-usage]: https://smkent.github.io/copier-project/requirements/
+[ghcr-docs]: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry
+[github-actions]: https://github.com/features/actions
+[github-pages]: https://pages.github.com
+[mise]: https://mise.jdx.dev
+[mise-installation]: https://mise.jdx.dev/installing-mise.html
+[mise-badge]: https://mise-versions.jdx.dev/badge.svg
+[pre-commit]: https://pre-commit.com/
+[prek-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/j178/prek/master/docs/assets/badge-v0.json
+[prek]: https://prek.j178.dev/
+[pypi]: https://pypi.org
+[pytest]: https://docs.pytest.org
+[renovate-badge]: https://img.shields.io/badge/renovate-enabled-brightgreen.svg?logo=renovatebot
+[renovate]: https://docs.renovatebot.com/
+[ruff-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+[ruff]: https://docs.astral.sh/ruff/
+[ty-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json
+[ty]: https://docs.astral.sh/ty/
+[uv-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json
+[uv]: https://docs.astral.sh/uv/
+[zensical]: https://zensical.org/

copier_project-0.28.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+copier_project/__init__.py,sha256=jRKv1l0yl90HBs3GkeINdWYF6kfAdq9ccfxaFl2lp7g,291
+copier_project/__main__.py,sha256=yilLgz6CIf9sOio4PR-GpPXIlU7vTA198tOUgBrgDRk,3713
+copier_project/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+copier_project/repo.py,sha256=SMnF0l1CQGPb2bAy9V8--6lvwVpfu8Jg_heYQN1IRWI,5351
+copier_project/update.py,sha256=ZKfwuKU14o3b0Souiozi_VUJEmD9SGMr8jwrYXEtxps,2805
+copier_project-0.28.0.dist-info/METADATA,sha256=Of1xWBbHqDHq7FYRsD6oOt5PiNrUa79Nsmu2h95uw0E,5707
+copier_project-0.28.0.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
+copier_project-0.28.0.dist-info/entry_points.txt,sha256=CrIFWRD5L4OXhmtXuUmUeVB42d_Pteh3P-an4PjU6go,64
+copier_project-0.28.0.dist-info/licenses/LICENSE,sha256=lwNXeTMjiyUh8CtIKWnb2SOTeliVKCJfs_NZB6P23BE,1086
+copier_project-0.28.0.dist-info/RECORD,,

copier_project-0.28.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.33.0
+Root-Is-Purelib: true
+Tag: py3-none-any

copier_project-0.28.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+copier-project = copier_project.__main__:main

copier_project-0.28.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Stephen Kent and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.