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

{copier_python-0.19.0 → copier_python-0.19.1}/CONTRIBUTING.md

@@ -13,3 +13,11 @@ Thank you for your time and interest in improving
   for submitting pull requests
 * **Issue tracker**: <https://github.com/smkent/copier-python/issues>
   for questions or bug reports
+
+## Contribution terms
+
+By submitting a contribution to copier-python, you agree that it is
+licensed under the project's license, the
+[MIT License](https://github.com/smkent/copier-python/blob/main/LICENSE),
+with no additional terms,
+and that you have the right to submit it under that license.

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: copier-python
-Version: 0.19.0
+Version: 0.19.1
 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.19.0 → copier_python-0.19.1}/tests/template/__snapshots__/test_workflows.ambr

@@ -1141,76 +1141,7 @@
   
   '''
 # ---
-# name: test_workflows_release[no_pypi]
-  '''
-  name: Release
-  
-  on:
-    push:
-      tags:
-        - v[0-9]*.[0-9]*
-  
-  jobs:
-    build:
-      name: Build distribution
-      runs-on: ubuntu-latest
-      env:
-        UV_PYTHON: '3.14'
-      steps:
-        - name: 💾 Check out repository
-          uses: actions/checkout@v7
-          with:
-            fetch-depth: 0
-  
-        - name: 📦 Cache uv managed packages
-          uses: actions/cache@v6
-          with:
-            path: ~/.cache/uv
-            key: uv-${{ runner.os }}-${{ hashFiles('pyproject.toml', 'uv.lock') }}
-            restore-keys: |
-              uv-${{ runner.os }}-
-  
-        - name: 🍳 Set up mise
-          uses: jdx/mise-action@v5
-          with:
-            cache: true
-            install: true
-  
-        - name: 📦 Build package
-          run: mise run build
-  
-        - name: 🔼 Upload artifact
-          uses: actions/upload-artifact@v7
-          with:
-            name: dist
-            path: dist/
-  
-    release:
-      name: Create GitHub release
-      needs: build
-      runs-on: ubuntu-latest
-      permissions:
-        contents: write
-      steps:
-        - name: 💾 Check out repository
-          uses: actions/checkout@v7
-          with:
-            fetch-depth: 0
-  
-        - name: 🔽 Download artifact
-          uses: actions/download-artifact@v8
-          with:
-            name: dist
-            path: dist/
-  
-        - name: 🏷️ Create GitHub release
-          run: gh release create ${{ github.ref_name }} dist/* --generate-notes
-          env:
-            GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-  
-  '''
-# ---
-# name: test_workflows_release[pypi]
+# name: test_workflows_release
   '''
   name: Release
   

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

@@ -6,7 +6,7 @@ from pathlib import Path
 import pytest
 from syrupy.assertion import SnapshotAssertion
 
-from tests.utils import license_choices
+from tests.utils import choices
 
 
 @pytest.mark.parametrize(
@@ -23,7 +23,7 @@ def test_contributing_features(
     assert (rendered / "CONTRIBUTING.md").read_text() == snapshot
 
 
-@pytest.mark.parametrize("copyright_license", license_choices.values())
+@pytest.mark.parametrize("copyright_license", choices["copyright_license"])
 def test_contributing_license(
     render_template: Callable[..., Path],
     snapshot: SnapshotAssertion,

{copier_python-0.19.0 → copier_python-0.19.1}/tests/template/test_docs.py

@@ -6,7 +6,7 @@ from pathlib import Path
 import pytest
 from syrupy.assertion import SnapshotAssertion
 
-from tests.utils import license_choices
+from tests.utils import choices
 
 
 @pytest.mark.parametrize(
@@ -66,7 +66,7 @@ def test_docs_development_features(
         ).read_text() == snapshot
 
 
-@pytest.mark.parametrize("copyright_license", license_choices.values())
+@pytest.mark.parametrize("copyright_license", choices["copyright_license"])
 def test_docs_license(
     render_template: Callable[..., Path],
     snapshot: SnapshotAssertion,

{copier_python-0.19.0 → copier_python-0.19.1}/tests/template/test_license.py

@@ -7,10 +7,10 @@ import pytest
 import yaml
 from syrupy.assertion import SnapshotAssertion
 
-from tests.utils import TEMPLATE_ROOT, license_choices
+from tests.utils import TEMPLATE_ROOT, choices
 
 
-@pytest.mark.parametrize("copyright_license", license_choices.values())
+@pytest.mark.parametrize("copyright_license", choices["copyright_license"])
 def test_license(
     render_template: Callable[..., Path],
     snapshot: SnapshotAssertion,
@@ -22,27 +22,6 @@ def test_license(
             assert (rendered / name).read_text() == snapshot
 
 
-@pytest.mark.parametrize("copyright_license", license_choices.values())
-def test_license_files(
-    render_template: Callable[..., Path], copyright_license: str
-) -> None:
-    if copyright_license.startswith("LGPL-"):
-        expected = ["COPYING", "COPYING.LESSER"]
-    elif "GPL-" in copyright_license:
-        expected = ["COPYING"]
-    else:
-        expected = ["LICENSE"]
-    rendered = render_template(copyright_license=copyright_license)
-    assert (
-        sorted(
-            p.name
-            for p in rendered.iterdir()
-            if p.name in {"LICENSE", "COPYING", "COPYING.LESSER"}
-        )
-        == expected
-    )
-
-
 @pytest.mark.parametrize("project_type", ["application", "library"])
 def test_license_default(
     render_template: Callable[..., Path], project_type: str
@@ -56,7 +35,7 @@ def test_license_default(
     )
 
 
-@pytest.mark.parametrize("copyright_license", license_choices.values())
+@pytest.mark.parametrize("copyright_license", choices["copyright_license"])
 def test_license_choices_have_templates(copyright_license: str) -> None:
     assert (
         TEMPLATE_ROOT / "includes" / "licenses" / copyright_license

{copier_python-0.19.0 → copier_python-0.19.1}/tests/template/test_pyproject.py

@@ -6,7 +6,7 @@ from pathlib import Path
 import pytest
 from syrupy.assertion import SnapshotAssertion
 
-from tests.utils import license_choices
+from tests.utils import choices
 
 
 @pytest.mark.parametrize("project_visibility", ["public", "private"])
@@ -63,7 +63,7 @@ def test_pyproject_versions(
     assert (rendered / "pyproject.toml").read_text() == snapshot
 
 
-@pytest.mark.parametrize("copyright_license", license_choices.values())
+@pytest.mark.parametrize("copyright_license", choices["copyright_license"])
 def test_pyproject_licenses(
     render_template: Callable[..., Path],
     snapshot: SnapshotAssertion,

{copier_python-0.19.0 → copier_python-0.19.1}/tests/template/test_readme.py

@@ -6,7 +6,7 @@ from pathlib import Path
 import pytest
 from syrupy.assertion import SnapshotAssertion
 
-from tests.utils import license_choices
+from tests.utils import choices
 
 
 @pytest.mark.parametrize(
@@ -41,7 +41,7 @@ def test_readme_features(
 
 
 @pytest.mark.parametrize("project_visibility", ["public", "private"])
-@pytest.mark.parametrize(("copyright_license"), license_choices.values())
+@pytest.mark.parametrize("copyright_license", choices["copyright_license"])
 def test_readme_project_visibility(
     render_template: Callable[..., Path],
     snapshot: SnapshotAssertion,

copier_python-0.19.1/tests/template/test_structure.py

@@ -0,0 +1,156 @@
+from __future__ import annotations
+
+import re
+from dataclasses import dataclass, field
+from typing import TYPE_CHECKING, Any
+
+import pytest
+
+from tests.utils import choices
+
+if TYPE_CHECKING:
+    from collections.abc import Callable
+    from pathlib import Path
+
+
+@dataclass
+class StructureTestCase:
+    extra_data: dict[str, Any] = field(default_factory=dict)
+    expected_present: set[str] = field(default_factory=set)
+    expected_absent: set[str] = field(default_factory=set)
+
+    def expect_if(self, present: bool, *items: str) -> None:  # noqa: FBT001
+        if present:
+            self.expected_present |= set(items)
+        else:
+            self.expected_absent |= set(items)
+
+    def run(self, render_template: Callable[..., Path]) -> None:
+        rendered = render_template(**self.extra_data)
+        for path in self.expected_present:
+            assert (rendered / path).exists(), f"{path!r} should exist"
+        for path in self.expected_absent:
+            assert not (rendered / path).exists(), f"{path!r} should be absent"
+
+
+@dataclass
+class StructureTest:
+    render_template: Callable[..., Path] = field(repr=False)
+
+    def __call__(self, case: StructureTestCase) -> None:
+        case.run(self.render_template)
+
+
+@pytest.fixture
+def structure_test(
+    render_template: Callable[..., Path],
+) -> StructureTest:
+    return StructureTest(render_template=render_template)
+
+
+@pytest.mark.parametrize("project_type", choices["project_type"])
+@pytest.mark.parametrize("project_visibility", choices["project_visibility"])
+@pytest.mark.parametrize(
+    "enable_coverage",
+    [pytest.param(True, id="coverage"), pytest.param(False, id="no_coverage")],
+)
+@pytest.mark.parametrize(
+    "enable_pypi",
+    [pytest.param(True, id="pypi"), pytest.param(False, id="no_pypi")],
+)
+@pytest.mark.parametrize(
+    "enable_container",
+    [
+        pytest.param(True, id="container"),
+        pytest.param(False, id="no_container"),
+    ],
+)
+@pytest.mark.parametrize(
+    "enable_docs",
+    [pytest.param(True, id="docs"), pytest.param(False, id="no_docs")],
+)
+def test_structure(
+    structure_test: StructureTest,
+    project_type: str,
+    project_visibility: str,
+    *,
+    enable_coverage: bool,
+    enable_pypi: bool,
+    enable_container: bool,
+    enable_docs: bool,
+) -> None:
+    case = StructureTestCase(
+        extra_data={
+            "project_type": project_type,
+            "project_visibility": project_visibility,
+            "enable_container": enable_container,
+            "enable_coverage": enable_coverage,
+            "enable_pypi": enable_pypi,
+            "enable_docs": enable_docs,
+        },
+        expected_present={
+            ".gitignore",
+            ".pre-commit-config.yaml",
+            "README.md",
+            "pyproject.toml",
+            "renovate.json",
+        },
+    )
+    case.expect_if(
+        project_visibility == "public",
+        ".github/workflows/audit.yaml",
+        ".github/workflows/ci.yaml",
+        "CONTRIBUTING.md",
+    )
+    case.expect_if(
+        project_visibility == "public" and enable_pypi,
+        ".github/workflows/release.yaml",
+    )
+    case.expect_if(
+        enable_container,
+        "Dockerfile",
+        ".dockerignore",
+    )
+    case.expect_if(
+        project_visibility == "public" and enable_container,
+        ".github/workflows/container.yaml",
+        ".github/workflows/ghcr.yaml",
+    )
+    case.expect_if(
+        enable_docs,
+        "docs",
+        "docs/api.md",
+        "docs/contributing.md",
+        "docs/development/requirements.md",
+        "docs/development/updates.md",
+        "docs/development/workflow.md",
+        "docs/index.md",
+        "docs/license.md",
+        "zensical.toml",
+    )
+    case.expect_if(
+        project_visibility == "public" and enable_docs,
+        ".github/workflows/docs.yaml",
+        "docs/setup.md",
+        "docs/releasing.md",
+    )
+    case.expect_if(
+        project_type == "application" and enable_container, "compose.yaml"
+    )
+    structure_test(case)
+
+
+@pytest.mark.parametrize("copyright_license", choices["copyright_license"])
+def test_structure_license(
+    structure_test: StructureTest,
+    copyright_license: str,
+) -> None:
+    case = StructureTestCase(
+        extra_data={"copyright_license": copyright_license}
+    )
+    case.expect_if(not re.match(r"^[AL]?GPL-", copyright_license), "LICENSE")
+    case.expect_if(bool(re.match(r"^[AL]?GPL-", copyright_license)), "COPYING")
+    case.expect_if(
+        bool(re.match(r"^LGPL-", copyright_license)), "COPYING.LESSER"
+    )
+    structure_test(case)

{copier_python-0.19.0 → copier_python-0.19.1}/tests/template/test_workflows.py

@@ -54,20 +54,14 @@ def test_workflows_ci_versions(
     ).read_text() == snapshot
 
 
-@pytest.mark.parametrize(
-    "enable_pypi",
-    [pytest.param(True, id="pypi"), pytest.param(False, id="no_pypi")],
-)
 def test_workflows_release(
     render_template: Callable[..., Path],
     snapshot: SnapshotAssertion,
-    *,
-    enable_pypi: bool,
 ) -> None:
     rendered = render_template(
         project_type="application",
         project_visibility="public",
-        enable_pypi=enable_pypi,
+        enable_pypi=True,
     )
     assert (
         rendered / ".github" / "workflows" / "release.yaml"

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

@@ -69,10 +69,12 @@ class DisallowCallable:
             self.mock_attr.assert_not_called()
 
 
-def _load_license_choices() -> dict[str, str]:
-    return yaml.safe_load((TEMPLATE_ROOT / "copier.yaml").read_text())[
-        "copyright_license"
-    ]["choices"]
-
-
-license_choices = _load_license_choices()
+choices = {
+    k: list(choices.values()) if isinstance(choices, dict) else choices
+    for k, v in yaml.safe_load(
+        (TEMPLATE_ROOT / "copier.yaml").read_text()
+    ).items()
+    if isinstance(v, dict)
+    and (choices := v.get("choices"))
+    and isinstance(choices, (dict, list))
+}

copier_python-0.19.0/tests/template/test_structure.py

@@ -1,107 +0,0 @@
-"""Tests for rendered project file presence and absence."""
-
-from collections.abc import Callable
-from pathlib import Path
-from typing import Any
-
-import pytest
-
-
-@pytest.mark.parametrize(
-    ("extra_data", "expected_present", "expected_absent"),
-    [
-        pytest.param(
-            {
-                "project_type": "library",
-                "enable_coverage": False,
-                "enable_pypi": False,
-                "enable_docs": False,
-            },
-            [
-                "pyproject.toml",
-                "README.md",
-                "CONTRIBUTING.md",
-                "LICENSE",
-                ".gitignore",
-                ".pre-commit-config.yaml",
-                "renovate.json",
-                ".github/workflows/ci.yaml",
-                ".github/workflows/audit.yaml",
-                ".github/workflows/release.yaml",
-            ],
-            [
-                "docs",
-                "Dockerfile",
-                ".dockerignore",
-                "compose.yaml",
-                "zensical.toml",
-                ".github/workflows/docs.yaml",
-                ".github/workflows/container.yaml",
-                ".github/workflows/ghcr.yaml",
-            ],
-            id="public_library_minimal",
-        ),
-        pytest.param(
-            {"project_visibility": "private"},
-            [],
-            [".github", "CONTRIBUTING.md"],
-            id="private",
-        ),
-        pytest.param(
-            {"enable_pypi": True},
-            [".github/workflows/release.yaml"],
-            [],
-            id="pypi",
-        ),
-        pytest.param(
-            {"enable_container": True, "project_type": "library"},
-            [
-                "Dockerfile",
-                ".dockerignore",
-                ".github/workflows/container.yaml",
-                ".github/workflows/ghcr.yaml",
-            ],
-            ["compose.yaml"],
-            id="container_library",
-        ),
-        pytest.param(
-            {"enable_container": True, "project_type": "application"},
-            ["Dockerfile", ".dockerignore", "compose.yaml"],
-            [],
-            id="container_application",
-        ),
-        pytest.param(
-            {
-                "project_visibility": "public",
-                "project_type": "application",
-                "enable_docs": True,
-                "enable_pypi": True,
-                "enable_container": True,
-                "enable_coverage": True,
-            },
-            [
-                "docs",
-                "docs/setup.md",
-                "docs/releasing.md",
-                "docs/development/requirements.md",
-                "docs/development/workflow.md",
-                "docs/development/updates.md",
-                "zensical.toml",
-                ".github/workflows/docs.yaml",
-            ],
-            [],
-            id="docs_application",
-        ),
-    ],
-)
-def test_structure(
-    render_template: Callable[..., Path],
-    extra_data: dict[str, Any],
-    expected_present: list[str],
-    expected_absent: list[str],
-) -> None:
-    rendered = render_template(**extra_data)
-    for path in expected_present:
-        assert (rendered / path).exists(), f"{path!r} should exist"
-    for path in expected_absent:
-        assert not (rendered / path).exists(), f"{path!r} should be absent"