Skip to content

Add github username field to the questions for the README badges #203

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+5 −3
Open

Add github username field to the questions for the README badges #203

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f2c5cfa
Update README.md
cabb99 May 20, 2025
35892c0
Adds github account to the template questions
cabb99 May 20, 2025
eb2171a
Updates test
cabb99 May 20, 2025
e6f6d34
Adds owner_account replacement to source in project.urls
cabb99 Jun 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions cookiecutter.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"first_module_name": "{{ cookiecutter.repo_name.lower().replace(' ', '_') }}",
"author_name": "Your name (or your organization/company/team)",
"author_email": "Your email (or your organization/company/team)",
"owner_account": "Your github user name (or the organization/company/team)",
"description": "A short description of the project (less than one line).",
"open_source_license": [

Expand Down
1 change: 1 addition & 0 deletions tests/setup_cookiecutter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
project, # First module name
"cookie monster", # Author name
"cookiemonster@trash.can", # Author email
"cookie_monster", #Author github username
"", # Description
lic, # License
provider, # ci_provider
Expand Down
4 changes: 2 additions & 2 deletions {{cookiecutter.repo_name}}/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{{cookiecutter.project_name}}
==============================
[//]: # (Badges)
[![GitHub Actions Build Status](https://github.com/REPLACE_WITH_OWNER_ACCOUNT/{{cookiecutter.repo_name}}/workflows/CI/badge.svg)](https://github.com/REPLACE_WITH_OWNER_ACCOUNT/{{cookiecutter.repo_name}}/actions?query=workflow%3ACI)
[![codecov](https://codecov.io/gh/REPLACE_WITH_OWNER_ACCOUNT/{{cookiecutter.project_name}}/branch/main/graph/badge.svg)](https://codecov.io/gh/REPLACE_WITH_OWNER_ACCOUNT/{{cookiecutter.project_name}}/branch/main)
[![GitHub Actions Build Status](https://github.com/{{cookiecutter.owner_account}}/{{cookiecutter.repo_name}}/workflows/CI/badge.svg)](https://github.com/{{cookiecutter.owner_account}}/{{cookiecutter.repo_name}}/actions?query=workflow%3ACI)
[![codecov](https://codecov.io/gh/{{cookiecutter.owner_account}}/{{cookiecutter.project_name}}/branch/main/graph/badge.svg)](https://codecov.io/gh/{{cookiecutter.owner_account}}/{{cookiecutter.project_name}}/branch/main)


{{cookiecutter.description}}
Expand Down
2 changes: 1 addition & 1 deletion {{cookiecutter.repo_name}}/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ requires-python = ">=3.8"

# Update the urls once the hosting is set up.
#[project.urls]
#"Source" = "https://github.com/<username>/{{cookiecutter.repo_name}}/"
#"Source" = "https://github.com/{{cookiecutter.owner_account}}/{{cookiecutter.repo_name}}/"
#"Documentation" = "https://{{cookiecutter.repo_name}}.readthedocs.io/"

[project.optional-dependencies]
Expand Down