Giter Site home page Giter Site logo

Comments (5)

dhimmel avatar dhimmel commented on June 9, 2024

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?

from hetnetpy.

vincerubinetti avatar vincerubinetti commented on June 9, 2024

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.

from hetnetpy.

dhimmel avatar dhimmel commented on June 9, 2024

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.

from hetnetpy.

dhimmel avatar dhimmel commented on June 9, 2024

References:

from hetnetpy.

dhimmel avatar dhimmel commented on June 9, 2024

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)

from hetnetpy.

Related Issues (16)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.