copier-python 0.17.1__tar.gz → 0.19.0__tar.gz

{copier_python-0.17.1 → copier_python-0.19.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: copier-python
-Version: 0.17.1
+Version: 0.19.0
 Summary: Copier template for Python projects with modern tooling
 Project-URL: Homepage, https://smkent.github.io/copier-python
 Project-URL: Repository, https://github.com/smkent/copier-python

{copier_python-0.17.1 → copier_python-0.19.0}/copier_python/update.py

@@ -11,6 +11,8 @@ from .repo import RepoWorktree
 if TYPE_CHECKING:
     from .repo import RepoTarget
 
+TEMPLATE_REPO_URL = "https://github.com/smkent/copier-python"
+
 
 @dataclass
 class UpdateAction:
@@ -65,7 +67,7 @@ class UpdateAction:
             body = os.linesep.join(
                 (
                     f"Applied updates from template: {ref_range}",
-                    f"{repo.repo.url}/compare/{ref_range}",
+                    f"{TEMPLATE_REPO_URL}/compare/{ref_range}",
                 )
             )
         repo.run(["git", "add", "-A"])

copier_python-0.19.0/tests/template/__snapshots__/test_contributing.ambr

@@ -0,0 +1,506 @@
+# serializer version: 1
+# name: test_contributing_features[docs]
+  '''
+  # Contributing to PKFire
+  
+  **Contributions are welcome!**
+  
+  Thank you for your time and interest in improving
+  **PKFire**!
+  
+  ## Project resources
+  
+  * **Web site**: **<https://ness.github.io/PKFire>**
+    for general project information, usage, and development documentation
+  * **Repository**: <https://github.com/ness/PKFire>
+    for submitting pull requests
+  * **Issue tracker**: <https://github.com/ness/PKFire/issues>
+    for questions or bug reports
+  
+  ## Contribution terms
+  
+  By submitting a contribution to PKFire, you agree that it is
+  licensed under the project's license, the
+  [MIT License](https://github.com/ness/PKFire/blob/main/LICENSE),
+  with no additional terms,
+  and that you have the right to submit it under that license.
+  
+  '''
+# ---
+# name: test_contributing_features[no_docs]
+  '''
+  # Contributing to PKFire
+  
+  **Contributions are welcome!**
+  
+  Thank you for your time and interest in improving
+  **PKFire**!
+  
+  ## Project resources
+  
+  * **Repository**: <https://github.com/ness/PKFire>
+    for submitting pull requests
+  * **Issue tracker**: <https://github.com/ness/PKFire/issues>
+    for questions or bug reports
+  
+  ## Contribution terms
+  
+  By submitting a contribution to PKFire, you agree that it is
+  licensed under the project's license, the
+  [MIT License](https://github.com/ness/PKFire/blob/main/LICENSE),
+  with no additional terms,
+  and that you have the right to submit it under that license.
+  
+  ## Development documentation
+  
+  ### Prerequisites
+  
+  - [x] [**git** for version control][git]
+  - [x] [**mise**][mise] tool manager: `curl https://mise.run | sh` or
+    [alternate installation method][mise-installation]
+  
+      !!! info
+  
+          `mise` ensures additional software is available, such as:
+  
+          * A [supported version][python-versions] of [**Python**][python]
+          * [Astral's **uv** Python project manager][uv]
+  
+  [git]: https://git-scm.com
+  [mise-installation]: https://mise.jdx.dev/installing-mise.html
+  [mise]: https://mise.jdx.dev
+  [python-versions]: https://devguide.python.org/versions/
+  [python]: https://python.org
+  [uv]: https://docs.astral.sh/uv/
+  
+  ### Project development workflow
+  
+  #### Cloning the repository
+  
+  ```sh
+  git clone https://github.com/ness/PKFire
+  cd PKFire
+  ```
+  
+  Run `mise install` in new repository clones to install tools, dependencies, and
+  git hooks:
+  
+  ```sh
+  mise install
+  ```
+  
+  #### Development tools
+  
+  * `mise run lint`: Run formatters and static checks
+  * `mise run test`: Run tests
+  
+  The `lint` and `test` tasks can also be run as a single combined command with:
+  
+  ```sh
+  mise run lt
+  ```
+  
+  ### Test snapshots
+  
+  Some tests compare test results with saved snapshots. Test snapshots can be
+  updated by running:
+  
+  ```sh
+  mise run snapup
+  ```
+  
+  ### Applying copier-python template updates
+  
+  Copier can update your project with template changes that have occurred since
+  the project was created.
+  
+  To apply updates, simply run in your project directory:
+  
+  ```sh
+  copier update
+  ```
+  
+  This will repeat the setup prompts, in case any prompts have been added or
+  changed.
+  
+  !!! tip
+      To change template-provided features in your project, simply change your
+      answers in the update prompts.
+  
+  To apply updates without being prompted (reusing all previous answers), run:
+  
+  ```sh
+  copier update -l
+  ```
+  
+  When [`copier update`][copier-update] is finished, view changes with
+  `git status` and `git diff`. Resolve any conflicts, and then commit the result.
+  
+  [copier-update]: https://copier.readthedocs.io/en/stable/updating/
+  
+  '''
+# ---
+# name: test_contributing_license[AGPL-3.0-only]
+  '''
+  # Contributing to PKFire
+  
+  **Contributions are welcome!**
+  
+  Thank you for your time and interest in improving
+  **PKFire**!
+  
+  ## Project resources
+  
+  * **Web site**: **<https://ness.github.io/PKFire>**
+    for general project information, usage, and development documentation
+  * **Repository**: <https://github.com/ness/PKFire>
+    for submitting pull requests
+  * **Issue tracker**: <https://github.com/ness/PKFire/issues>
+    for questions or bug reports
+  
+  ## Contribution terms
+  
+  By submitting a contribution to PKFire, you agree that it is
+  licensed under the project's license, the
+  [GNU Affero General Public License v3.0 only](https://github.com/ness/PKFire/blob/main/COPYING),
+  with no additional terms,
+  and that you have the right to submit it under that license.
+  
+  '''
+# ---
+# name: test_contributing_license[AGPL-3.0-or-later]
+  '''
+  # Contributing to PKFire
+  
+  **Contributions are welcome!**
+  
+  Thank you for your time and interest in improving
+  **PKFire**!
+  
+  ## Project resources
+  
+  * **Web site**: **<https://ness.github.io/PKFire>**
+    for general project information, usage, and development documentation
+  * **Repository**: <https://github.com/ness/PKFire>
+    for submitting pull requests
+  * **Issue tracker**: <https://github.com/ness/PKFire/issues>
+    for questions or bug reports
+  
+  ## Contribution terms
+  
+  By submitting a contribution to PKFire, you agree that it is
+  licensed under the project's license, the
+  [GNU Affero General Public License v3.0 or later](https://github.com/ness/PKFire/blob/main/COPYING),
+  with no additional terms,
+  and that you have the right to submit it under that license.
+  
+  '''
+# ---
+# name: test_contributing_license[Apache-2.0]
+  '''
+  # Contributing to PKFire
+  
+  **Contributions are welcome!**
+  
+  Thank you for your time and interest in improving
+  **PKFire**!
+  
+  ## Project resources
+  
+  * **Web site**: **<https://ness.github.io/PKFire>**
+    for general project information, usage, and development documentation
+  * **Repository**: <https://github.com/ness/PKFire>
+    for submitting pull requests
+  * **Issue tracker**: <https://github.com/ness/PKFire/issues>
+    for questions or bug reports
+  
+  ## Contribution terms
+  
+  By submitting a contribution to PKFire, you agree that it is
+  licensed under the project's license, the
+  [Apache License 2.0](https://github.com/ness/PKFire/blob/main/LICENSE),
+  with no additional terms,
+  and that you have the right to submit it under that license.
+  
+  '''
+# ---
+# name: test_contributing_license[BSD-3-Clause]
+  '''
+  # Contributing to PKFire
+  
+  **Contributions are welcome!**
+  
+  Thank you for your time and interest in improving
+  **PKFire**!
+  
+  ## Project resources
+  
+  * **Web site**: **<https://ness.github.io/PKFire>**
+    for general project information, usage, and development documentation
+  * **Repository**: <https://github.com/ness/PKFire>
+    for submitting pull requests
+  * **Issue tracker**: <https://github.com/ness/PKFire/issues>
+    for questions or bug reports
+  
+  ## Contribution terms
+  
+  By submitting a contribution to PKFire, you agree that it is
+  licensed under the project's license, the
+  [BSD 3-Clause "New" or "Revised" License](https://github.com/ness/PKFire/blob/main/LICENSE),
+  with no additional terms,
+  and that you have the right to submit it under that license.
+  
+  '''
+# ---
+# name: test_contributing_license[CC-BY-4.0]
+  '''
+  # Contributing to PKFire
+  
+  **Contributions are welcome!**
+  
+  Thank you for your time and interest in improving
+  **PKFire**!
+  
+  ## Project resources
+  
+  * **Web site**: **<https://ness.github.io/PKFire>**
+    for general project information, usage, and development documentation
+  * **Repository**: <https://github.com/ness/PKFire>
+    for submitting pull requests
+  * **Issue tracker**: <https://github.com/ness/PKFire/issues>
+    for questions or bug reports
+  
+  ## Contribution terms
+  
+  By submitting a contribution to PKFire, you agree that it is
+  licensed under the project's license, the
+  [Creative Commons Attribution 4.0 International](https://github.com/ness/PKFire/blob/main/LICENSE),
+  with no additional terms,
+  and that you have the right to submit it under that license.
+  
+  '''
+# ---
+# name: test_contributing_license[CC-BY-SA-4.0]
+  '''
+  # Contributing to PKFire
+  
+  **Contributions are welcome!**
+  
+  Thank you for your time and interest in improving
+  **PKFire**!
+  
+  ## Project resources
+  
+  * **Web site**: **<https://ness.github.io/PKFire>**
+    for general project information, usage, and development documentation
+  * **Repository**: <https://github.com/ness/PKFire>
+    for submitting pull requests
+  * **Issue tracker**: <https://github.com/ness/PKFire/issues>
+    for questions or bug reports
+  
+  ## Contribution terms
+  
+  By submitting a contribution to PKFire, you agree that it is
+  licensed under the project's license, the
+  [Creative Commons Attribution Share Alike 4.0 International](https://github.com/ness/PKFire/blob/main/LICENSE),
+  with no additional terms,
+  and that you have the right to submit it under that license.
+  
+  '''
+# ---
+# name: test_contributing_license[CC0-1.0]
+  '''
+  # Contributing to PKFire
+  
+  **Contributions are welcome!**
+  
+  Thank you for your time and interest in improving
+  **PKFire**!
+  
+  ## Project resources
+  
+  * **Web site**: **<https://ness.github.io/PKFire>**
+    for general project information, usage, and development documentation
+  * **Repository**: <https://github.com/ness/PKFire>
+    for submitting pull requests
+  * **Issue tracker**: <https://github.com/ness/PKFire/issues>
+    for questions or bug reports
+  
+  ## Contribution terms
+  
+  By submitting a contribution to PKFire, you agree that it is
+  dedicated to the public domain under
+  [Creative Commons Zero v1.0 Universal](https://github.com/ness/PKFire/blob/main/LICENSE),
+  with no additional terms,
+  and that you have the right to do so.
+  
+  '''
+# ---
+# name: test_contributing_license[GPL-3.0-only]
+  '''
+  # Contributing to PKFire
+  
+  **Contributions are welcome!**
+  
+  Thank you for your time and interest in improving
+  **PKFire**!
+  
+  ## Project resources
+  
+  * **Web site**: **<https://ness.github.io/PKFire>**
+    for general project information, usage, and development documentation
+  * **Repository**: <https://github.com/ness/PKFire>
+    for submitting pull requests
+  * **Issue tracker**: <https://github.com/ness/PKFire/issues>
+    for questions or bug reports
+  
+  ## Contribution terms
+  
+  By submitting a contribution to PKFire, you agree that it is
+  licensed under the project's license, the
+  [GNU General Public License v3.0 only](https://github.com/ness/PKFire/blob/main/COPYING),
+  with no additional terms,
+  and that you have the right to submit it under that license.
+  
+  '''
+# ---
+# name: test_contributing_license[GPL-3.0-or-later]
+  '''
+  # Contributing to PKFire
+  
+  **Contributions are welcome!**
+  
+  Thank you for your time and interest in improving
+  **PKFire**!
+  
+  ## Project resources
+  
+  * **Web site**: **<https://ness.github.io/PKFire>**
+    for general project information, usage, and development documentation
+  * **Repository**: <https://github.com/ness/PKFire>
+    for submitting pull requests
+  * **Issue tracker**: <https://github.com/ness/PKFire/issues>
+    for questions or bug reports
+  
+  ## Contribution terms
+  
+  By submitting a contribution to PKFire, you agree that it is
+  licensed under the project's license, the
+  [GNU General Public License v3.0 or later](https://github.com/ness/PKFire/blob/main/COPYING),
+  with no additional terms,
+  and that you have the right to submit it under that license.
+  
+  '''
+# ---
+# name: test_contributing_license[ISC]
+  '''
+  # Contributing to PKFire
+  
+  **Contributions are welcome!**
+  
+  Thank you for your time and interest in improving
+  **PKFire**!
+  
+  ## Project resources
+  
+  * **Web site**: **<https://ness.github.io/PKFire>**
+    for general project information, usage, and development documentation
+  * **Repository**: <https://github.com/ness/PKFire>
+    for submitting pull requests
+  * **Issue tracker**: <https://github.com/ness/PKFire/issues>
+    for questions or bug reports
+  
+  ## Contribution terms
+  
+  By submitting a contribution to PKFire, you agree that it is
+  licensed under the project's license, the
+  [ISC License](https://github.com/ness/PKFire/blob/main/LICENSE),
+  with no additional terms,
+  and that you have the right to submit it under that license.
+  
+  '''
+# ---
+# name: test_contributing_license[LGPL-3.0-only]
+  '''
+  # Contributing to PKFire
+  
+  **Contributions are welcome!**
+  
+  Thank you for your time and interest in improving
+  **PKFire**!
+  
+  ## Project resources
+  
+  * **Web site**: **<https://ness.github.io/PKFire>**
+    for general project information, usage, and development documentation
+  * **Repository**: <https://github.com/ness/PKFire>
+    for submitting pull requests
+  * **Issue tracker**: <https://github.com/ness/PKFire/issues>
+    for questions or bug reports
+  
+  ## Contribution terms
+  
+  By submitting a contribution to PKFire, you agree that it is
+  licensed under the project's license, the
+  [GNU Lesser General Public License v3.0 only](https://github.com/ness/PKFire/blob/main/COPYING.LESSER),
+  with no additional terms,
+  and that you have the right to submit it under that license.
+  
+  '''
+# ---
+# name: test_contributing_license[LGPL-3.0-or-later]
+  '''
+  # Contributing to PKFire
+  
+  **Contributions are welcome!**
+  
+  Thank you for your time and interest in improving
+  **PKFire**!
+  
+  ## Project resources
+  
+  * **Web site**: **<https://ness.github.io/PKFire>**
+    for general project information, usage, and development documentation
+  * **Repository**: <https://github.com/ness/PKFire>
+    for submitting pull requests
+  * **Issue tracker**: <https://github.com/ness/PKFire/issues>
+    for questions or bug reports
+  
+  ## Contribution terms
+  
+  By submitting a contribution to PKFire, you agree that it is
+  licensed under the project's license, the
+  [GNU Lesser General Public License v3.0 or later](https://github.com/ness/PKFire/blob/main/COPYING.LESSER),
+  with no additional terms,
+  and that you have the right to submit it under that license.
+  
+  '''
+# ---
+# name: test_contributing_license[MIT]
+  '''
+  # Contributing to PKFire
+  
+  **Contributions are welcome!**
+  
+  Thank you for your time and interest in improving
+  **PKFire**!
+  
+  ## Project resources
+  
+  * **Web site**: **<https://ness.github.io/PKFire>**
+    for general project information, usage, and development documentation
+  * **Repository**: <https://github.com/ness/PKFire>
+    for submitting pull requests
+  * **Issue tracker**: <https://github.com/ness/PKFire/issues>
+    for questions or bug reports
+  
+  ## Contribution terms
+  
+  By submitting a contribution to PKFire, you agree that it is
+  licensed under the project's license, the
+  [MIT License](https://github.com/ness/PKFire/blob/main/LICENSE),
+  with no additional terms,
+  and that you have the right to submit it under that license.
+  
+  '''
+# ---

{copier_python-0.17.1 → copier_python-0.19.0}/tests/template/__snapshots__/test_readme.ambr

@@ -549,7 +549,7 @@
   
   ## License
   
-  Written in 1995 by Ness and contributors.
+  Written in 1995 by Ness and contributors
   
   To the extent possible under law, the author(s) have dedicated all copyright
   and related and neighboring rights to this software to the public domain
@@ -581,7 +581,7 @@
   
   ## License
   
-  Written in 1995 by Ness and contributors.
+  Written in 1995 by Ness and contributors
   
   To the extent possible under law, the author(s) have dedicated all copyright
   and related and neighboring rights to this software to the public domain

{copier_python-0.17.1 → copier_python-0.19.0}/tests/template/test_contributing.py

@@ -6,6 +6,8 @@ from pathlib import Path
 import pytest
 from syrupy.assertion import SnapshotAssertion
 
+from tests.utils import license_choices
+
 
 @pytest.mark.parametrize(
     "enable_docs",
@@ -19,3 +21,13 @@ def test_contributing_features(
 ) -> None:
     rendered = render_template(enable_docs=enable_docs)
     assert (rendered / "CONTRIBUTING.md").read_text() == snapshot
+
+
+@pytest.mark.parametrize("copyright_license", license_choices.values())
+def test_contributing_license(
+    render_template: Callable[..., Path],
+    snapshot: SnapshotAssertion,
+    copyright_license: str,
+) -> None:
+    rendered = render_template(copyright_license=copyright_license)
+    assert (rendered / "CONTRIBUTING.md").read_text() == snapshot

{copier_python-0.17.1 → copier_python-0.19.0}/tests/test_update.py

@@ -20,7 +20,7 @@ import yaml
 from copier_python.__main__ import main, update
 
 if TYPE_CHECKING:
-    from collections.abc import Callable, Iterator, Sequence
+    from collections.abc import Callable, Generator, Sequence
 
     from .utils import DisallowCallable
 
@@ -109,7 +109,7 @@ def create_project(
 
 
 @pytest.fixture
-def mock_temp_dir(tmp_path: Path) -> Iterator[Path]:
+def mock_temp_dir(tmp_path: Path) -> Generator[Path]:
     with patch.object(
         tempfile.TemporaryDirectory, "__enter__", return_value=tmp_path
     ):
@@ -146,7 +146,7 @@ class ExpectRun:
         mock: bool = True,
         has_any: bool = False,
         shell_callback: Callable[[], None] | None = None,
-    ) -> Iterator[MagicMock]:
+    ) -> Generator[MagicMock]:
 
         subp_run = subprocess.run
 
@@ -281,7 +281,7 @@ def test_main_update_error(
             "",
             (f"Applied updates from template: {start_ref}...{end_ref}"),
             (
-                f"https://github.com/ness/pkfire/compare/"
+                f"https://github.com/smkent/copier-python/compare/"
                 f"{start_ref}...{end_ref}"
             ),
         )
@@ -376,7 +376,7 @@ def test_main_update_with_project(
             "",
             (f"Applied updates from template: {start_ref}...{end_ref}"),
             (
-                f"https://github.com/ness/pkfire/compare/"
+                f"https://github.com/smkent/copier-python/compare/"
                 f"{start_ref}...{end_ref}"
             ),
         )

{copier_python-0.17.1 → copier_python-0.19.0}/tests/utils.py

@@ -15,7 +15,7 @@ else:
     from typing_extensions import Self
 
 if TYPE_CHECKING:
-    from collections.abc import Callable, Iterator
+    from collections.abc import Callable, Generator
 
     import pytest
 
@@ -48,7 +48,7 @@ class DisallowCallable:
         self.original = getattr(self.obj, self.attr)
 
     @contextmanager
-    def __call__(self) -> Iterator[Self]:
+    def __call__(self) -> Generator[Self]:
 
         def wrapper(*args: Any, **kwargs: Any) -> Any:
             if self.enabled:
@@ -62,7 +62,7 @@ class DisallowCallable:
             yield self
 
     @contextmanager
-    def pause(self) -> Iterator[None]:
+    def pause(self) -> Generator[None]:
         if self.mock_attr:
             with patch.object(self.obj, self.attr, self.original):
                 yield

copier_python-0.17.1/tests/template/__snapshots__/test_contributing.ambr

@@ -1,126 +0,0 @@
-# serializer version: 1
-# name: test_contributing_features[docs]
-  '''
-  # Contributing to PKFire
-  
-  **Contributions are welcome!**
-  
-  Thank you for your time and interest in improving
-  **PKFire**!
-  
-  ## Project resources
-  
-  * **Web site**: **<https://ness.github.io/PKFire>**
-    for general project information, usage, and development documentation
-  * **Repository**: <https://github.com/ness/PKFire>
-    for submitting pull requests
-  * **Issue tracker**: <https://github.com/ness/PKFire/issues>
-    for questions or bug reports
-  
-  '''
-# ---
-# name: test_contributing_features[no_docs]
-  '''
-  # Contributing to PKFire
-  
-  **Contributions are welcome!**
-  
-  Thank you for your time and interest in improving
-  **PKFire**!
-  
-  ## Project resources
-  
-  * **Repository**: <https://github.com/ness/PKFire>
-    for submitting pull requests
-  * **Issue tracker**: <https://github.com/ness/PKFire/issues>
-    for questions or bug reports
-  
-  ## Development documentation
-  
-  ### Prerequisites
-  
-  - [x] [**git** for version control][git]
-  - [x] [**mise**][mise] tool manager: `curl https://mise.run | sh` or
-    [alternate installation method][mise-installation]
-  
-      !!! info
-  
-          `mise` ensures additional software is available, such as:
-  
-          * A [supported version][python-versions] of [**Python**][python]
-          * [Astral's **uv** Python project manager][uv]
-  
-  [git]: https://git-scm.com
-  [mise-installation]: https://mise.jdx.dev/installing-mise.html
-  [mise]: https://mise.jdx.dev
-  [python-versions]: https://devguide.python.org/versions/
-  [python]: https://python.org
-  [uv]: https://docs.astral.sh/uv/
-  
-  ### Project development workflow
-  
-  #### Cloning the repository
-  
-  ```sh
-  git clone https://github.com/ness/PKFire
-  cd PKFire
-  ```
-  
-  Run `mise install` in new repository clones to install tools, dependencies, and
-  git hooks:
-  
-  ```sh
-  mise install
-  ```
-  
-  #### Development tools
-  
-  * `mise run lint`: Run formatters and static checks
-  * `mise run test`: Run tests
-  
-  The `lint` and `test` tasks can also be run as a single combined command with:
-  
-  ```sh
-  mise run lt
-  ```
-  
-  ### Test snapshots
-  
-  Some tests compare test results with saved snapshots. Test snapshots can be
-  updated by running:
-  
-  ```sh
-  mise run snapup
-  ```
-  
-  ### Applying copier-python template updates
-  
-  Copier can update your project with template changes that have occurred since
-  the project was created.
-  
-  To apply updates, simply run in your project directory:
-  
-  ```sh
-  copier update
-  ```
-  
-  This will repeat the setup prompts, in case any prompts have been added or
-  changed.
-  
-  !!! tip
-      To change template-provided features in your project, simply change your
-      answers in the update prompts.
-  
-  To apply updates without being prompted (reusing all previous answers), run:
-  
-  ```sh
-  copier update -l
-  ```
-  
-  When [`copier update`][copier-update] is finished, view changes with
-  `git status` and `git diff`. Resolve any conflicts, and then commit the result.
-  
-  [copier-update]: https://copier.readthedocs.io/en/stable/updating/
-  
-  '''
-# ---