Feat: Modernize license options (#156)

* Feat: Add license options in prompt
* Feat: Extend supported licenses: GPL-3, MIT, BSD-3, Apace-2.0
* set default license to MIT
* Chore: Delete obsolete/nan files
* Docs: Update with new extended license support
* Fix: Delete leftover licenses dir - post gen
* Feat: Add tests support license options; modernize type hints
* Chore: update CHANGELOG + AUTHORS
* Refact: Use SPDX as lookup in setup
* Chore: Remove deprecated classifiers
* Fix: Set license w/ SPDX - PEP639
* Add AUTHORS to pyproject.toml license files
* Update {{cookiecutter.repo_name}}/devtools/conda-envs/test_env.yaml
* use conda instead of mamba in {{cookiecutter._ci_name}}.yaml (see MDAnalysis/install-mdanalysis#11 )

---------

Co-authored-by: Oliver Beckstein <orbeckst@gmail.com>

Author: ojeda-e

.github/actions/run-cookie-ci/action.yaml

@@ -48,7 +48,7 @@ runs:
     - name: Install act
       uses: actionsflow/setup-act@v1
       with:
-        version: '0.2.63'
+        version: '0.2.81'
 
     - name: Build Act image
       shell: bash

AUTHORS.md

@@ -29,5 +29,5 @@ The rules for this file:
 **2024**
 - Lawson Woods \<@ljwoods2\>
 
-**2024**
+**2026**
 - Estefania Barreto-Ojeda \<@ojeda-e\>

CHANGELOG.md

@@ -31,6 +31,7 @@ The rules for this file:
 
 ### Added
 <!-- New added features -->
+- Extend license options to MIT (default), GPLv3+, BSD 3-clause and Apache 2 (PR #156)
 - Add black configurartion to `pyproject.toml` (Issue #73, PR #75)
 - Cookiecutter version dependency (Issue #33, PR #46)
 - Configuration files for external hooks (PR #9)

cookiecutter.json

@@ -17,6 +17,25 @@
         "n"
     ],
     "template_analysis_class": "Class name to template (e.g. {{ cookiecutter.project_name.title().replace(' ', '').replace('-', '').replace('_', '') }} ). Press Enter to skip including analysis templates",
+    "license": [
+        "MIT License",
+        "GNU General Public License v3 or later (GPL-3.0+)",
+        "BSD 3-Clause License",
+        "Apache License 2.0"
+    ],
+    "_license_SPDX_identifiers": {
+        "MIT License":"MIT",
+        "GNU General Public License v3 or later (GPL-3.0+)":"GPL-3.0-or-later",
+        "BSD 3-Clause License":"BSD-3-Clause",
+        "Apache License 2.0":"Apache-2.0"
+    },
+    "_license_details": {
+        "MIT": ["MIT License", "yellow", "https://opensource.org/licenses/MIT", "MIT"],
+        "GPL-3.0-or-later": ["GNU General Public License v3 or later", "blue", "https://www.gnu.org/licenses/gpl-3.0", "GPLv3"],
+        "BSD-3-Clause": ["BSD 3-Clause License", "blue", "https://opensource.org/licenses/BSD-3-Clause", "BSD 3--Clause"],
+        "Apache-2.0": ["Apache License 2.0", "green", "https://opensource.org/licenses/Apache-2.0", "Apache 2.0"]
+    },
+    "__license": "{{ cookiecutter.license }}",
     "_mda_cc_version": 0.1,
     "_ci_name": "gh-ci",
     "_central_branch_name": "main",
@@ -27,4 +46,4 @@
     },
     "__dependency_source": "{{ cookiecutter._dependency_source_keys[cookiecutter.dependency_source] }}",
     "_copy_without_render": []
-}
+}

docs/scripts/file_descriptions.yaml

@@ -20,10 +20,7 @@ README.md: Description of project which GitHub will render
 
 # packaging
 MANIFEST.in: Packaging information for pip
-pyproject.toml: Dependencies for pip
-setup.cfg: Near-master config file settings for Coverage, Flake8, YAPF, etc
-setup.py: Your package's setup file for installing with additional options that can be set
-versioneer.py: Automatic version control with Versioneer
+pyproject.toml: Standard configuration file for Python projects.
 
 # config
 .codecov.yml: Settings for Codecov

docs/scripts/generate_cookiecutter_cli.py

@@ -97,12 +97,13 @@ def generate_cli_output(self) -> str:
             self.package_name,  # package_name
             "A package to do MD analysis",  # description
             "my-github-username",  # github_username,
-            "",  # github_host_account
+            "my-github-username",  # github_host_account
             "My Name",  # author_name
             "my_example_email@gmail.com",  # author_email
-            "",  # dependency_source
-            "",  # include_ReadTheDocs
+            "3",  # dependency_source
+            "1",  # include_ReadTheDocs
             "MyAnalysisClass",  # template_analysis_class
+            "1",  # license
         ]
 
         with tempfile.TemporaryDirectory() as tmpdir:
@@ -114,7 +115,9 @@ def generate_cli_output(self) -> str:
                 capture_output=True,
                 input="\n".join(inputs),
                 cwd=tmpdir,
+                check=True
             )
