enh(user experience): reorganize copier.yml template

enh: rename use_Default

Author: lwasser

copier.yml

@@ -1,10 +1,26 @@
+# This is the quick exit option for the template. It defaults to
+# basic package setup (and we will add basic tests and docs)
+template_mode:
+  type: str
+  help: |
+    "Welcome to the pyOpenSci package template.
+    Please select the type of template that you want to create today."
+  choices:
+    "Yes, but with a minimal setup (package, tests and docs; typing, linting not included).": "minimal"
+    "I want to use the default settings but I want it setup for me. ": "full"
+    "I want it all but I want to fully customize all elements of the template.": "custom" # changed from no to to custom
+
+  default: "minimal"
+
+############### Basic Information ###################
+
 copyright_holder:
   type: str
   help: "Who is the copyright holder, for example, yourself or your organization? Used in the license file and project description."
 
 author_name:
   type: str
-  help: "Who is the author of the package to be? Used in the package description."
+  help: "Who is the author of the package? Used in the package description."
   default: "{{ copyright_holder }}"
 
 author_email:
@@ -13,35 +29,48 @@ author_email:
 
 project_name:
   type: str
-  help: "What is the name of the project? Used as the title in the README.md and other places."
+  help: "What is the name of the project? Used as the README.md title, in the Docs and other places."
 
 package_description:
   type: str
   multiline: true
   help: "Please provide a short description for the package."
 
+year:
+  when: "{{ template_mode == 'custom' }}"
+  type: str
+  help: "What is the starting year of the project? Used in copyright statements."
+  default: "{{ '%Y' | strftime }}"
+
+license:
+  when: "{{ template_mode == 'custom' }}"
+  type: str
+  help: |
+    Which license do you want to use? Includes a LICENSE file in the repository root.
+    For more information, see:
+    - https://www.pyopensci.org/python-package-guide/documentation/repository-files/license-files.html
+    - https://opensource.org/licenses
+  choices:
+    "Permissive - MIT": "MIT"
+    "Permissive - BSD-3-Clause": "BSD-3-Clause"
+    "Permissive - Apache-2.0": "Apache-2.0"
+    "Copyleft - GPL-3.0": "GPL-3.0-only"
+    "Copyleft - EUPL-1.2": "EUPL-1.2"
+    "Intermediate - MPL-2.0": "MPL-2.0"
+  default: MIT
+
+############### All things related to vcs & git ###################
+
 use_git:
-  when: "{{ use_default == 'no' }}"
+  when: "{{ template_mode == 'custom' }}"
   type: bool
   default: "yes"
   help: "Do you want to use git version control with a development platform, like GitHub or GitLab?"
 
-
-# This is the quick exit option for the template. It defaults to
-# basic package setup (and we will add basic tests and docs)
-use_default:
-  type: str
-  help: "Do you want to answer one more question, and skip the rest, using the default values?"
-  choices:
-    "No, I want to fully customize the template.": "no"
-    "Yes, with all the bells and whistles.": "full"
-    "Yes, but with a minimal setup (package, tests and docs only).": "minimal"
-  default: "minimal"
-
 dev_platform:
-  when: "{{ use_default == 'no' and use_git }}"
+  when: "{{ template_mode == 'custom' and use_git }}"
   type: str
-  help: "Which development platform are you planning to use? Used to generate certain documentation and hyperlinks."
+  help: "Which development platform are you planning to use? Used in documentation links."
   choices:
     - "GitHub"
     - "GitLab"
@@ -52,103 +81,89 @@ username:
   type: str
   help: "Provide you or your organization's {{ dev_platform }} username. Used to generate certain documentation and hyperlinks."
 
-
-documentation:
-  when: "{{ use_default == 'no' }}"
+dev_platform_url:
   type: str
-  help: "Do you want to include documentation for your project and which framework do you want to use?"
-  choices:
-    "Sphinx (https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html)": sphinx
-    "mkdocs-material (https://squidfunk.github.io/mkdocs-material)": mkdocs
-    "No, I don't need documentation for my project.": "no"
-  default: "{% if use_default != 'no' %}sphinx{% endif %}"
+  when: false
+  default: "https://{{ dev_platform|lower }}.com"
 
-use_rtd:
-  when: "{{ use_default == 'no' }}"
-  type: bool
-  default: "{% if use_default != 'minimal' %}yes{% else %}no{% endif %}"
-  help: "Do you want to read the docs to publish your documentation?"
+############### Things related to packaging ###################
 
 project_slug:
-  when: "{{ use_default == 'no' }}"
+  when: "{{ template_mode == 'custom' }}"
   type: str
   help: "What is the project slug? Used in hyperlinks."
   default: "{{ project_name|lower|replace(' ', '-') }}"
 
 package_name:
