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

Renaming? #5

Open
kaklik opened this issue Mar 21, 2022 · 3 comments
Open

Renaming? #5

kaklik opened this issue Mar 21, 2022 · 3 comments

Comments

@kaklik
Copy link
Member

kaklik commented Mar 21, 2022

Thumby currently is a Tiny playable keychain.

Original name thumb-py could be a better choice.

@cisar2218
Copy link
Collaborator

Issue with original name

is that a - character is not allowed. So import anything-anything for example is not allowed. Module names should follow this naming rules (official coding style advice for python):

Modules 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.

Technical rules for naming of modules are identical as rules for naming variables: they must start with either a letter or an underscore and then be composed entirely of letters, digits, and/or underscores.

Names i considered:

Maybe we should consider a completely new name?

How I came with thumb-py (associations)

  • thumbnail, image, 3D printer, inserting, view, gcode, ...

@roman-dvorak
Copy link
Member

The name should be more descriptive. I don't know (from name) what thumby or thumb-py does.

Especially if an executable application will be created for this.

I would suggest something like gcode_img_inserter, gcode_prew, img_inserter, gcode_thumb. Or maybe something in the style of gprew, gprewpy.

Having short names is good point. But it must not cause the name to be insufficiently descriptive.

@cisar2218
Copy link
Collaborator

Executable script has name gcode_img_inserter.py right now.

I suggest gcode_thumbnailer for the library because I feel like its descriptive and quite short at the same time. Is there any alternative that you prefer over my suggestion or should I change it?

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