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

Rename this software to hetnetpy #40

Closed
vincerubinetti opened this issue Jun 10, 2019 · 5 comments
Closed

Rename this software to hetnetpy #40

vincerubinetti opened this issue Jun 10, 2019 · 5 comments

Comments

@vincerubinetti
Copy link

@vincerubinetti vincerubinetti commented Jun 10, 2019

To hetiopy perhaps. The overlap between all the names of these tools/products/pages is a bit muddy and confusing.

@dhimmel
Copy link
Member

@dhimmel dhimmel commented Jun 11, 2019

Yeah this package was named a long time ago when only https://het.io and this package existed. Hence, I gave it the name hetio.

There are three main places where a software package has a name:

  1. On GitHub, currently https://github.com/hetio/hetio
  2. On PyPI, currently https://pypi.org/project/hetio/
  3. In Python, currently import hetio

A minimalist approach would be to rename the GitHub repository to hetio/hetiopy. A maximalist approach would be to rename all three locations to hetnetpy. I think hetnetpy works well with hetmatpy, although perhaps the visual similar is too high for easy disambiguation?

@vincerubinetti
Copy link
Author

@vincerubinetti vincerubinetti commented Jun 11, 2019

I'd go with whatever's more accurate. hetiopy isn't that much further from hetmatpy than hetnetpy is. hetnetpy probably is the way to go, and renaming all the location of it for clarity and consistency.

@dhimmel
Copy link
Member

@dhimmel dhimmel commented Jun 24, 2019

I'm having trouble finding good documentation on how to go about the renaming of the PyPI package. I am thinking that we could do the following steps:

  1. create a DeprecationWarning in __init__.py that future versions of the package will be named hetnetpy.
  2. Update README that the package has been relocated to hetnetpy
  3. Release v0.2.11 still under the old location
  4. relocate on GitHub
  5. modify code to update package name
  6. release v0.3.0 with new package location.

@dhimmel
Copy link
Member

@dhimmel dhimmel commented Jul 10, 2019

dhimmel added a commit that referenced this issue Jul 10, 2019
@dhimmel dhimmel changed the title Rename this software Rename this software to hetnetpy Jul 10, 2019
@dhimmel dhimmel closed this in #42 Jul 10, 2019
dhimmel added a commit that referenced this issue Jul 10, 2019
Merges #42
Closes #40

`pip install hetnetpy` now installs two packages: hetnetpy and hetio.
`import hetio` will trigger a warning. The source code uses a
symbolic link. Behavior on windows unknown.
@dhimmel
Copy link
Member

@dhimmel dhimmel commented Jul 10, 2019

Done! I think...

https://pypi.org/project/hetnetpy/
https://github.com/hetio/hetnetpy

In d88f81a, I made it so users of v0.3.0 can still import hetio, but they get a warning:

>>> import hetio
/home/dhimmel/Documents/repos/hetio/hetio/__init__.py:11: FutureWarning: The 'hetio' package has been renamed to 'hetnetpy'. Future versions will remove the ability to 'import hetio'. Switch to 'import hetnetpy'.
  warnings.warn(message, FutureWarning)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

2 participants