Added all open source licenses (Fixes #2941)

.github/workflows/update-licenses.yml

@@ -0,0 +1,34 @@
+name: Update Licenses
+
+on:
+  # Every day at 2am
+  schedule:
+    - cron: "0 2 * * *"
+  # Manual trigger
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.8
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+    - name: Update list
+      run: python scripts/update_licenses.py
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Commit changes
+      uses: stefanzweifel/git-auto-commit-action@v4.9.1
+      with:
+        commit_message: Update Licenses
+        file_pattern: cookiecutter.json {{cookiecutter.project_slug}}/licenses/*.txt

cookiecutter.json

@@ -6,13 +6,7 @@
   "domain_name": "example.com",
   "email": "{{ cookiecutter.author_name.lower()|replace(' ', '-') }}@example.com",
   "version": "0.1.0",
-  "open_source_license": [
-    "MIT",
-    "BSD",
-    "GPLv3",
-    "Apache Software License 2.0",
-    "Not open source"
-  ],
+  "open_source_license": ["Not open source", "MIT License", "BSD 3-Clause \"New\" or \"Revised\" License", "GNU General Public License v3.0", "Apache License 2.0", "\"Do What The F*ck You Want To Public License\"", "Academic Free License v3.0", "Artistic License 2.0", "BSD 2-Clause \"Simplified\" License", "BSD 3-Clause Clear License", "BSD 4-Clause \"Original\" or \"Old\" License", "BSD Zero Clause License", "Boost Software License 1.0", "CeCILL Free Software License Agreement v2.1", "Creative Commons Attribution 4.0 International", "Creative Commons Attribution Share Alike 4.0 International", "Creative Commons Zero v1.0 Universal", "Eclipse Public License 1.0", "Eclipse Public License 2.0", "Educational Community License v2.0", "European Union Public License 1.1", "European Union Public License 1.2", "GNU Affero General Public License v3.0", "GNU General Public License v2.0", "GNU Lesser General Public License v2.1", "GNU Lesser General Public License v3.0", "ISC License", "LaTeX Project Public License v1.3c", "Microsoft Public License", "Microsoft Reciprocal License", "Mozilla Public License 2.0", "ODC Open Database License v1.0", "Open Software License 3.0", "PostgreSQL License", "SIL Open Font License 1.1", "The Unlicense", "Universal Permissive License v1.0", "University of Illinois/NCSA Open Source License", "Vim License", "zlib License"],
   "timezone": "UTC",
   "windows": "n",
   "use_pycharm": "n",

hooks/post_gen_project.py

@@ -31,18 +31,6 @@
 DEBUG_VALUE = "debug"
 
 
-def remove_open_source_files():
-    file_names = ["CONTRIBUTORS.txt", "LICENSE"]
-    for file_name in file_names:
-        os.remove(file_name)
-
-
-def remove_gplv3_files():
-    file_names = ["COPYING"]
-    for file_name in file_names:
-        os.remove(file_name)
-
-
 def remove_pycharm_files():
     idea_dir_path = ".idea"
     if os.path.exists(idea_dir_path):
@@ -324,6 +312,34 @@ def remove_storages_module():
     os.remove(os.path.join("{{cookiecutter.project_slug}}", "utils", "storages.py"))
 
 
+def handle_licenses():
+    special_license_files = {
+        "European Union Public License 1.1": "COPYING",
+        "GNU General Public License v3.0": "COPYING",
+        "GNU Lesser General Public License v3.0": "COPYING.LESSER",
+        "The Unlicense": "UNLICENSE",
+    }
+    with open(os.path.join("licenses", "-temporary-placeholder.txt")) as f:
+        selected_title = f.readline()
+    for filename in os.listdir("licenses"):
+        if filename == "-temporary-placeholder.txt":
+            continue
+        # You'll always see: '---\n' marking beginning + end of Jekyll format
+        with open(os.path.join("licenses", filename)) as f:
+            contents = f.readlines()
+        title = contents[1].replace("title: ", "").rstrip()
+        if title != selected_title:
+            continue
+        with open(special_license_files.get(title, "LICENSE"), "w") as f:
+            # +2 to get rid of the --- and and an extra new line
+            f.writelines(contents[contents.index("---\n", 1) + 2 :])
+        break
+
+    if selected_title == "Not open source":
+        os.remove("CONTRIBUTORS.txt")
+    shutil.rmtree("licenses")
+
+
 def main():
     debug = "{{ cookiecutter.debug }}".lower() == "y"
 
@@ -334,10 +350,7 @@ def main():
     )
     set_flags_in_settings_files()
 
-    if "{{ cookiecutter.open_source_license }}" == "Not open source":
-        remove_open_source_files()
-    if "{{ cookiecutter.open_source_license}}" != "GPLv3":
-        remove_gplv3_files()
+    handle_licenses()
 
     if "{{ cookiecutter.use_pycharm }}".lower() == "n":
         remove_pycharm_files()

scripts/update_licenses.py

@@ -0,0 +1,59 @@
+import json
+import os
+import re
+from pathlib import Path
+from github import Github
+
+CURRENT_FILE = Path(__file__)
+ROOT = CURRENT_FILE.parents[1]
+GITHUB_TOKEN = os.getenv("GITHUB_TOKEN", None)
+
+
+def main() -> None:
+    """
+    Script entry point.
+    """
+    repo = Github(login_or_token=GITHUB_TOKEN).get_repo("github/choosealicense.com")
+    license_dir = ROOT / "{{cookiecutter.project_slug}}" / "licenses"
+    titles = []
+    for file in repo.get_contents("_licenses", "gh-pages"):
+        content = file.decoded_content.decode(file.encoding)
+        titles.append(content.split("\n", maxsplit=2)[1].replace("title: ", ""))
+        path = license_dir / file.name
+        if not path.is_file():
+            (license_dir / file.name).write_text(replace_content_options(content))
+    # Put "Not open source" at front so people know it's an option
+    front_options = [
+        "Not open source",
+        "MIT License",
+        'BSD 3-Clause "New" or "Revised" License',
+        "GNU General Public License v3.0",
+        "Apache License 2.0",
+    ]
+    titles = [x for x in sorted(titles) if x not in front_options]
+    update_cookiecutter(front_options + titles)
+
+
+year = (re.compile(r"\[year]"), "{% now 'utc', '%Y' %}")
+email = (re.compile(r"\[email]"), "{{ cookiecutter.email }}")
+fullname = (re.compile(r"\[fullname]"), "{{ cookiecutter.author_name }}")
+project = (re.compile(r"\[project]"), "{{ cookiecutter.project_name }}")
+projecturl = (re.compile(r"\[projecturl]"), "{{ cookiecutter.domain_name }}")
+
+
+def replace_content_options(content) -> str:
+    for compiled, replace in (year, email, fullname, project, projecturl):
+        content = compiled.sub(replace, content)
+    return content
+
+
+def update_cookiecutter(titles: list):
+    with open("cookiecutter.json") as f:
+        data = json.load(f)
+    data["open_source_license"] = titles
+    with open("cookiecutter.json", "wt") as f:
+        json.dump(data, f, indent=2)
+
+
+if __name__ == "__main__":
+    main()

tests/test_cookiecutter_generation.py

@@ -25,11 +25,19 @@ def context():
     }
 
 
+def generate_license_file_titles():
+    directory = os.path.join("{{cookiecutter.project_slug}}", "licenses")
+    titles = []
+    for file in os.listdir(directory):
+        if file == "-temporary-placeholder.txt":
+            continue
+        with open(os.path.join(directory, file)) as f:
+            titles.append(f.readlines()[1].replace("title: ", "").replace("\n", ""))
+    return titles
+
+
 SUPPORTED_COMBINATIONS = [
-    {"open_source_license": "MIT"},
-    {"open_source_license": "BSD"},
-    {"open_source_license": "GPLv3"},
-    {"open_source_license": "Apache Software License 2.0"},
+    *[{"open_source_license": x} for x in generate_license_file_titles()],
     {"open_source_license": "Not open source"},
     {"windows": "y"},
     {"windows": "n"},

{{cookiecutter.project_slug}}/README.rst

@@ -171,3 +171,10 @@ Bootstrap's javascript as well as its dependencies is concatenated into a single
 .. _Bootstrap docs: https://getbootstrap.com/docs/4.1/getting-started/theming/
 
 {% endif %}
+
+{% if cookiecutter.open_source_license != "Not open source" %}
+License
+^^^^^^
+
+Licensed under the {{cookiecutter.open_source_license}}
+{% endif %}

{{cookiecutter.project_slug}}/licenses/-temporary-placeholder.txt

@@ -0,0 +1 @@
+{{ cookiecutter.open_source_license }}

{{cookiecutter.project_slug}}/licenses/0bsd.txt

@@ -0,0 +1,39 @@
+---
+title: BSD Zero Clause License
+spdx-id: 0BSD
+
+description: The BSD Zero Clause license goes further than the BSD 2-Clause license to allow you unlimited freedom with the software without requirements to include the copyright notice, license text, or disclaimer in either source or binary forms.
+
+how: Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file.  Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders. You may take the additional step of removing the copyright notice.
+
+using:
+  PickMeUp: https://github.com/nazar-pc/PickMeUp/blob/master/copying.md
+  smoltcp: https://github.com/m-labs/smoltcp/blob/master/LICENSE-0BSD.txt
+  Toybox: https://github.com/landley/toybox/blob/master/LICENSE
+
+permissions:
+  - commercial-use
+  - distribution
+  - modifications
+  - private-use
+
+conditions: []
+
+limitations:
+  - liability
+  - warranty
+
+---
+
+Copyright (c) {% now 'utc', '%Y' %} {{ cookiecutter.author_name }}
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.