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

Proposal: Renaming Python package. #37

Open
BenMGeo opened this issue May 4, 2023 · 5 comments
Open

Proposal: Renaming Python package. #37

BenMGeo opened this issue May 4, 2023 · 5 comments
Assignees

Comments

@BenMGeo
Copy link
Collaborator

BenMGeo commented May 4, 2023

based on the new naming convention(s), I suggest the following action for the python subpackage.

  1. The sdk functionalities (measurement, acquisition context, etc) will be ported to the submodule cuvis.sdk
  2. the classificator functionalities will be ported to the submodule cuvis.ai (as far as I understood)
  3. the examples will be the ported to the main cuvis package as functionalities.

the package will have the following look for the user:

import cuvis provides examples to run the camera with.
import cuvis.sdk provides all sdk functionalities
import cuvis.ai provides the classificator (maybe we should divide the ai part into multiple submodules?)

@BenMGeo BenMGeo self-assigned this May 4, 2023
@BenMGeo
Copy link
Collaborator Author

BenMGeo commented May 4, 2023

@arndcubert @robertCubert @nhanson2

any thoughts?

@robertCubert
Copy link
Collaborator

I think the renaming is a good idea, I would suggest to leave the examples with the SDK though. So only cuvis.sdk and cuvis.ai?

@BenMGeo
Copy link
Collaborator Author

BenMGeo commented May 4, 2023

That would mean import cuvis would be empty. Not the greatest fan ;)

@nhanson2
Copy link
Collaborator

nhanson2 commented May 4, 2023

As with all things Python, I would encourage us to follow the PEP8 standard unless we have a good reason to break with convention.

https://peps.python.org/pep-0008/#package-and-module-names

@BenMGeo
Copy link
Collaborator Author

BenMGeo commented May 4, 2023

the naming suggestion above is within the PEP8 standard, as far as I know. I'm not sure about empty main package. I'll do some research.

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

3 participants