Merge branch 'main' into 575-user-profiles

Author: lyashevska

CHANGELOG.md

@@ -18,6 +18,9 @@
 
 ### Changed
 * Update the user documentation (README.md) of the template [#575](https://github.com/NLeSC/python-template/pull/623)
+* Updated .gitignore [#622](https://github.com/NLeSC/python-template/pull/622)
+* add extra info for sub-menus [#628](https://github.com/NLeSC/python-template/pull/628)
+* skip merging CHANGELOG.md and CODE_OF_CONDUCT.md if they exist [#628](https://github.com/NLeSC/python-template/pull/628)
 * added value field to license options [#617](https://github.com/NLeSC/python-template/pull/617)
 * fix filename typo of githooks [#611](https://github.com/NLeSC/python-template/pull/609)
 * next_steps.md is shown as a copier message [#609](https://github.com/NLeSC/python-template/pull/609)

copier/messages.yml

@@ -22,21 +22,19 @@ _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
 
                 Go to https://github.com/organizations/{{github_organization}}/repositories/new
                 and create a new repository named `{{ package_name }}` as an empty repository, then push your commits to GitHub:
 
                 git push --set-upstream origin main
-
-          {% if AddDevDoc -%}
+          {% if AddDevDoc %}
             - Project development documentation
 
                 The README.dev.md contains developer documentation
-          {%- endif %}
-
+          {% endif %}
             - Project layout explained
 
                 For an explanation of what files are there, and what each of these do, please refer to {{ _copier_conf.dst_path }}/project_setup.md

copier/questions/features_code_quality.yml

@@ -14,7 +14,7 @@ SelectCodeQualityFeatures:
   help: Select code quality features
   multiselect: true
   choices:
-    GitHub Actions:
+    GitHub Actions (selection on the next menu):
       value: SelectGitHubActions_flag
       # validator: "{% if something != 'AnotherThing' %}BlaBla{% endif %}"
     Linting:

copier/questions/features_community.yml

@@ -26,7 +26,6 @@ AddCodeConduct:
   type: bool
   default: "{{ 'AddCodeConduct_flag' in SelectCommunityFeatures }}"
   when: false
-
 AddContributing:
   type: bool
   default: "{{ 'AddContributing_flag' in SelectCommunityFeatures }}"

copier/questions/features_documentation.yml

@@ -26,7 +26,6 @@ AddOnlineDocumentation:
   type: bool
   default: "{{ 'AddOnlineDocumentation_flag' in SelectDocumentationFeatures }}"
   when: false
-
 AddDevDoc:
   type: bool
   default: "{{ 'AddDevDoc_flag' in SelectDocumentationFeatures }}"

copier/questions/features_publish_release.yml

@@ -14,7 +14,7 @@ SelectPublishReleaseFeatures:
   help: Select publish and release features
   multiselect: true
   choices:
-    Citation:
+    Citation (selection on the next menu):
       value: SelectCitation_flag
       # validator: "{% if something != 'AnotherThing' %}BlaBla{% endif %}"
     Changelog:
@@ -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
@@ -55,17 +51,14 @@ AddCitation:
   type: bool
   default: "{{ 'AddCitationFile_flag' in SelectCitation }}"
   when: false
-
 AddCFFConvert:
   type: bool
   default: "{{ 'AddCFFConvert_flag' in SelectCitation }}"
   when: false
-
 AddChangeLog:
   type: bool
   default: "{{ 'AddChangeLog_flag' in SelectPublishReleaseFeatures }}"
   when: false
-
 AddZenodo:
   type: bool
   default: "{{ 'AddZenodo_flag' in SelectPublishReleaseFeatures }}"

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,24 @@ 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
+
+# computed fields
 repository:
   default: git@github.com:{{ github_organization }}/{{ package_name }}
   when: false
-
 repository_url:
   default: https://github.com/{{ github_organization }}/{{ package_name }}
   when: false

copier/settings.yml

@@ -6,3 +6,5 @@ _skip_if_exists:
   - "pyproject.toml"
   - CITATION.cff
   - LICENSE
+  - CHANGELOG.md
+  - CODE_OF_CONDUCT.md

template/.gitignore

@@ -1,33 +1,69 @@
+# Byte-compiled / optimized / DLL files
 *.py[cod]
-*.egg-info
-*.eggs
-.ipynb_checkpoints
-
-build
-dist
-.cache
+*$py.class
 __pycache__
 
-htmlcov
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# jupyter notebook
+.ipynb_checkpoints
+
+# Unit test / coverage reports
+htmlcov/
 .coverage
+.coverage.*
 coverage.xml
+.cache
 .pytest_cache
-.tox
+.tox/
 
+# Sphinx documentation
 docs/_build
 
 # ide
-.idea
-.eclipse
-.vscode
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+.spyderproject
+.spyproject
 
 # Mac
 .DS_Store
 
 # virtual environments
 env
+.env
 env3
+.env3
 venv
+.venv
 venv3
+.venv3
+ENV/
+env.bak/
+venv.bak/
 
-.swp
+# vim
+*.swp
+*.swo
+*.orig

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 }}"
@@ -71,8 +72,10 @@ Repository = "{{ repository_url }}"
 Issues = "{{ repository_url }}/issues"
 {% if AddChangeLog -%}
 Changelog = "{{ repository_url }}/CHANGELOG.md"
-{%- endif %}
-
+{% endif -%}
+{% if AddOnlineDocumentation -%}
+ReadTheDocs = "https://{{ package_name }}.readthedocs.io"
+{% endif %}
 [tool.pytest.ini_options]
 testpaths = ["tests"]