Merge pull request #624 from NLeSC/600_validate_package_details

600-validate package details

Author: fdiblen

copier/messages.yml

@@ -22,7 +22,7 @@ _message_after_copy: |
                 git add --all
                 git commit -m "first commit"
                 git branch -M main
-                git remote add origin {{ repository }}
+                git remote add origin {{ repository }}.git
 
             - Push the initial commit to a new repo on GitHub
 

copier/questions/features_publish_release.yml

@@ -23,10 +23,6 @@ SelectPublishReleaseFeatures:
     Zenodo integration instructions:
       value: AddZenodo_flag
       # validator: "{% if something != 'AnotherThing' %}BlaBla{% endif %}"
-    Package keywords(NOT_IMPLEMENTED):
-      value: not_implemented_keywords
-      # validator: "{% if something != 'AnotherThing' %}BlaBla{% endif %}"
-
 
 # Sub-menus
 # split AddCitation --> enable_citation_file and enable_cffconvert

copier/questions/package_details.yml

@@ -1,45 +1,36 @@
 ---
 # package details
-AddPackageDetails:
-  type: bool
-  default: yes
-  help: |-
-    If you are planning to publish the package it is recommended to provide more details.
-       Do you want to provide extra details for the package?
-  when: "{{ template_profile != 'minimum'}}"
+# AddPackageDetails:
+#   type: bool
+#   default: yes
+#   help: |-
+#     If you are planning to publish the package it is recommended to provide more details.
+#        Do you want to provide extra details for the package?
+#   when: false
 package_short_description:
   type: str
   placeholder: Short description
   help: Short description of package
-  when: "{{ template_profile != 'minimum' and AddPackageDetails }}"
   validator: >-
         {% if not package_short_description %}
         Package description cannot be empty
         {% endif %}
-keyword1:
+keywords:
   type: str
-  placeholder: keyword1
-  help: Add keyword1
-  when: "{{ template_profile != 'minimum' and AddPackageDetails }}"
-keyword2:
-  type: str
-  placeholder: keyword2
-  help: Add keyword2
-  when: "{{ template_profile != 'minimum' and AddPackageDetails }}"
+  placeholder: keyword1,second keyword,third keyword
+  help: Add keywords to make your package findable on PyPI
 github_organization:
   type: str
-  placeholder: "<my-github-organization>"
+  placeholder: "your-github-username or your-github-organization"
   help: Enter the name of your GitHub username or organization
-  when: "{{ template_profile != 'minimum' and AddPackageDetails }}"
   validator: >-
-        {% if not github_organization %}
-        This field cannot be empty
+        {% if not (github_organization | regex_search('^\\S*$')) %}
+        Username or organization cannot include spaces
         {% endif %}
 email:
   type: str
   placeholder: yourname@esciencecenter.nl
   help: What is your email address?
-  when: "{{ template_profile != 'minimum' and AddPackageDetails }}"
   validator: >-
         {% if not (email | regex_search('([A-Za-z0-9]+[.-_])*[A-Za-z0-9]+@[A-Za-z0-9-]+(\.[A-Z|a-z]{2,})+')) %}
         Please enter a valid email address
@@ -48,22 +39,22 @@ code_of_conduct_email:
   type: str
   default: "{{ email }}"
   help: What is the email address to report code of conduct violations?
-  when: "{{ template_profile != 'minimum' and AddPackageDetails }}"
   validator: >-
         {% if not (code_of_conduct_email | regex_search('([A-Za-z0-9]+[.-_])*[A-Za-z0-9]+@[A-Za-z0-9-]+(\.[A-Z|a-z]{2,})+')) %}
         Please enter a valid email address
         {% endif %}
 copyright_holder:
   type: str
-  placeholder: Netherlands eScience Center
-  help: Who is the copyright holder?
-  when: "{{ template_profile != 'minimum' and AddPackageDetails }}"
-
+  default: "{{ full_name }}"
+  help: Who is the copyright holder (the default is your full name)?
+  validator: >-
+        {% if not copyright_holder %}
+        This field cannot be empty as it will be used in content of the generated files.
+        {% endif %}
 # calculated fields for GitHub
 repository:
   default: git@github.com:{{ github_organization }}/{{ package_name }}
   when: false
-
 repository_url:
   default: https://github.com/{{ github_organization }}/{{ package_name }}
   when: false

template/pyproject.toml.jinja

@@ -31,8 +31,9 @@ classifiers = [
 dependencies = []
 description = "{{ package_short_description|replace('\"', '\\\"') }}"
 keywords = [
-    "{{ keyword1 }}",
-    "{{ keyword2 }}",
+{%- for item in keywords.split(',') -%}
+"{{ item }}"{{ "," if not loop.last }}
+{%- endfor -%}
 ]
 license = {file = "LICENSE"}
 name = "{{ package_name }}"

template/{% if AddCitation %}CITATION.cff{% endif %}.jinja

@@ -12,8 +12,9 @@ doi: <insert your DOI here>
 version: "{{ version }}"
 repository-code: "{{ repository_url }}"
 keywords:
-  - {{ keyword1 }}
-  - {{ keyword2 }}
+{%- for item in keywords.split(',') %}
+  - "{{ item }}"
+{%- endfor %}
 message: "If you use this software, please cite it using these metadata."
 {{ { "Apache Software License 2.0": "license: Apache-2.0",
     "MIT license": "license: MIT",

tests/test_project.py

@@ -16,8 +16,7 @@ def copier_project_defaults():
     return {
             "package_name": "my_python_package",
             "package_short_description": "Short description of package",
-            "keyword1": "keyword1",
-            "keyword2": "keyword2",
+            "keywords": "keyword1,keyword2",
             "version": "0.1.0",
             "github_organization": "<my-github-organization>",
             "full_name": "Jane Smith",