search

cwru-sdle / kgcpy

Aids in identifying the Köppen-Geiger (KG) climatic zone for a given lat and lon of any location. The resolution of KG map is at 100 sec arc or approximately 3.087 km at the equator, reported by Rubel et al. [2016]. F. Rubel, K. Brugger, K. Haslinger, and I. Auer, (2016) doi:10.1127/metz/2016/0816.
https://kgcpy.readthedocs.io/en/latest/
BSD 3-Clause "New" or "Revised" License
4 stars 3 forks source link

Repository naming #4

Closed AdamRJensen closed 3 months ago

AdamRJensen commented 6 months ago

It seems undesirable that the repository has a dash in the name. Is there a reason for this choice?

It's common practice to have the repository be named the same as the package.

bgpierc commented 6 months ago

We also have a package (of the same name) for R, we added the -py to delineate the difference between the two

AdamRJensen commented 6 months ago

We also have a package (of the same name) for R, we added the -py to delineate the difference between the two

I'm not against the "py" part but I'd like to remove the dash. The dash only exists in the repository name and not in the sub-folder or the package name.

AdamRJensen commented 4 months ago

I'm going to reiterate that I strongly suggest renaming the repository to "kgcpy" instead of "kgc-py". This is a very easy fix.

I also suggest changing the package name from "kgcPy" to "kgcpy" to follow the official python convention:

should have short, all-lowercase names. Underscores can be used in the module name if it improves readability. Python packages should also have short, all-lowercase names, although the use of underscores is discouraged.

bgpierc commented 4 months ago

yeah, agreed, done. this shouldn't break anything since pip is case insensitive, yes?

AdamRJensen commented 3 months ago

yeah, agreed, done. this shouldn't break anything since pip is case insensitive, yes?

people now have to do import kgcpy instead of kgcPy, so it is a breaking change