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

Support upper-case letters in project name #487

Open
hombit opened this issue Oct 11, 2024 · 2 comments
Open

Support upper-case letters in project name #487

hombit opened this issue Oct 11, 2024 · 2 comments

Comments

@hombit
Copy link
Contributor

hombit commented Oct 11, 2024

CC @delucchi-cmu

@drewoldag
Copy link
Collaborator

I took a quick look at this - to make the change to accept uppercase letters is very straightforward. But I have become somewhat confused about how and where we use project and package name since these are both using almost the same regex. (I also recognize that I did this to myself)

Within the context of the output from copier, "project" and "package" names are pretty clear. However, I do have trouble keeping up with the various different ways that PyPI, ReadTheDocs, and CodeCov will manipulate the project name to fit within their standards.

For instance, I believe that PyPI will take the project.name from pyproject.toml and convert to lowercase. And possibly also converts underscores to dashes. Similarly readthedocs will change the project name underscores to dashes.

Maybe these different standards are worth worrying about, and we should just let the user name the package as they like, and allow PyPI, RTD or CodeCov to do what it does??? Doing so would likely break a bunch of the README badges that we've created though...

@hombit
Copy link
Contributor Author

hombit commented Oct 28, 2024

Thank you, @drewoldag, for the investigation. I could be wrong, but I think @delucchi-cmu wanted to create a GitHub repo name with uppercase letters.

For Python-related names, modules, projects, and packages should all be lowercase, I believe.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants