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

Incorrect naming for package_dir_name in Cookiecutter template #159

Open
bobleesj opened this issue Sep 26, 2024 · 4 comments · May be fixed by #160
Open

Incorrect naming for package_dir_name in Cookiecutter template #159

bobleesj opened this issue Sep 26, 2024 · 4 comments · May be fixed by #160

Comments

@bobleesj
Copy link
Contributor

I assumed the package_dir_name to be bg_mpl_stylesheets during the cookiecutter setup:

  [3/10] project_name (diffpy.my_project): bg-mpl-stylesheets
  [4/10] package_dist_name (bg-mpl-stylesheets): 
  [5/10] package_dir_name (bg_mpl_stylesheets): 

However, after generating the repository, the directory structure shows:

Untracked files:
	requirements/README.txt
	src/bg-mpl-stylesheets/

It seems that package_dir_name was set to bg-mpl-stylesheets instead of bg_mpl_stylesheets.

@sbillinge
Copy link
Collaborator

I think it should be bg-mpl-stylesheets shouldn't it?

@bobleesj
Copy link
Contributor Author

If we use src/bg-mpl-stylesheets, then we get the following:

Screenshot 2024-09-25 at 10 54 46 PM

I think it should be bg_mpl_stylesheets. So, we need to fix it one way or another for non-namespace packages containing -."

@bobleesj
Copy link
Contributor Author

Also look into /src/billingegroup/*/version.cfg generated in .gitignore instead of /src/bg_mpl_stylesheets/*/version.cfg

Addressed by Billingegroup/bg-mpl-stylesheets#65 (comment)

@sbillinge
Copy link
Collaborator

Yes, the import name has to have underscores. But everything else is with dashes. Directories, repo and package name

@bobleesj bobleesj linked a pull request Sep 27, 2024 that will close this issue
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

Successfully merging a pull request may close this issue.

2 participants