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

Python package naming rules need to be corrected #60

Open
stsci-hack opened this issue Oct 2, 2018 · 1 comment
Open

Python package naming rules need to be corrected #60

stsci-hack opened this issue Oct 2, 2018 · 1 comment
Milestone

Comments

@stsci-hack
Copy link

A new python package was being established for supporting HST pipeline work and, in following the current style guide, this new package was initially set up with the name hla-pipeline. Subsequent use of 'cookiecutter' to initialize the repo, it returned with the following error:

> ERROR: The project slug (hla-pipeline) is not a valid Python module name. Please do not use a - and use _ instead
> ERROR: Stopping generation because pre_gen_project hook script didn't exit successfully
> Hook script failed (exit status: 1)
> 

Therefore, it appears that the guide needs to be updated to reflect the actual Python rules for package names and not allow '-' (hyphens) in the names.

@pllim
Copy link
Contributor

pllim commented Oct 2, 2018

Perhaps related: #10 (comment)

It is possible in the sense that you can make a package so that it is installed as hla-pipeline but imported as hla_pipeline. https://github.com/spacetelescope/ci_watson is such an example.

@stscicrawford stscicrawford modified the milestone: v1.0 Nov 5, 2018
@pllim pllim modified the milestones: v1.0, v2.0 Feb 14, 2020
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