From 24a9c9dfcebe745ae94407a47a9ce583f44e6b4b Mon Sep 17 00:00:00 2001 From: Matt Graham Date: Tue, 4 Jun 2024 09:43:41 +0100 Subject: [PATCH 1/6] Adding longer prompts for all cookiecutter options --- cookiecutter.json | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/cookiecutter.json b/cookiecutter.json index 3c02295c..be93b6aa 100644 --- a/cookiecutter.json +++ b/cookiecutter.json @@ -14,6 +14,19 @@ "license": ["MIT", "BSD-3", "GPL-3.0"], "funder": "JBFC: The Joe Bloggs Funding Council", "__prompts__": { - "deploy_docs_to_github_pages": "Enable automatically deploying HTML documentation to GitHub Pages website on pushes to main" + "author_given_names": "Given name(s) of package author", + "author_family_names": "Family name(s) of package author", + "author_email": "Email address for package author - will be publicly accessible", + "project_name": "Name for project - may contain spaces", + "project_slug": "'Slugified' project name for use in URLs - recommended to be all lower case with hyphens as word separator", + "package_name": "Name for Python package - recommended to be all lowercase with underscores as word separator", + "project_short_description": "Short description of the project and package", + "initialise_git_repository": "Initialise generated package directory as a Git repository", + "deploy_docs_to_github_pages": "Enable automatically deploying HTML documentation to GitHub Pages website on pushes to main", + "github_username": "GitHub user or organization which will be owner of repository if deploying to GitHub", + "min_python_version": "Minimum Python version supported by package", + "max_python_version": "Maximum Python version supported by package", + "license": "Which open-source license to release package under", + "funder": "Any organisation(s) to acknowledge for contibruting to funding of package development" } } From 32010245b1d2c7d352a1afedf90b867375d8cb12 Mon Sep 17 00:00:00 2001 From: Matt Graham Date: Tue, 4 Jun 2024 11:01:26 +0100 Subject: [PATCH 2/6] Use shorter prompts and update some default placeholders --- cookiecutter.json | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/cookiecutter.json b/cookiecutter.json index be93b6aa..13709f4a 100644 --- a/cookiecutter.json +++ b/cookiecutter.json @@ -2,10 +2,10 @@ "author_given_names": "Eva Lu", "author_family_names": "Ator", "author_email": "eva.lu.ator@ucl.ac.uk", - "project_name": "Python Template", + "project_name": "Cookiecutter package", "project_slug": "{{cookiecutter.project_name.lower().replace(' ', '-').replace('_', '-')}}", "package_name": "{{cookiecutter.project_slug.replace('-', '_')}}", - "project_short_description": "A cookiecutter template with ARC recommendations.", + "project_short_description": "A cookiecutter package with UCL ARC recommendations.", "initialise_git_repository": true, "deploy_docs_to_github_pages": false, "github_username": "{{cookiecutter.author_given_names.lower().replace(' ', '-')}}-{{cookiecutter.author_family_names.lower().replace(' ', '-')}}", @@ -18,15 +18,15 @@ "author_family_names": "Family name(s) of package author", "author_email": "Email address for package author - will be publicly accessible", "project_name": "Name for project - may contain spaces", - "project_slug": "'Slugified' project name for use in URLs - recommended to be all lower case with hyphens as word separator", - "package_name": "Name for Python package - recommended to be all lowercase with underscores as word separator", - "project_short_description": "Short description of the project and package", - "initialise_git_repository": "Initialise generated package directory as a Git repository", - "deploy_docs_to_github_pages": "Enable automatically deploying HTML documentation to GitHub Pages website on pushes to main", - "github_username": "GitHub user or organization which will be owner of repository if deploying to GitHub", + "project_slug": "'Slugified' project name for use in URLs - dash-case recommended", + "package_name": "Name for Python package - snake_case recommended", + "project_short_description": "Short description of the project", + "initialise_git_repository": "Initialise project directory as a Git repository", + "deploy_docs_to_github_pages": "Automatically deploy HTML docs to GitHub Pages on pushes to main", + "github_username": "GitHub user/organization which will be owner of repository", "min_python_version": "Minimum Python version supported by package", "max_python_version": "Maximum Python version supported by package", "license": "Which open-source license to release package under", - "funder": "Any organisation(s) to acknowledge for contibruting to funding of package development" + "funder": "Organisation(s) to acknowledge for funding of package development" } } From 0eb617b069241f73d6c106a8432324511c7a33aa Mon Sep 17 00:00:00 2001 From: Matt Graham Date: Tue, 4 Jun 2024 11:08:00 +0100 Subject: [PATCH 3/6] Restore default Python template project name --- cookiecutter.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cookiecutter.json b/cookiecutter.json index 13709f4a..0921ad79 100644 --- a/cookiecutter.json +++ b/cookiecutter.json @@ -2,7 +2,7 @@ "author_given_names": "Eva Lu", "author_family_names": "Ator", "author_email": "eva.lu.ator@ucl.ac.uk", - "project_name": "Cookiecutter package", + "project_name": "Python template", "project_slug": "{{cookiecutter.project_name.lower().replace(' ', '-').replace('_', '-')}}", "package_name": "{{cookiecutter.project_slug.replace('-', '_')}}", "project_short_description": "A cookiecutter package with UCL ARC recommendations.", From bd6ab0e4c257a2d693f87c06353a69a15a509d3c Mon Sep 17 00:00:00 2001 From: Matt Graham Date: Tue, 4 Jun 2024 11:09:52 +0100 Subject: [PATCH 4/6] Restore use of title case in default project name --- cookiecutter.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cookiecutter.json b/cookiecutter.json index 0921ad79..1ae9f751 100644 --- a/cookiecutter.json +++ b/cookiecutter.json @@ -2,7 +2,7 @@ "author_given_names": "Eva Lu", "author_family_names": "Ator", "author_email": "eva.lu.ator@ucl.ac.uk", - "project_name": "Python template", + "project_name": "Python Template", "project_slug": "{{cookiecutter.project_name.lower().replace(' ', '-').replace('_', '-')}}", "package_name": "{{cookiecutter.project_slug.replace('-', '_')}}", "project_short_description": "A cookiecutter package with UCL ARC recommendations.", From 75437b644f07da7f58c8a2edbb7bafcc5d804688 Mon Sep 17 00:00:00 2001 From: Matt Graham Date: Tue, 4 Jun 2024 16:48:33 +0100 Subject: [PATCH 5/6] Shorten funder prompt --- cookiecutter.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cookiecutter.json b/cookiecutter.json index 1ae9f751..560efdc2 100644 --- a/cookiecutter.json +++ b/cookiecutter.json @@ -27,6 +27,6 @@ "min_python_version": "Minimum Python version supported by package", "max_python_version": "Maximum Python version supported by package", "license": "Which open-source license to release package under", - "funder": "Organisation(s) to acknowledge for funding of package development" + "funder": "Organisation(s) to acknowledge for funding of project" } } From 251961f151f544a47db8552b9b639922f83c079d Mon Sep 17 00:00:00 2001 From: Matt Graham Date: Wed, 5 Jun 2024 17:49:14 +0100 Subject: [PATCH 6/6] Apply suggestions from code review Co-authored-by: David Stansby --- cookiecutter.json | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/cookiecutter.json b/cookiecutter.json index 560efdc2..0ec46ab9 100644 --- a/cookiecutter.json +++ b/cookiecutter.json @@ -16,14 +16,14 @@ "__prompts__": { "author_given_names": "Given name(s) of package author", "author_family_names": "Family name(s) of package author", - "author_email": "Email address for package author - will be publicly accessible", - "project_name": "Name for project - may contain spaces", + "author_email": "Email address for package author - will be part of package metadata.", + "project_name": "Name of project - may contain spaces", "project_slug": "'Slugified' project name for use in URLs - dash-case recommended", "package_name": "Name for Python package - snake_case recommended", "project_short_description": "Short description of the project", - "initialise_git_repository": "Initialise project directory as a Git repository", - "deploy_docs_to_github_pages": "Automatically deploy HTML docs to GitHub Pages on pushes to main", - "github_username": "GitHub user/organization which will be owner of repository", + "initialise_git_repository": "Initialise project directory as a Git repository?", + "deploy_docs_to_github_pages": "Automatically deploy HTML docs to GitHub Pages on pushes to main?", + "github_username": "GitHub user or organization name which will be owner of repository", "min_python_version": "Minimum Python version supported by package", "max_python_version": "Maximum Python version supported by package", "license": "Which open-source license to release package under",