search

planetarypy / TC

PlanetaryPy Project Technical Committee
https://planetarypy.org/
1 stars 2 forks source link

What's our name? #1

Closed rbeyer closed 4 years ago

rbeyer commented 4 years ago

I'm reading through the Astropy documentation, and have learned that Astropy, capitalized, refers to The Astropy Project, while astropy lowercase and in backticks refers to the core package.

How shall we refer to this endeavor? I think it is probably useful to have that same distinction. We need something that refers to our 'project.' Should that be: Planetary Python, PlanetaryPy, Planetarypy, something else?

Seems like it should be straightforward to use planetarypy for the core package, perhaps adopting an import planetarypy as planpy or import planetarypy as ppy convention similar to import numpy as np?

AndrewAnnex commented 4 years ago

The python package should be “planetarypy”, as it gets confusing when a package import name is different than the code base repository (see scikit-learn vs. import sklearn). As for the human readable name I prefer “PlanetaryPy” but it is probably more natural to just do “Planetarypy”. On the import/numpy convention side, I wish there was an obvious solution as the two letter version is rather unfortunate...

-Andrew Annex

On Nov 3, 2019, at 9:35 AM, Ross Beyer notifications@github.com wrote:  I'm reading through the Astropy documentation, and have learned that Astropy, capitalized, refers to The Astropy Project, while astropy lowercase and in backticks refers to the core package.

How shall we refer to this endeavor? I think it is probably useful to have that same distinction. We need something that refers to our 'project.' Should that be: Planetary Python, PlanetaryPy, Planetarypy, something else?

Seems like it should be straightforward to use planetarypy for the core package, perhaps adopting an import planetarypy as planpy or import planetarypy as ppy convention similar to import numpy as np?

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or unsubscribe.

michaelaye commented 4 years ago

I agree with package being planetarypy. I also agree with Andrew that PlanetaryPy somehow reads nicer as a project name, as the word is so long, despite breaking the symmetry with the Astropy project. And lastly, I'd vote for import planetarypy as ppy as the shortest version that isn't pp ;)

michaelaye commented 4 years ago

But I was also wondering if these kinds of votes should be done in the initial telecon?

rbeyer commented 4 years ago

If you want this done in a telecon, then schedule one.

I brought these first two issues up, because I'm noodling with a TSC application, and we need at least that info.

rbeyer commented 4 years ago

In our meeting today, we agreed that the project shall be named "PlanetaryPy" and the core package will be called planetarypy. We deferred on establishing a shortened import form.