copier-project 0.28.0__tar.gz

copier_project-0.28.0/.gitignore

@@ -0,0 +1,23 @@
+# Python
+__pycache__/
+*.egg-info/
+*.py[cod]
+
+# uv and packaging
+.venv*/
+/build/
+/dist/
+uv.lock
+
+# mise
+mise.local.toml
+.mise.local.toml
+
+# Development tools
+.cache/
+.coverage*
+.pytest_cache/
+.ruff_cache/
+/htmlcov/
+/site/
+coverage.xml

copier_project-0.28.0/AGENTS.md

@@ -0,0 +1,30 @@
+# Environment/Tools
+
+* `mise` manages dev tools and tasks, including `uv` which manages Python and dependencies.
+* Use `uv add`/`uv run python` instead of bare `pip`/`python`
+* `mise install`: After-clone setup (install tools, dependencies, pre-commit hooks)
+* `mise run lint`: Pre-commit hooks (via `pre-commit`-compatible `prek`) including lint, format, type check (ruff, ty)
+* `mise run test`: Run tests (accepts pytest arguments)
+* `mise run lt`: Lint+test (no arguments)
+* `mise run snapup`: Update test snapshots (syrupy, accepts pytest arguments)
+
+# Commit conventions
+
+* Keep commit messages concise and in plain language, so a maintainer can
+  quickly understand the change. Use a short subject, and add a body only when
+  the change needs explaining, in a few lines about why. Don't list changed
+  files, restate the diff, or report test results.
+* If a commit contains code or text largely generated by an LLM, add an
+  `Assisted-by: <tool>:<model>` trailer, for example with `git commit --trailer`.
+* Don't add `Co-authored-by` or `Signed-off-by` lines for LLM tools, links to
+  LLM sessions, or promotional lines such as "Generated with [...]".
+
+# Submitting contributions
+
+* You may commit locally without asking. Before submitting anything, such as
+  pushing commits or creating or editing a pull request, issue, or comment,
+  show the user (who is the contributor) exactly what will be submitted, and
+  wait for their explicit approval. Submit it as approved. This includes but is
+  not limited to commit messages, titles, and bodies.
+* Keep titles and descriptions short and specific. Don't restate what the diff
+  already shows.

copier_project-0.28.0/CONTRIBUTING.md

@@ -0,0 +1,39 @@
+# Contributing to copier-project
+
+**Contributions are welcome!**
+
+Thank you for your time and interest in improving
+**copier-project**!
+
+## Contribution resources
+
+* **Web site**: **<https://smkent.github.io/copier-project>**
+  for general project information, usage, and development documentation
+* **Repository**: <https://github.com/smkent/copier-project>
+  for submitting pull requests
+* **Issue tracker**: <https://github.com/smkent/copier-project/issues>
+  for questions or bug reports
+
+## Contribution terms
+
+By submitting a contribution to copier-project, you agree that it is
+licensed under the project's license, the
+[MIT License](https://github.com/smkent/copier-project/blob/main/LICENSE),
+with no additional terms,
+and that you have the right to submit it under that license.
+
+## LLM use
+
+A contributor is always the author of their contributions.
+You must read, review, and understand everything you submit, including
+LLM-generated code or text, and be able to explain it on request.
+Contributions must be submitted by a person, not autonomously by a bot or
+LLM agent.
+
+If a commit contains code or text largely generated by an LLM, add an
+`Assisted-by: <tool>:<model>` trailer to its message. This can be done
+automatically with `git commit --trailer="Assisted-by: <tool>:<model>"`.
+
+Do not use `Co-authored-by:` for LLM attribution. LLMs are tools, not authors.
+Do not include LLM session URLs, or promotional lines such as
+"Generated with [...]."

copier_project-0.28.0/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.

copier_project-0.28.0/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,109 @@
+# 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/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-0.28.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()