search

mapillary / mapillary-python-sdk

A Python 3 library built on the Mapillary API v4 to facilitate retrieving and working with Mapillary data.
MIT License
41 stars 16 forks source link

Naming the library #2

Closed cbeddow closed 3 years ago

cbeddow commented 3 years ago

What shall we name the library?

Unofficially, we are calling this the Mapillary Python SDK.

When installing the library, it can have a shorter name. For example:

pip install library => pip install mapillary-python-sdk => pip install mapillary => pip install mlypy

or

import mapillary-python-sdk

import mapillary

import mlypy

//

We often use MLY as an abbreviation of Mapillary. The PyPI.org listing for mapillary is taken currently, but I know the creator of this and have attempted to contact him so we can take it over, so maybe this will be the best choice.

Any opinions are welcome.

Rubix982 commented 3 years ago

I think users will not care much if we go for a longer name when installing the package itself, so pip install mapillary-python-sdk seems good for me, but when it comes to the import statement, we should do something like import mapillary-python-sdk as mly and users can use the mly. prefix whenever they want to use the library.

cbeddow commented 3 years ago

We have ownership of mapillary on PyPI now and the team also gave me input that mapillary is best, so we will go with that!