Skip to content

Rename this software to hetnetpy #40

Closed

Description

@vincerubinetti

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

Activity

  1. dhimmel commented on Jun 11, 2019

    @dhimmel
    Member

    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?

  2. vincerubinetti commented on Jun 11, 2019

    @vincerubinetti
    Author

    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.

  3. dhimmel commented on Jun 24, 2019

    @dhimmel
    Member

    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.
  4. dhimmel commented on Jul 10, 2019

    @dhimmel
    Member
  5. changed the title [-]Rename this software[/-] [+]Rename this software to hetnetpy[/+] on Jul 10, 2019
  6. dhimmel commented on Jul 10, 2019

    @dhimmel
    Member

    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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions