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 of the python package and CLI tool #62

Open
eimrek opened this issue Jul 30, 2024 · 0 comments
Open

Naming of the python package and CLI tool #62

eimrek opened this issue Jul 30, 2024 · 0 comments

Comments

@eimrek
Copy link
Member

eimrek commented Jul 30, 2024

This repo will most likely only contain a single python package (currently named optimake).

I recently also published it to pypi: https://pypi.org/project/optimake/

I have small doubts about optimake being potentially mixed up with optimade in the following contexts:

  • In oral communication. e.g. when someone says "we use optimake to ...", someone, who might not be aware of the package, might assume they meant "we use optimade to ...".
  • in various contexts related to the python package (e.g. on exploring pypi.org, looking at pip freeze, seeing pip install optimake/optimade) it might cause confusion.

On the other hand optimade_maker shouldn't have this problems.

Regarding the CLI tool, these points don't really apply directly (e.g. there is no optimade executable), so perhaps that is fine to keep as optimake. And i think it's fairly common to use a different name than the package name for this.

@ml-evs what do you think?

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

No branches or pull requests

1 participant