Skip to content
This repository was archived by the owner on Jul 29, 2024. It is now read-only.

Commit f374fe0

Browse files
Updates based on demo feedback (#12)
2 parents d5c690e + 162a54f commit f374fe0

File tree

3 files changed

+10
-8
lines changed

3 files changed

+10
-8
lines changed

src/PythonProjectBootstrapper/package/cookiecutter.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@
3131
"email": "\n\nPlease enter your email address.\n\nThis value will be used in:\n - Metadata for the generated python package\n - Metadata for the generated python binary\n\n",
3232
"project_description": "\n\nPlease enter a short description of your project (less than 100 characters).\n\nThis value will be used in:\n - Metadata for the generated python package\n - Metadata for the generated python binary\n\n",
3333
"license": "\n\nPlease enter the license you would like to use for your project. https://choosealicense.com/ is a\ngood resource that helps you choose the best license for your project.\n\nThis value will be used in:\n - Population of the License.txt file (or equivalent)\n - The copyright header for source files\n - Metadata for the generated python package\n - Metadata for the generated python binary\n - Metadata for the generated docker image (if applicable)\n\n",
34-
"github_url": "\n\nPlease enter the GitHub URL. The default value should be used unless you are running on an GitHub\nEnterprise instance.\n\n https://github.com/username/projectname\n ^^^^^^^^^^^^^^^^^^\n This is the GitHub URL\n\n",
35-
"github_username": "\n\nPlease enter your GitHub username.\n\n https://github.com/username/projectname\n ^^^^^^^^\n This is the GitHub username\n\n",
36-
"github_project_name": "\n\nPlease enter the name of your GitHub project that corresponds to the output directory.\n\n https://github.com/username/projectname\n ^^^^^^^^^^^\n This is the GitHub project name\n\n",
34+
"github_url": "\n\nPlease enter the GitHub URL. You should use the URL to your GitHub repository as a guide when\nspecifying this value.\n\n https://github.com/username/projectname\n ^^^^^^^^^^^^^^^^^^\n This is the GitHub URL\n\n",
35+
"github_username": "\n\nPlease enter your GitHub username. You should use the URL to your GitHub repository as a guide when\nspecifying this value.\n\n https://github.com/username/projectname\n ^^^^^^^^\n This is the GitHub username\n\n",
36+
"github_project_name": "\n\nPlease enter your GitHub project name. You should use the URL to your GitHub repository as a guide\nwhen specifying this value.\n\n https://github.com/username/projectname\n ^^^^^^^^^^^\n This is the GitHub project name\n\n",
3737
"pypi_project_name": "\n\nPlease enter the name of your project as it will appear on PyPI (https://pypi.org). This\nname cannot be associated with any other project on PyPI.\n\n",
3838
"gist_id": "\n\nPlease enter the GitHub gist id for use with this project.\n\nGitHub defines a gist as \"a simple way to share snippets and pastes with others.\" The generated\npython project will use a gist to store information dynamically generated during the build (for\nexample code coverage information) that can be retrieved at a later time (for example, to display\na code coverage badge in the project's README.md file).\n\nTo create a gist:\n 1. Go to https://gist.github.com/\n 2. Enter the following values in their respective fields:\n\n Gist description...: Gist used by GitHub Action workflows to store and retrieve dynamic information (oftentimes used to create and display badges).\n Filename including extension...: README.md\n File contents: Gist used by GitHub Action workflows to store and retrieve dynamic information (oftentimes used to create and display badges).\n\n 3. Click the \"Create secret gist\" button\n 4. Copy the gist id (this will be the hex string at the end of the url associated with the gist\n that was just created). It will look something like:\n\n https://gist.github.com/<github username>/4c10281ff1abc26cafcb9a5f9a8a443e\n ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n This is the gist id\n\n",
3939
"gist_username": "\n\nPlease enter the username associated with your gist_id. In most cases, this will be the same as your GitHub username.",

src/PythonProjectBootstrapper/package/cookiecutter_prompts.yaml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,22 +34,24 @@ license: |-
3434
- Metadata for the generated docker image (if applicable)
3535
3636
github_url: |-
37-
Please enter the GitHub URL. The default value should be used unless you are running on an GitHub
38-
Enterprise instance.
37+
Please enter the GitHub URL. You should use the URL to your GitHub repository as a guide when
38+
specifying this value.
3939
4040
https://github.com/username/projectname
4141
^^^^^^^^^^^^^^^^^^
4242
This is the GitHub URL
4343
4444
github_username: |-
45-
Please enter your GitHub username.
45+
Please enter your GitHub username. You should use the URL to your GitHub repository as a guide when
46+
specifying this value.
4647
4748
https://github.com/username/projectname
4849
^^^^^^^^
4950
This is the GitHub username
5051
5152
github_project_name: |-
52-
Please enter the name of your GitHub project that corresponds to the output directory.
53+
Please enter your GitHub project name. You should use the URL to your GitHub repository as a guide
54+
when specifying this value.
5355
5456
https://github.com/username/projectname
5557
^^^^^^^^^^^

src/PythonProjectBootstrapper/package/hooks/post_gen_project.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ def UpdateLicenseFile():
179179
# ----------------------------------------------------------------------
180180
def DisplayPrompts():
181181
border_colors = itertools.cycle(
182-
["red", "green", "yellow", "blue", "magenta", "cyan"],
182+
["green", "yellow", "blue", "magenta", "cyan"],
183183
)
184184

185185
for prompt_index, (title, prompt) in enumerate(_prompts.items()):

0 commit comments

Comments
 (0)