Skip to content
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.

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

change default name of project #211

Closed
eriktks opened this issue Apr 21, 2021 · 3 comments
Closed

change default name of project #211

eriktks opened this issue Apr 21, 2021 · 3 comments
Assignees
Labels
template Related to the template itself, as opposed to the generated code
Milestone

Comments

@eriktks
Copy link
Member

eriktks commented Apr 21, 2021

Currently cookiecutter poposes my-python-project as project name when asking for the name. I would be more helpful for the user to have the package name as default.

This is the current output of cookiecutter:

$ cookiecutter https://github.com/nlesc/python-template.git
package_name [my_python_package]: ThisIsMyPreferredPackageName
project_name [my-python-project]: 

The second question of cookiecutter confuses me. I presume that the package is the name of the future directory with my stuff on Github and the project name is the name in the main heading in the README file? I am not sure but if that assumption is correct these two will often be the same, at least for me. In that case I would like cookiecutter to propose the entered package name as project name, like this:

$ cookiecutter https://github.com/nlesc/python-template.git
package_name [my_python_package]: ThisIsMyPreferredPackageName
project_name [ThisIsMyPreferredPackageName]: 

This helps the confused user who still might not know the difference between a package and a project but at least does not have to think about whether their names can be the same or should be different.

@eriktks eriktks added the template Related to the template itself, as opposed to the generated code label Apr 21, 2021
@fdiblen fdiblen modified the milestone: 0.4.0 Apr 21, 2021
@fdiblen fdiblen closed this as completed Apr 28, 2021
@fdiblen fdiblen reopened this Apr 28, 2021
@fdiblen fdiblen added this to the 0.4.0 milestone Apr 28, 2021
@sverhoeven sverhoeven self-assigned this Apr 30, 2021
sverhoeven added a commit that referenced this issue Apr 30, 2021
@jspaaks
Copy link

jspaaks commented May 3, 2021

To me it seems like a bad idea to use the same name for conceptually different things. People use different names for things so they can tell them apart.

Users who are confused should take a peek at the directory tree from the README

my-python-project/
├── CHANGELOG.md
├── CITATION.cff
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── docs
│   ├── conf.py
│   ├── index.rst
│   ├── make.bat
│   ├── Makefile
│   ├── _static
│   │   └── theme_overrides.css
│   └── _templates
├── LICENSE
├── MANIFEST.in
├── my_python_package
│   ├── __init__.py
│   ├── my_module.py
│   └── __version__.py
├── NOTICE
├── project_setup.md
├── README.md
├── setup.cfg
├── setup.py
└── tests
    ├── __init__.py
    └── test_my_module.py

@fdiblen
Copy link
Member

fdiblen commented May 3, 2021

@fdiblen fdiblen modified the milestones: Future, 0.4.0 May 3, 2021
@sverhoeven sverhoeven removed their assignment May 3, 2021
@fdiblen fdiblen self-assigned this May 3, 2021
@fdiblen
Copy link
Member

fdiblen commented May 3, 2021

fixed in #278

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
template Related to the template itself, as opposed to the generated code
Projects
None yet
Development

No branches or pull requests

4 participants