Billingegroup / cookiecutter

A cookie-cutter for DiffPy packages.
Other
1 stars 8 forks source link

Incorrect naming for `package_dir_name` in Cookiecutter template #159

Open bobleesj opened 1 month ago

bobleesj commented 1 month ago

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 commented 1 month ago

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

bobleesj commented 1 month ago

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 commented 1 month ago

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

Addressed by https://github.com/Billingegroup/bg-mpl-stylesheets/pull/65#discussion_r1776254902

sbillinge commented 1 month ago

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