Merge pull request #273 from NLeSC/270-cookiecutter-keywords

added two cookiecutter questions to collect keywords

Author: jspaaks

README.md

@@ -61,6 +61,8 @@ cookiecutter https://github.com/nlesc/python-template.git
 | package_name              | my_python_package | Name of the package. Avoid using spaces, dashes, or uppercase letters for the best experience across operating systems. |
 | project_name              | my-python-project | Name of the project that contains the package. Avoid using spaces or uppercase letters for the best experience across operating systems. |
 | package_short_description |              | The information that you enter here will end up in the README, documentation, license, and setup.cfg, so it may be a good idea to prepare something in advance. |
+| keyword1                  | keyword1          | A term that describes your package. |
+| keyword2                  | keyword2          | Another term that describes your package. |
 | version                   | 0.1.0             |   |
 | github_organization       | <my-github-organization> | GitHub organization that will contain this project's repository. This can also be your GitHub user name. |
 | license                   | Apache Software License 2.0 | The software license under which the code is made available.  |

cookiecutter.json

@@ -3,6 +3,8 @@
   "project_name": "my-python-project",
   "_copy_without_render": [".github/workflows/*"],
   "package_short_description": "",
+  "keyword1": "keyword1",
+  "keyword2": "keyword2",
   "version": "0.1.0",
   "github_organization": "<my-github-organization>",
   "license": ["Apache Software License 2.0", "MIT license", "BSD license", "ISC license", "GNU General Public License v3 or later", "Not open source"],

{{cookiecutter.project_name}}/.github/next_steps/04_citation.md

@@ -9,7 +9,7 @@ It is likely that your `CITATION.cff` currently doesn't pass validation. The err
 - [ ] Add more authors if needed
 - [ ] Update `date-released` using the YYYY-MM-DD format.
 - [ ] Update the `doi` key with the conceptDOI for your repository (see [https://help.zenodo.org](https://help.zenodo.org/) for more information on what a conceptDOI is). If your project doesn't have a DOI yet, you can use the string `10.0000/FIXME` to pass validation.
-- [ ] Update the `keywords` array with some keywords of your own that describe your project.
+- [ ] Verify that the `keywords` array accurately describes your project.
 
 Once you do all the steps above, the `cffconvert` workflow will tell you what content it expected to see in `.zenodo.json`. Copy-paste from the GitHub Action log into a new file `.zenodo.json`. Afterwards, the `cffconvert` GitHub Action should be green.
 

{{cookiecutter.project_name}}/CITATION.cff

@@ -12,8 +12,8 @@ doi: <insert your DOI here>
 version: "{{ cookiecutter.version }}"
 repository-code: "{{ cookiecutter.repository }}"
 keywords:
-  - keyword1
-  - keyword2
+  - {{ cookiecutter.keyword1 }}
+  - {{ cookiecutter.keyword2 }}
 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",

{{cookiecutter.project_name}}/setup.cfg

@@ -23,6 +23,9 @@ classifiers =
     Programming Language :: Python :: 3.8
     Programming Language :: Python :: 3.9
 description = {{ cookiecutter.package_short_description }}
+keywords =
+    {{ cookiecutter.keyword1 }}
+    {{ cookiecutter.keyword2 }}
 long_description = file: README.md
 long_description_content_type = text/markdown
 name = {{ cookiecutter.package_name }}