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

Naming the library #2

Closed
cbeddow opened this issue Jun 23, 2021 · 2 comments
Closed

Naming the library #2

cbeddow opened this issue Jun 23, 2021 · 2 comments
Labels
question Further information is requested

Comments

@cbeddow
Copy link
Member

cbeddow commented Jun 23, 2021

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.

@cbeddow cbeddow added the question Further information is requested label Jun 23, 2021
@cbeddow cbeddow self-assigned this Jun 23, 2021
@Rubix982
Copy link
Contributor

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
Copy link
Member Author

cbeddow commented Jun 24, 2021

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!

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

No branches or pull requests

2 participants