cookiecutter -> Copier transition

Author: ebolyen

.github/workflows/ci.yml

@@ -25,15 +25,17 @@ jobs:
     - name: install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install -q cookiecutter
+        pip install -q pipx
+        pipx install copier
+        pipx inject copier copier_templates_extensions
         pip install -q flake8
         pip install -q https://github.com/qiime2/q2lint/archive/master.zip
 
     - name: build plugin from default template
       run: |
         git config --global user.email "q2dev@example.com"
         git config --global user.name "A QIIME 2 Plugin Developer"
-        cookiecutter . --no-input
+        copier copy --defaults --trust . .
 
     - name: Set up Conda
       uses: conda-incubator/setup-miniconda@v3
@@ -49,6 +51,11 @@ jobs:
         cd q2-hello-world
         make install
 
+    - name: Call info on the deployment
+      shell: bash -l {0}
+      run: |
+        qiime info
+
     - name: Call --help on plugin
       shell: bash -l {0}
       run: |

README.md

@@ -1,6 +1,6 @@
-# QIIME 2 Plugin [Cookiecutter](https://cookiecutter.readthedocs.io/) template
+# QIIME 2 Plugin [Copier](https://copier.readthedocs.io) template
 
-This is a cookiecutter template for creating new QIIME 2 plugins.
+This is a Copier template for creating new QIIME 2 plugins.
 To learn how to use this, refer to the [Plugin Development Tutorial](https://develop.qiime2.org/en/latest/plugins/tutorials/intro.html) in *Developing with QIIME 2* (https://develop.qiime2.org).
 Specific usage instructions can be found [here](https://develop.qiime2.org/en/latest/plugins/tutorials/create-from-template.html).
 

cookiecutter.json

@@ -0,0 +1,58 @@
+# Prompts
+package_name:
+  default: q2-hello-world
+  help: Package name (e.g., used as the top-level directory name)
+module_name:
+  default: "{{ package_name.replace('-', '_') }}"
+  help: Module name (must be a valid Python identifier)
+  validator: >-
+    {% if not module_name.isidentifier()  %}
+    The module name must be a valid Python identifier.
+    {% endif %}
+plugin_name:
+  default: "{{ package_name.removeprefix('q2-') }}"
+  help: Plugin name (often a shortened version of the package name)
+author_name:
+  default: A QIIME 2 Plugin Developer
+  help: Author name
+author_email:
+  default: q2-dev@example.com
+  help: Author email
+project_url:
+  default: https://example.com
+  help: Main plugin website
+plugin_description:
+  default: A QIIME 2 plugin template.
+  help: Longer description, shown when information is requested on plugin
+plugin_short_description:
+  default: Plugin template.
+  help: Shorter description, shown when plugin is presented in a list
+target_distro:
+  default: tiny
+  choices: [tiny, amplicon, metagenome]
+  help: Target distribution (if you're not sure, stick with the default).
+dev_target:
+  default: stable
+  choices: [stable, latest]
+  help: Do you want to test against the current release (stable) or the upcoming release (latest).
+license:
+  default: skip-license
+  choices: [BSD-3-Clause, MIT, Apache-2.0, skip-license]
+  help: Some common open source licenses. Use "skip-license" to use a custom license (or retain all rights).
+
+# Config
+_templates_suffix: ""
+_tasks:
+  - command: >-
+      cd "{{ package_name }}" &&
+      git init &&
+      git add . &&
+      git commit \
+        -m "initial commit" \
+        -m "Created from https://github.com/caporaso-lab/cookiecutter-qiime2-plugin." \
+        -m "See https://develop.qiime2.org to learn more."
+    when: "{{ has_git and first_run }}"
+_subdirectory: template/
+_jinja_extensions:
+    - copier_templates_extensions.TemplateExtensionLoader
+    - extensions/context.py:ContextUpdater

copier.yaml

@@ -0,0 +1,43 @@
+import urllib.request
+import subprocess
+
+import yaml
+from copier_templates_extensions import ContextHook
+
+# Download the data only once (because of sys.module cache),
+# instead of on each template event.
+DIST_DATA = 'https://raw.githubusercontent.com/qiime2/distributions/dev/data.yaml'
+with urllib.request.urlopen(DIST_DATA) as response:
+    yaml_file = response.read()
+    distributions_data = yaml.safe_load(yaml_file)
+
+
+def _check_git_installed():
+    try:
+        _ = subprocess.run("git --version",
+                           shell=True, check=True, capture_output=True)
+    except subprocess.CalledProcessError:
+        return False
+    return True
+
+
+class ContextUpdater(ContextHook):
+    def hook(self, context):
+        if context["_copier_phase"] == "prompt": return {}
+
+        stable_epoch = distributions_data['released_epoch']
+        latest_epoch = distributions_data['active_epoch']
+
+        target = context["dev_target"]
+        if target == 'stable':
+            target_epoch = stable_epoch
+        else:
+            target_epoch = latest_epoch
+
+        update = {
+            "target_epoch": target_epoch,
+            "has_git": _check_git_installed(),
+            "first_run": not (context['_copier_conf']['dst_path']
+                              / context['package_name'] / '.git/').exists()
+        }
+        return update

extensions/context.py

@@ -7,7 +7,7 @@ on:
     branches: ["main"]
 
 jobs:
-  build-and-test-qiime2-{{ cookiecutter.target_distro }}-{{ cookiecutter.target_epoch.replace('.', '-') }}:
+  build-and-test-qiime2-{{ target_distro }}-{{ target_epoch.replace('.', '-') }}:
     runs-on: ${{ '{{' }} matrix.os {{ '}}' }}
     strategy:
       matrix:
@@ -19,8 +19,8 @@ jobs:
     - name: Set up Conda
       uses: conda-incubator/setup-miniconda@v3
       with:
-        activate-environment: {{ cookiecutter.package_name }}-qiime2-{{ cookiecutter.target_distro }}-{{ cookiecutter.target_epoch }}
-        environment-file: environment-files/{{ cookiecutter.package_name }}-qiime2-{{ cookiecutter.target_distro }}-{{ cookiecutter.target_epoch }}.yml
+        activate-environment: {{ package_name }}-qiime2-{{ target_distro }}-{{ target_epoch }}
+        environment-file: environment-files/{{ package_name }}-qiime2-{{ target_distro }}-{{ target_epoch }}.yml
         auto-activate-base: false
 
     - name: Install plugin