Set license in pyproject.toml

Replaces the license JSON data with cookiecutter private dictionary
variables.

https://cookiecutter.readthedocs.io/en/stable/advanced/private_variables.html
https://cookiecutter.readthedocs.io/en/stable/advanced/dict_variables.html

Author: boltronics

cookiecutter.json

@@ -1,6 +1,6 @@
 {
   "package_display_name": "Package-Name",
-  "package_name": "{{cookiecutter.package_display_name.lower().replace(' ', '_').replace('-', '_')}}",
+  "package_name": "{{ cookiecutter.package_display_name.lower().replace(' ', '_').replace('-', '_') }}",
   "package_short_description": "A description of the package",
   "version": "0.0.1",
   "full_name": "Your Name",
@@ -18,5 +18,17 @@
     "GPL-3.0-only",
     "GPL-3.0-or-later"
   ],
-  "year": "{% now 'utc', '%Y' %}"
+  "year": "{% now 'utc', '%Y' %}",
+  "_license_map": {
+    "AGPL-3.0-only": {"source": "AGPL3", "destination": "COPYING"},
+    "AGPL-3.0-or-later": {"source": "AGPL3", "destination": "COPYING"},
+    "Apache-2.0": {"source": "APACHE-2.0", "destination": "LICENSE"},
+    "BSD-3-Clause": {"source": "BSD-3-CLAUSE", "destination": "LICENSE"},
+    "GPL-2.0-only": {"source": "GPL2", "destination": "COPYING"},
+    "GPL-2.0-or-later": {"source": "GPL2", "destination": "COPYING"},
+    "GPL-3.0-only": {"source": "GPL3", "destination": "COPYING"},
+    "GPL-3.0-or-later": {"source": "GPL3", "destination": "COPYING"}
+  },
+  "__license_src": "{{ cookiecutter._license_map.get(cookiecutter.license, {}).get('source', '') }}",
+  "__license_dest": "{{ cookiecutter._license_map.get(cookiecutter.license, {}).get('destination', '') }}"
 }

hooks/post_gen_project.py

@@ -1,39 +1,35 @@
 #!/usr/bin/env python3
 """Pre-gen project hook script
 
-Takes care of deploying the correct license file.
+Takes care of setting the correct license file in pyproject.toml.
 """
 
-import json
 from pathlib import Path
+from shutil import copy
+
 
 PROJECT_DIR = Path(".")
 LICENSE_DIR = PROJECT_DIR.joinpath("licenses")
-LICENSE_CONFIG = LICENSE_DIR.joinpath("config.json")
+LICENSES = {{cookiecutter._license_map | jsonify}}
 LICENSE_SELECTED = "{{ cookiecutter.license }}"
+SELECTED_LICENSE_SOURCE = "{{ cookiecutter.__license_src }}"
+SELECTED_LICENSE_DESTINATION = "{{ cookiecutter.__license_dest }}"
 
 
 def deploy_license() -> None:
-    """Move the selected license file into the project root
-
-    Licenses not selected for the project are removed.
-    """
+    """Move the selected license file into the project root"""
     sources: set[Path] = set()
-    selected_source = None
-    with LICENSE_CONFIG.open(mode="r", encoding="utf-8") as config_file:
-        config = json.load(config_file)
-        for license_option, license_data in config.items():
-            source_path = LICENSE_DIR.joinpath(license_data["source"])
-            if license_option == LICENSE_SELECTED:
-                selected_source = source_path
-                destination_path = PROJECT_DIR.joinpath(license_data["destination"])
-                source_path.rename(destination_path)
-                sources.discard(source_path)
-            elif license_data["source"] != selected_source:
-                sources.add(source_path)
-        for source in sources:
-            source.unlink()
-    LICENSE_CONFIG.unlink()
+    for license_option, license_config in LICENSES.items():
+        source_path = LICENSE_DIR.joinpath(license_config["source"])
+        if license_option == LICENSE_SELECTED:
+            destination_path = PROJECT_DIR.joinpath(
+                SELECTED_LICENSE_DESTINATION
+            )
+            copy(source_path, destination_path)
+        elif license_option != SELECTED_LICENSE_SOURCE:
+            sources.add(source_path)
+    for source in sources:
+        source.unlink()
     LICENSE_DIR.rmdir()
 
 

{{cookiecutter.package_name}}/licenses/config.json

@@ -5,16 +5,19 @@ build-backend = "hatchling.build"
 [project]
 name = "{{cookiecutter.package_name}}"
 dynamic = ["version"]
+description = "{{cookiecutter.package_short_description}}"
+readme = "README.rst"
 requires-python = ">= 3.11"
+{%- if cookiecutter.license != "Not licensed for distribution (no license)" %}
+license = "{{ cookiecutter.license }}"
+{%- endif %}
 dependencies = []
 authors = [
   {name = "{{cookiecutter.full_name}}", email = "{{cookiecutter.email}}"},
 ]
 keywords=[
   "{{cookiecutter.package_name}}"
 ]
-description = "{{cookiecutter.package_short_description}}"
-readme = "README.rst"
 classifiers = [
   "Development Status :: 2 - Pre-Alpha",
   "Intended Audience :: Developers",