You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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...
Activity
drewoldag commentedon Oct 28, 2024
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 commentedon 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.