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

package_name used different ways should set/validated differently #621

Open
1 task done
sverhoeven opened this issue Aug 28, 2024 · 2 comments
Open
1 task done

Comments

@sverhoeven
Copy link
Member

Checklist before submitting an issue

  • I have checked the existing issues and couldn't find an issue about this bug.

When #211 was fixed there was package_name and directory_name questions.

Issue details

The package_name question value is used in multiple places:

  1. name on pypi, in template/pyproject.toml:project.name
  2. name when importing, in template/src/{{package_name}}

The name on pypi and import could be different for an existing package or a template user might want to have them different.

See https://blogs.gentoo.org/mgorny/2023/02/09/the-inconsistencies-around-python-package-naming-and-the-new-policy/ for a comparison what naming styles there are.

Could there be a warning when given package name does not follow PEP8?
Could package_name be split into package_name and directory_name? Maybe have the second question have default of the first answer.

@fdiblen
Copy link
Member

fdiblen commented Aug 28, 2024

thank you, @sverhoeven. We will not merge #613 as it requires more work than expected.

@sverhoeven
Copy link
Member Author

Refs #613

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

3 participants
@fdiblen @sverhoeven and others