-  when: "{{ use_default == 'no' }}"
+  when: "{{ template_mode == 'custom' }}"
   type: str
   help: "What is the Python package name? Used as the name of the package and the top-level import."
   default: "{{ project_slug|replace('-', '_') }}"
 
 use_vcs_version:
-  when: "{{ use_default == 'no' }}"
+  when: "{{ template_mode == 'custom' }}"
   type: bool
-  default: "{% if use_default != 'minimal' %}yes{% else %}no{% endif %}"
+  default: "{% if template_mode != 'minimal' %}yes{% else %}no{% endif %}"
   help: "Do you want to use dynamic versioning of your package or static? Dynamic means that versions use your version control system (VCS), such as git tags, for creating versions."
 
-dev_platform_url:
-  type: str
-  when: false
-  default: "https://{{ dev_platform|lower }}.com"
-
 python_package_name:
   type: str
   when: false
   default: "{{ project_slug|lower|replace('-', '_') if project_slug else project_name|lower|replace('-', '_') }}"
 
+############### Things related to docs ###################
+
+documentation:
+  when: "{{ template_mode == 'custom' }}"
+  type: str
+  help: "Do you want to include documentation for your project and which framework do you want to use?"
+  choices:
+    "Sphinx (https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html)": sphinx
+    "mkdocs-material (https://squidfunk.github.io/mkdocs-material)": mkdocs
+    "No, I don't need documentation for my project.": "no"
+  default: "{% if template_mode != 'no' %}sphinx{% endif %}"
+
+use_rtd:
+  when: "{{ template_mode == 'custom' }}"
+  type: bool
+  default: "{% if template_mode != 'minimal' %}yes{% else %}no{% endif %}"
+  help: "Do you want to Read the Docs to publish your documentation?"
+
+################ Packaging tools and settings ###################
+
 use_hatch_envs:
-  when: "{{ use_default == 'no' }}"
+  when: "{{ template_mode == 'custom' }}"
   type: bool
   default: "yes"
-  help: "Do you want to use hatch environments for running isolated commands like linting, building docs, or testing?"
+  help: "Do you want to use hatch environments for running isolated commands like linting, building docs, and testing?"
+
+################ Linting, style, typing and format thangs ###################
 
 use_lint:
-  when: "{{ use_default == 'no' }}"
+  when: "{{ template_mode == 'custom' }}"
   type: bool
-  default: "{% if use_default != 'minimal' %}yes{% else %}no{% endif %}"
+  default: "{% if template_mode != 'minimal' %}yes{% else %}no{% endif %}"
   help: "Do you want to lint your code and check file formatting?"
 
 use_precommit:
-  when: "{{ use_default == 'no' }}"
+  when: "{{ template_mode == 'custom' }}"
   type: bool
-  default: "{% if use_default != 'minimal' %}yes{% else %}no{% endif %}"
+  default: "{% if template_mode != 'minimal' %}yes{% else %}no{% endif %}"
   help: "Do you want to pre-commit hooks to format your code on save?"
 
 use_types:
-  when: "{{ use_default == 'no' }}"
+  when: "{{ template_mode == 'custom' }}"
   type: bool
-  default: "{% if use_default != 'minimal' %}yes{% else %}no{% endif %}"
+  default: "{% if template_mode != 'minimal' %}yes{% else %}no{% endif %}"
   help: "Do you want to use typing annotations and type check your code?"
 
-# Default to a basic test suite
+############### All things related to testing ###################
+
 use_test:
-  when: "{{ use_default == 'no' }}"
+  when: "{{ template_mode == 'custom' }}"
   type: bool
   default: "yes"
   help: "Do you want to test your code? We strongly recommend that you add tests to your package."
 
-license:
-  when: "{{ use_default == 'no' }}"
-  type: str
-  help: |
-    Which license do you want to use? Includes a LICENSE file in the repository root.
-    For more information, see:
-    - https://www.pyopensci.org/python-package-guide/documentation/repository-files/license-files.html
-    - https://opensource.org/licenses
-  choices:
-    "Permissive - MIT": "MIT"
-    "Permissive - BSD-3-Clause": "BSD-3-Clause"
-    "Permissive - Apache-2.0": "Apache-2.0"
-    "Copyleft - GPL-3.0": "GPL-3.0-only"
-    "Copyleft - EUPL-1.2": "EUPL-1.2"
-    "Intermediate - MPL-2.0": "MPL-2.0"
-  default: MIT
-
-year:
-  when: "{{ use_default == 'no' }}"
-  type: str
-  help: "What is the starting year of the project? Used in copyright statements."
-  default: "{{ '%Y' | strftime }}"
 
 _subdirectory: "template"

tests/test_template_init.py

@@ -72,7 +72,7 @@ def answers() -> dict[str, str]:
         "package_description": "Wubba Lubba Dub-Dub",
         "username": "rickprime",
         "year": str(today.year),
-        "use_default": "no",
+        "template_mode": "full",
     }