+
             source_repo = os.path.join(tmpdir, self.repo_name)
             destination_repo = str(self.example_repo_path.resolve())
             shutil.rmtree(destination_repo, ignore_errors=True)

docs/source/customising.rst

@@ -31,10 +31,10 @@ ammend appropriately:
 .. _general-info:
 
 * **License:** Your code needs to be clearly licensed so that users know if 
-  they can (legally) use it. The cookiecutter will apply the **GPLv2** 
-  license by default, included in the ``LICENSE`` file. If you decide to use a
-  different license (see `ChooseALicense <https://choosealicense.com/>`_), also 
-  update the copyright infromation in ``README.md``.
+  they can (legally) use it. During generation users choose one of the supported licenses
+  (defaults to **MIT**) and the cookiecutter fills ``LICENSE`` from that choice. 
+  Users can later change licenses (see `ChooseALicense <https://choosealicense.com/>`_) 
+  and update the copyright information in ``README.md``.
 
 * **README:** ``README.md`` is the introductory explanation to you project; it
   will be rendered on your GitHub repo's home page. It has been pre-filled with 

docs/source/files.rst

@@ -41,9 +41,8 @@ follow classifications:
      - Modify?
    * - ``LICENSE``
      - :ref:`GENERAL INFORMATION <general-info>`
-     - File containing the details of the GPLv2 license, the default license for packages developed from the MDAKit cookiecutter
-     - **YES** - without a clear license, *no-one* can legally use your code
-     - **OPTIONAL** - you can opt for a license other than GPLv2
+     - Generated license text from your chosen option (MIT, GPL-3.0+, BSD 3-Clause, or Apache 2.0).
+     - **YES** - without a clear license, *no-one* can legally use your code.
    * - ``README.md``
      - :ref:`GENERAL INFORMATION <general-info>`
      - A basic introduction/overview of the package; this file will be rendered on the GitHub repo's home

hooks/post_gen_project.py

@@ -14,6 +14,13 @@
     "{{ cookiecutter._mda_cc_version }}"
 )
 
+LICENSE_OPTIONS = {
+    "MIT": "MIT.txt",
+    "GPL-3.0-or-later": "GPL-3.0.txt",
+    "BSD-3-Clause": "BSD-3.txt",
+    "Apache-2.0": "Apache-2.0.txt",
+}
+
 
 def remove_files(*paths):
     for path in paths:
@@ -103,7 +110,37 @@ def remove_placeholder_icons():
         remove_files("docs/source/_static/logo")
 
 
+def set_license():
+    """Set LICENSE from template"""
+    license_name = "{{ cookiecutter.license }}"
+    repo_root = pathlib.Path.cwd()
+    dest = repo_root / "LICENSE"
+    licenses_dir = repo_root / "licenses"
+
+    if license_name in LICENSE_OPTIONS:
+        src = licenses_dir / LICENSE_OPTIONS[license_name]
+        shutil.copy(src, dest)
+    else:
+        supported_licenses = ", ".join(LICENSE_OPTIONS.keys())
+        raise ValueError(
+            f"Unsupported license: {license_name!r}. "
+            f"Supported licenses are: {supported_licenses}"
+        )
+
+    for filename in LICENSE_OPTIONS.values():
+        path = licenses_dir / filename
+        if path.is_file():
+            path.unlink()
+
+    if licenses_dir.is_dir():
+        try:
+            licenses_dir.rmdir()
+        except OSError:
+            pass
+
+
 if __name__ == "__main__":
+    set_license()
     remove_rtd()
     remove_analysis()
     remove_placeholder_icons()

hooks/pre_gen_project.py

@@ -39,7 +39,8 @@
 
 === LICENSE ===
 
-{{ cookiecutter.update({"open_source_license": 'GNU Public License v2+'}) }}
+{% set _license_trimmed = cookiecutter.license | trim %}
+{{ cookiecutter.update({"license": cookiecutter._license_SPDX_identifiers[_license_trimmed] if _license_trimmed in cookiecutter._license_SPDX_identifiers else _license_trimmed}) }}
 
 """