Skip to content

Commit f09c541

Browse files
committed
added two cookiecutter questions to collect keywords
1 parent d65865e commit f09c541

4 files changed

Lines changed: 9 additions & 2 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,8 @@ cookiecutter https://github.com/nlesc/python-template.git
6161
| package_name | my_python_package | Name of the package. Avoid using spaces, dashes, or uppercase letters for the best experience across operating systems. |
6262
| 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. |
6363
| 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. |
64+
| keyword1 | keyword1 | A term that describes your package |
65+
| keyword2 | keyword2 | Another term that describes your package |
6466
| version | 0.1.0 |   |
6567
| github_organization | <my-github-organization> | GitHub organization that will contain this project's repository. This can also be your GitHub user name. |
6668
| license | Apache Software License 2.0 | The software license under which the code is made available. |

cookiecutter.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
"project_name": "my-python-project",
44
"_copy_without_render": [".github/workflows/*"],
55
"package_short_description": "",
6+
"keyword1": "keyword1",
7+
"keyword2": "keyword2",
68
"version": "0.1.0",
79
"github_organization": "<my-github-organization>",
810
"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}}/CITATION.cff

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ doi: <insert your DOI here>
1212
version: "{{ cookiecutter.version }}"
1313
repository-code: "{{ cookiecutter.repository }}"
1414
keywords:
15-
- keyword1
16-
- keyword2
15+
- {{ cookiecutter.keyword1 }}
16+
- {{ cookiecutter.keyword2 }}
1717
message: "If you use this software, please cite it using these metadata."
1818
{{ { "Apache Software License 2.0": "license: Apache-2.0",
1919
"MIT license": "license: MIT",

{{cookiecutter.project_name}}/setup.cfg

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ classifiers =
2323
Programming Language :: Python :: 3.8
2424
Programming Language :: Python :: 3.9
2525
description = {{ cookiecutter.package_short_description }}
26+
keywords =
27+
{{ cookiecutter.keyword1 }}
28+
{{ cookiecutter.keyword2 }}
2629
long_description = file: README.md
2730
long_description_content_type = text/markdown
2831
name = {{ cookiecutter.package_name }}

0 commit comments

Comments
 (0)