Merge pull request #399 from NLeSC/dev

Migration from cookiecutter to copier template

Author: lyashevska

…ectory_name}}/docs/_templates/.gitignore .copier-answers.yml{{cookiecutter.directory_name}}/docs/_templates/.gitignore renamed to .copier-answers.yml {{cookiecutter.directory_name}}/docs/_templates/.gitignore renamed to .copier-answers.yml

@@ -7,5 +7,5 @@ assignees: ''
 
 ---
 <!--
-Whatever you write here must have something to do with the code you get from running `cookiecutter`.
+Whatever you write here must have something to do with the code you get from running `copier`.
 -->

.github/ISSUE_TEMPLATE/10_generated_package.md

@@ -7,5 +7,5 @@ assignees: ''
 
 ---
 <!--
-Whatever you write here must have something to do with the code of the template itself, i.e. before you run `cookiecutter`.
+Whatever you write here must have something to do with the code of the template itself, i.e. before you run `copier`.
 -->

.github/ISSUE_TEMPLATE/20_template.md

@@ -16,15 +16,18 @@
 <!-- remove what doesn't apply or add more if needed -->
 Create a `python-template-test` repo on GitHub (will be overwritten if existing)
 ```
+# Create a temporary directory by running the following command. Keep the XXXXXX in the directory name. 
 cd $(mktemp -d --tmpdir py-tmpl-XXXXXX)
-cookiecutter -c <pr-branch> https://github.com/<pr-user>/python-template
+# Use --vcs-ref <pr-branch> to point to the branch you want to test
+copier copy --vcs-ref <pr-branch> https://github.com/<pr-user>/python-template .
 # Fill with python-template-test info
-cd python-template-test
+# Create a local git repo to push to GitHub to trigger CI actions
 git init
 git add --all
 git commit -m "First commit"
-git remote add origin https://github.com/<you>/python-template-test
+git remote add origin git@github.com:<you>/python-template-test.git
 git push -u origin main -f
+# Create a local environment to test your generated package locally
 python -m venv env
 source env/bin/activate
 python -m pip install --upgrade pip setuptools

.github/PULL_REQUEST_TEMPLATE.md

@@ -26,3 +26,5 @@ env
 env3
 venv
 venv3
+
+.swp

.gitignore

@@ -72,7 +72,7 @@ cff-version: "1.2.0"
 date-released: 2018-07-17
 doi: 10.5281/zenodo.1310751
 keywords:
-  - cookiecutter
+  - copier
   - template
   - Python
 license: Apache-2.0

ADD_TO_EXISTING_PACKAGE.md

@@ -1,2 +1,2 @@
-NLeSC Cookiecutter template for Python
+NLeSC Copier template for Python
 Copyright 2021, Netherlands eScience Center

CITATION.cff

@@ -4,15 +4,17 @@ If you're looking for user documentation, go [here](README.md).
 
 ## Development install
 
-### Install `cookiecutter` in user space
+### Install `copier` in user space
 
-We recommend installing `cookiecutter` in user space as per `cookiecutter`'s instructions. This way, you don't have to
-install `cookiecutter` for every new project.
+We recommend installing `copier` in user space. This way, you don't have to
+install `copier` for every new project.
 
 ```shell
-python -m pip install --user --upgrade cookiecutter
+python -m pip install --user --upgrade copier
 ```
 
+
+
 ### Get your own copy of the repository
 
 Before you can do development work on the template, you'll need to check out a local copy of the repository:
@@ -23,6 +25,13 @@ git clone https://github.com/NLeSC/python-template.git
 cd python-template
 ```
 
+Please note that if you are working from some other branch than `main`, you should switch to that branch. For example, if you are working from the `dev` branch, you should do: 
+
+```shell
+git fetch origin
+git switch -c dev origin/dev
+```
+
 ### Create a virtual environment
 
 Next, make a virtual environment, activate it, and install the development dependencies in it. This will enable you to 
@@ -53,27 +62,28 @@ pytest
 pytest tests/
 ```
 
-## Using `cookiecutter` to generate a new package from the command line
+## Using `copier` to generate a new package from the command line
 
 While making changes to the template, you'll regularly want to verify that the packages generated with the template
 still work. Any easy way to do this is to generate new packages in a temporary directory (which will get removed
 everytime you reboot), for example like so:
 
 ```shell
 # change directory to a new temporary directory
-cd $(mktemp -d --tmpdir cookiecutter-generated.XXXXXX)
+cd $(mktemp -d --tmpdir copier-generated.XXXXXX)
 
-# run cookiecutter with the template to generate a new package
-cookiecutter <path to where your template is>
+# run copier with the template to generate a new package
+copier copy --vcs-ref HEAD  <path/to/project/template> my-python-project
 
 # when it asks you for the GitHub organization, put in your own name;
 # for the other questions, just accept the default
 
 # 'ls' should return just the one directory called 'my-python-project'
 ls 
 ```
+Notice, that the `--vcs-ref HEAD` flag is used to make sure that the current checked out version of the local template is used.
 
-If your Python package was created successfully, `cookiecutter` will point you to a file
+If your Python package was created successfully, `copier` will point you to a file
 (`my-python-project/next_steps.md`) that contains information on next steps.
 
 In addition to the information in `my-python-project/project_setup.md`, the developer documentation
@@ -95,7 +105,7 @@ Follow the instructions from `my-python-project/README.dev.md` and make sure tha
 2. Verify that the information in `CITATION.cff` is correct.
 3. Make sure that `version` in [setup.cfg](setup.cfg) and  `version` in [CITATION.cff](CITATION.cff) have been bumped to the to-be-released version of the template
 4. Run the unit tests with `pytest tests/`
-5. Go through the steps outlined above for [generating a new package from the command line](#using-cookiecutter-to-generate-a-new-package-from-the-command-line), and verify that the generated package works as it should.
+5. Go through the steps outlined above for [generating a new package from the command line](#using-copier-to-generate-a-new-package-from-the-command-line), and verify that the generated package works as it should.
 
 ### GitHub