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 the project #263

Closed
leouieda opened this issue Jan 17, 2019 · 22 comments · Fixed by #265
Closed

Rename the project #263

leouieda opened this issue Jan 17, 2019 · 22 comments · Fixed by #265
Labels
help wanted Helping hands are appreciated question Further information is requested

Comments

@leouieda
Copy link
Member

Right now, this project is called "GMT/Python". But that's not a valid package name so we import gmt. But we can't call our repository, PyPI and conda packages gmt so they'll have to be gmt-python. This is kind of crazy. Plus, import gmt confuses a lot of beginners.

Clearly we need a new name.

Both pygmt and gmtpy have been used before but they were never registered on PyPI so we can still use those names. I don't really like those two options much but they are certainly better than what we have right now.

Are there any other suggestions?

@leouieda leouieda added question Further information is requested help wanted Helping hands are appreciated labels Jan 17, 2019
@leouieda
Copy link
Member Author

Pinging @GenericMappingTools/gmt-python @liamtoney @weiji14 @akshmakov @mjziebarth

@weiji14
Copy link
Member

weiji14 commented Jan 17, 2019

Why not just go with GMT-Python? Use gmt-python as the PyPI package name just to be consistent with conda, and import gmtpython to import the package (no hyphen). This is about the same as scikit-image and scikit-learn which uses import skimage and import sklearn respectively (note no hyphen also).

Oh, and for reference on package naming, there's PEP8.

@leouieda
Copy link
Member Author

That's a fair point but then we're not any better off. It's still confusing that you install one thing and import another. That's something I really dislike about scikit-learn and scikit-image. I'm sure they'd rename if they could but they've already been around for too long. We don't have an official release yet so it's the perfect time to do this right. I would prefer to have the repository, import, and PyPI package names be the same.

If we go with gmtpython then I'd prefer to never have the hyphen in there. We can always import gmtpython as gp or import gmtpython as gmt to keep things short. This isn't a bad idea actually and would be minimally disruptive.

@liamtoney
Copy link
Member

This option would be shorter, and could allow for a repo name that is also consistent:

conda install pygmt
import pygmt

GenericMappingTools/PyGMT

PyGMT

A Python interface to the Generic Mapping Tools (GMT)

@liamtoney
Copy link
Member

Or, taking @weiji14's idea above and making it entirely consistent, even with case. The title is less stylish, but then things are truly unambiguous, which is valuable in my opinion...

conda install gmtpython
import gmtpython as gmt

GenericMappingTools/gmtpython

gmtpython

A Python interface to the Generic Mapping Tools (GMT)

@leouieda
Copy link
Member Author

@liamtoney that's my favorite between pygmt and gmtpy. I'm still hoping for some clever/funny name to come along, though 😉

I know @PaulWessel is a Monty Python fan so something related to that might be interesting. Are there any Monty Python jokes related to mapping?

@liamtoney
Copy link
Member

@leouieda I think I've found the answer. For reference, see here. 😜

conda install airspeedvelocityofanunladenswallow
import airspeedvelocityofanunladenswallow as gmt

GenericMappingTools/airspeedvelocityofanunladenswallow

airspeedvelocityofanunladenswallow

A Python interface to the Generic Mapping Tools (GMT)

@leouieda
Copy link
Member Author

@liamtoney actually, there is already an "airspeed velocity" Python package (https://github.com/airspeed-velocity/asv) :(

@liamtoney
Copy link
Member

And that above comment was in jest, anyhow. :)

On a more serious note, while I like the idea of a "punny" name, isn't it important to have a short package name that gives some indication of the package topic?

@leouieda
Copy link
Member Author

Yeah, having a clear and concise name would be optimal. Just putting it out there in case anyone has a good idea :)

@leouieda
Copy link
Member Author

I'm leaning towards pygmt. Can I get a 👍 or 👎 on that?

@weiji14
Copy link
Member

weiji14 commented Jan 21, 2019

@liamtoney that's my favorite between pygmt and gmtpy. I'm still hoping for some clever/funny name to come along, though 😉

No idea why, but I had this dream this morning and woke up with this name "GMighTy". Since GMT is a powerful and awesome library, mighty seems like a good word for it 😄 And as you've all mentioned, we could do something like:

import gmighty as gmt

I did consider something like gmightpy or gmighpy, just to have the Py of Python in it, but they're hard to pronounce and Ty sounds enough like Py 🤷‍♂️.

@leouieda
Copy link
Member Author

@weiji14 🤣 that was certainly very different from all other suggestions! +1 for creativity and thinking outside the box 🥇

@weiji14
Copy link
Member

weiji14 commented Jan 21, 2019

Shall we put this to vote? There's a Probot app at https://probot.github.io/apps/polls/ we can install to use. @leouieda maybe add the poll to the first comment?

@leouieda
Copy link
Member Author

leouieda commented Jan 21, 2019

@weiji14 thanks for setting that up! These Github apps are really helpful.

OK, so can we get a vote on these names:

(sorry @weiji14, I have a really hard time reading gmighty and pronouncing it in my head :)

@leouieda
Copy link
Member Author

/polls pygmt gmtpy gmtpython

@leouieda
Copy link
Member Author

The bot is not working for some reason. So let's not go with a full democracy. Instead, I propose using pygmt. Please add a reaction to this comment with either 👍 or 👎 (click on the + 😃 button).

@leouieda
Copy link
Member Author

Well that sucks, someone took pygmt.org since yesterday.

@liamtoney
Copy link
Member

How about a domain hack like pyg.mt?

@seisman
Copy link
Member

seisman commented Jan 22, 2019

@leouieda How do you know that pygmt.org was taken?

Godaddy shows it's still available. See https://www.godaddy.com/domainsearch/find?isc=cjcbh99&checkAvail=1&tmskey=&domainToCheck=pygmt.org

leouieda added a commit that referenced this issue Jan 22, 2019
GMT/Python is a bad name because it can't be translated into a
repository or Python package name easily. What we have now is a
repository called `gmt-python`, a website `gmtpython`, a package `gmt`,
and a PyPI package `gmt-python`. This is madness.
Since all other GMT Python wrappers are dead, we'll rebrand as PyGMT
(repo and packages will be `pygmt`).

This renames the package and imports so that the tests pass and the docs
build. I'm sure we'll find many references to `gmt` but we can fix those
with time.

Fixes #263
@leouieda
Copy link
Member Author

Yeah, it was my mistake. I had it on my cart and it showed up as unavailable.

leouieda added a commit that referenced this issue Jan 22, 2019
GMT/Python is a bad name because it can't be translated into a
repository or Python package name easily. What we have now is a
repository called `gmt-python`, a website `gmtpython`, a package `gmt`,
and a PyPI package `gmt-python`. This is madness.
Since all other GMT Python wrappers are dead, we'll rebrand as PyGMT
(repo and packages will be `pygmt`).

This renames the package and imports so that the tests pass and the docs
build. I'm sure we'll find many references to `gmt` but we can fix those
with time.

Fixes #263
@leouieda
Copy link
Member Author

The rename was successful! Please update your github links. The docs are now hosted on http:https://www.pygmt.org/ and the name is register on PyPI. Still waiting for SSL certificates to enable https and the gitter room to rename fully. I'm setting up forwarding from the old gmtpython.xyz.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Helping hands are appreciated question Further information is requested
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants