New unified CLI: brother_ql
#37
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The strings like tcp://192.168.0.23:9100 or usb://0x04f9:0x2015 are rather 'identifiers' than descriptors (terminology). Users relying on the returned dictionaries of the list_available_devices() function need to update the key from 'string_descr' to 'identifier'. Sorry for the inconvenience.
The following error is resolved with this fix: TypeError: not all arguments converted during string formatting
The member variable filename_fmt now holds the relevant format template and can be changed after instatiation.
The rename was:
brother_ql.{printing,discovering} -> brother_ql.backends.helpers
The code previously found in the function create_label() in brother_ql.brother_ql_create now went into a new function convert() in its own module: convert() in brother_ql.conversion In addition, the new convert() function is now able to put more than one pages (labels) into one instruction file.
This will slowly deprecate the other CLIs such as * brother_ql_create * brother_ql_print * brother_ql_info * brother_ql_analyze * brother_ql_debug
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A new unified CLI named
brother_qljust like the package itself was added in those commits.This will slowly deprecate the other CLIs such as
The new CLI is based on click giving it a lot of features out of the box such as setting parameters via environment variables, very flexible command handling, ...
To implement the new CLI with as little overhead as possible, a lot of the code previously found in the source files of the old CLI tools was moved into generic modules. For example, the code to create a label is now found in the function
convert()inbrother_ql.conversioninstead of its previous place in the functioncreate_label()inbrother_ql.brother_ql_create.In addition, a small error was fixed in the BrotherQLReader class resulting in a TypeError raised. It's output image file names are now configurable.
API changes: The dictionary data structure returned by list_available_devices() has now a renamed key: What was
string_descrbefore is now calledidentifier.