labelle 1.0.0__py3-none-any.whl

labelle/__init__.py

@@ -0,0 +1,4 @@
+from .labeler import DymoLabeler
+from .metadata import __version__
+
+__all__ = ["__version__", "DymoLabeler"]

labelle/_version.py

@@ -0,0 +1,16 @@
+# file generated by setuptools_scm
+# don't change, don't track in version control
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple, Union
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+else:
+    VERSION_TUPLE = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+
+__version__ = version = '1.0.0'
+__version_tuple__ = version_tuple = (1, 0, 0)

labelle/barcode_writer.py

@@ -0,0 +1,108 @@
+# === LICENSE STATEMENT ===
+# Copyright (c) 2011 Sebastian J. Bronner <waschtl@sbronner.com>
+#
+# Copying and distribution of this file, with or without modification, are
+# permitted in any medium without royalty provided the copyright notice and
+# this notice are preserved.
+# === END LICENSE STATEMENT ===
+
+from typing import Optional
+
+from barcode.writer import BaseWriter
+from PIL import Image, ImageDraw
+
+
+def mm2px(mm, dpi=25.4):
+    return (mm * dpi) / 25.4
+
+
+class BarcodeImageWriter(BaseWriter):
+    _draw: Optional[ImageDraw.ImageDraw]
+
+    def __init__(self):
+        super().__init__(self._init, self._paint_module, None, self._finish)
+        self.format = "PNG"
+        self.dpi = 25.4
+        self._image = None
+        self._draw = None
+        self.vertical_margin = 0
+
+    def calculate_size(self, modules_per_line, number_of_lines, dpi=25.4):
+        width = 2 * self.quiet_zone + modules_per_line * self.module_width
+        height = self.vertical_margin * 2 + self.module_height * number_of_lines
+        return int(mm2px(width, dpi)), int(mm2px(height, dpi))
+
+    def render(self, code):
+        """Renders the barcode to whatever the inheriting writer provides,
+        using the registered callbacks.
+
+        :parameters:
+            code : List
+                List of strings matching the writer spec
+                (only contain 0 or 1).
+        """
+        if self._callbacks["initialize"] is not None:
+            self._callbacks["initialize"](code)
+        ypos = self.vertical_margin
+        for cc, line in enumerate(code):
+            """
+            Pack line to list give better gfx result, otherwise in can
+            result in aliasing gaps
+            '11010111' -> [2, -1, 1, -1, 3]
+            """
+            line += " "
+            c = 1
+            mlist = []
+            for i in range(0, len(line) - 1):
+                if line[i] == line[i + 1]:
+                    c += 1
+                else:
+                    if line[i] == "1":
+                        mlist.append(c)
+                    else:
+                        mlist.append(-c)
+                    c = 1
+            # Left quiet zone is x startposition
+            xpos = self.quiet_zone
+            for mod in mlist:
+                if mod < 1:
+                    color = self.background
+                else:
+                    color = self.foreground
+                # remove painting for background colored tiles?
+                self._callbacks["paint_module"](
+                    xpos, ypos, self.module_width * abs(mod), color
+                )
+                xpos += self.module_width * abs(mod)
+            # Add right quiet zone to every line, except last line,
+            # quiet zone already provided with background,
+            # should it be removed complety?
+            if (cc + 1) != len(code):
+                self._callbacks["paint_module"](
+                    xpos, ypos, self.quiet_zone, self.background
+                )
+            ypos += self.module_height
+        return self._callbacks["finish"]()
+
+    def _init(self, code):
+        size = self.calculate_size(len(code[0]), len(code), self.dpi)
+        self._image = Image.new("1", size, self.background)
+        self._draw = ImageDraw.Draw(self._image)
+
+    def _paint_module(self, xpos, ypos, width, color):
+        size = [
+            (mm2px(xpos, self.dpi), mm2px(ypos, self.dpi)),
+            (
+                mm2px(xpos + width, self.dpi),
+                mm2px(ypos + self.module_height, self.dpi),
+            ),
+        ]
+        self._draw.rectangle(size, outline=color, fill=color)
+
+    def _finish(self):
+        return self._image
+
+    def save(self, filename, output):
+        filename = f"{filename}.{self.format.lower()}"
+        output.save(filename, self.format.upper())
+        return filename

labelle/command_line.py

@@ -0,0 +1,265 @@
+# === LICENSE STATEMENT ===
+# Copyright (c) 2011 Sebastian J. Bronner <waschtl@sbronner.com>
+#
+# Copying and distribution of this file, with or without modification, are
+# permitted in any medium without royalty provided the copyright notice and
+# this notice are preserved.
+# === END LICENSE STATEMENT ===
+
+import argparse
+import os
+
+from PIL import Image, ImageOps
+
+from . import __version__
+from .constants import (
+    AVAILABLE_BARCODES,
+    DEFAULT_MARGIN_PX,
+    PIXELS_PER_MM,
+    USE_QR,
+    e_qrcode,
+)
+from .dymo_print_engines import DymoRenderEngine, print_label
+from .font_config import font_filename
+from .metadata import our_metadata
+from .unicode_blocks import image_to_unicode
+from .utils import die
+
+
+def parse_args():
+    # check for any text specified on the command line
+    parser = argparse.ArgumentParser(description=our_metadata["Summary"])
+    parser.add_argument(
+        "--version", action="version", version=f"%(prog)s {__version__}"
+    )
+    parser.add_argument(
+        "text",
+        nargs="+",
+        help="Text Parameter, each parameter gives a new line",
+        type=str,
+    )
+    parser.add_argument(
+        "-f",
+        action="count",
+        help="Draw frame around the text, more arguments for thicker frame",
+    )
+    parser.add_argument(
+        "-s",
+        choices=["r", "b", "i", "n"],
+        default="r",
+        help="Set fonts style (regular,bold,italic,narrow)",
+    )
+    parser.add_argument(
+        "-a",
+        choices=[
+            "left",
+            "center",
+            "right",
+        ],
+        default="left",
+        help="Align multiline text (left,center,right)",
+    )
+    parser.add_argument(
+        "--test-pattern",
+        type=int,
+        default=0,
+        help="Prints test pattern of a desired dot width",
+    )
+
+    length_options = parser.add_argument_group("Length options")
+
+    length_options.add_argument(
+        "-l",
+        "--min-length",
+        type=int,
+        default=0,
+        help="Specify minimum label length in mm",
+    )
+    length_options.add_argument(
+        "--max-length",
+        type=int,
+        default=None,
+        help="Specify maximum label length in mm, error if the label won't fit",
+    )
+    length_options.add_argument(
+        "--fixed-length",
+        type=int,
+        default=None,
+        help="Specify fixed label length in mm, error if the label won't fit",
+    )
+
+    length_options.add_argument(
+        "-j",
+        choices=[
+            "left",
+            "center",
+            "right",
+        ],
+        default="center",
+        help=(
+            "Justify content of label if label content is less than the "
+            "minimum or fixed length (left, center, right)"
+        ),
+    )
+    parser.add_argument("-u", nargs="?", help='Set user font, overrides "-s" parameter')
+    parser.add_argument(
+        "-n",
+        "--preview",
+        action="store_true",
+        help="Unicode preview of label, do not send to printer",
+    )
+    parser.add_argument(
+        "--preview-inverted",
+        action="store_true",
+        help="Unicode preview of label, colors inverted, do not send to printer",
+    )
+    parser.add_argument(
+        "--imagemagick",
+        action="store_true",
+        help="Preview label with Imagemagick, do not send to printer",
+    )
+    parser.add_argument(
+        "-qr", action="store_true", help="Printing the first text parameter as QR-code"
+    )
+    parser.add_argument(
+        "-c",
+        "--barcode",
+        choices=AVAILABLE_BARCODES,
+        default=False,
+        help="Printing the first text parameter as barcode",
+    )
+    parser.add_argument(
+        "--barcode-text",
+        choices=AVAILABLE_BARCODES,
+        default=False,
+        help="Printing the first text parameter as barcode and text under it",
+    )
+    parser.add_argument("-p", "--picture", help="Print the specified picture")
+    parser.add_argument(
+        "-m",
+        type=int,
+        default=DEFAULT_MARGIN_PX,
+        help=f"Margin in px (default is {DEFAULT_MARGIN_PX})",
+    )
+    parser.add_argument(
+        "--scale", type=int, default=90, help="Scaling font factor, [0,10] [%%]"
+    )
+    parser.add_argument(
+        "-t",
+        type=int,
+        choices=[6, 9, 12, 19],
+        default=12,
+        help="Tape size: 6,9,12,19 mm, default=12mm",
+    )
+    return parser.parse_args()
+
+
+def mm_to_payload_px(mm, margin):
+    """Convert a length in mm to a number of pixels of payload
+
+    The print resolution is 7 pixels/mm, and margin is subtracted
+    from each side."""
+    return (mm * PIXELS_PER_MM) - margin * 2
+
+
+def main():
+    args = parse_args()
+    render_engine = DymoRenderEngine(args.t)
+
+    # read config file
+    FONT_FILENAME = font_filename(args.s)
+
+    labeltext = args.text
+
+    if args.u is not None:
+        if os.path.isfile(args.u):
+            FONT_FILENAME = args.u
+        else:
+            die("Error: file '%s' not found." % args.u)
+
+    # check if barcode, qrcode or text should be printed, use frames only on text
+    if args.qr and not USE_QR:
+        die("Error: %s" % e_qrcode)
+
+    if args.barcode and args.qr:
+        die("Error: can not print both QR and Barcode on the same label (yet)")
+
+    if args.fixed_length is not None and (
+        args.min_length != 0 or args.max_length is not None
+    ):
+        die("Error: can't specify min/max and fixed length at the same time")
+
+    if args.max_length is not None and args.max_length < args.min_length:
+        die("Error: maximum length is less than minimum length")
+
+    bitmaps = []
+
+    if args.test_pattern:
+        bitmaps.append(render_engine.render_test(args.test_pattern))
+
+    if args.qr:
+        bitmaps.append(render_engine.render_qr(labeltext.pop(0)))
+
+    elif args.barcode:
+        bitmaps.append(render_engine.render_barcode(labeltext.pop(0), args.barcode))
+
+    elif args.barcode_text:
+        bitmaps.append(
+            render_engine.render_barcode_with_text(
+                labeltext.pop(0), args.barcode_text, FONT_FILENAME, args.f
+            )
+        )
+
+    if labeltext:
+        bitmaps.append(
+            render_engine.render_text(
+                text_lines=labeltext,
+                font_file_name=FONT_FILENAME,
+                frame_width_px=args.f,
+                font_size_ratio=int(args.scale) / 100.0,
+                align=args.a,
+            )
+        )
+
+    if args.picture:
+        bitmaps.append(render_engine.render_picture(args.picture))
+
+    margin = args.m
+    justify = args.j
+
+    if args.fixed_length is not None:
+        min_label_mm_len = args.fixed_length
+        max_label_mm_len = args.fixed_length
+    else:
+        min_label_mm_len = args.min_length
+        max_label_mm_len = args.max_length
+
+    min_payload_len_px = max(0, mm_to_payload_px(min_label_mm_len, margin))
+    max_payload_len_px = (
+        mm_to_payload_px(max_label_mm_len, margin)
+        if max_label_mm_len is not None
+        else None
+    )
+
+    label_bitmap = render_engine.merge_render(
+        bitmaps=bitmaps,
+        min_payload_len_px=min_payload_len_px,
+        max_payload_len_px=max_payload_len_px,
+        justify=justify,
+    )
+
+    # print or show the label
+    if args.preview or args.preview_inverted or args.imagemagick:
+        print("Demo mode: showing label..")
+        # fix size, adding print borders
+        label_image = Image.new(
+            "L", (margin + label_bitmap.width + margin, label_bitmap.height)
+        )
+        label_image.paste(label_bitmap, (margin, 0))
+        if args.preview or args.preview_inverted:
+            label_rotated = label_bitmap.transpose(Image.ROTATE_270)
+            print(image_to_unicode(label_rotated, invert=args.preview_inverted))
+        if args.imagemagick:
+            ImageOps.invert(label_image).show()
+    else:
+        print_label(label_bitmap, margin_px=args.m, tape_size_mm=args.t)

labelle/constants.py

@@ -0,0 +1,97 @@
+# === LICENSE STATEMENT ===
+# Copyright (c) 2011 Sebastian J. Bronner <waschtl@sbronner.com>
+#
+# Copying and distribution of this file, with or without modification, are
+# permitted in any medium without royalty provided the copyright notice and
+# this notice are preserved.
+# === END LICENSE STATEMENT ===
+
+# On systems with access to sysfs under /sys, this script will use the three
+# variables DEV_CLASS, DEV_VENDOR, and DEV_PRODUCT to find the device file
+# under /dev automatically. This behavior can be overridden by setting the
+# variable DEV_NODE to the device file path. This is intended for cases, where
+# either sysfs is unavailable or unusable by this script for some reason.
+# Please beware that DEV_NODE must be set to None when not used, else you will
+# be bitten by the NameError exception.
+
+from pathlib import Path
+
+import labelle.resources.fonts
+import labelle.resources.icons
+
+try:
+    from pyqrcode import QRCode
+
+    USE_QR = True
+    e_qrcode = None
+except ImportError as error:
+    e_qrcode = error
+    USE_QR = False
+    QRCode = None
+
+
+UNCONFIRMED_MESSAGE = (
+    "WARNING: This device is not confirmed to work with this software. Please "
+    "report your experiences in https://github.com/computerlyrik/dymoprint/issues/44"
+)
+SUPPORTED_PRODUCTS = {
+    0x0011: "DYMO LabelMANAGER PC",
+    0x0015: "LabelPoint 350",
+    0x1001: "LabelManager PnP (no mode switch)",
+    0x1002: "LabelManager PnP (mode switch)",
+    0x1003: f"LabelManager 420P (no mode switch) {UNCONFIRMED_MESSAGE}",
+    0x1004: f"LabelManager 420P (mode switch) {UNCONFIRMED_MESSAGE}",
+    0x1005: "LabelManager 280 (no mode switch)",
+    0x1006: "LabelManager 280 (no mode switch)",
+    0x1007: f"LabelManager Wireless PnP (no mode switch) {UNCONFIRMED_MESSAGE}",
+    0x1008: f"LabelManager Wireless PnP (mode switch) {UNCONFIRMED_MESSAGE}",
+    0x1009: f"MobileLabeler {UNCONFIRMED_MESSAGE}",
+}
+DEV_VENDOR = 0x0922
+
+PRINTER_INTERFACE_CLASS = 0x07
+HID_INTERFACE_CLASS = 0x03
+
+# Escape character preceeding all commands
+ESC = 0x1B
+
+# Synchronization character preceding uncompressed print data
+SYN = 0x16
+
+FONT_SIZERATIO = 7 / 8
+
+DEFAULT_FONT_STYLE = "regular"
+
+DEFAULT_MARGIN_PX = 56
+
+FLAG_TO_STYLE = {
+    "r": "regular",
+    "b": "bold",
+    "i": "italic",
+    "n": "narrow",
+}
+
+DPI = 180
+MM_PER_INCH = 25.4
+PIXELS_PER_MM = DPI / MM_PER_INCH
+
+DEFAULT_FONT_DIR = Path(labelle.resources.fonts.__file__).parent
+ICON_DIR = Path(labelle.resources.icons.__file__).parent
+
+AVAILABLE_BARCODES = [
+    "code39",
+    "code128",
+    "ean",
+    "ean13",
+    "ean8",
+    "gs1",
+    "gtin",
+    "isbn",
+    "isbn10",
+    "isbn13",
+    "issn",
+    "jan",
+    "pzn",
+    "upc",
+    "upca",
+]

labelle/detect.py

@@ -0,0 +1,214 @@
+import platform
+from typing import NamedTuple, NoReturn
+
+import usb
+
+from labelle.utils import die
+
+from .constants import (
+    DEV_VENDOR,
+    HID_INTERFACE_CLASS,
+    PRINTER_INTERFACE_CLASS,
+    SUPPORTED_PRODUCTS,
+    UNCONFIRMED_MESSAGE,
+)
+
+GITHUB_LINK = "<https://github.com/computerlyrik/dymoprint/pull/56>"
+
+
+class DetectedDevice(NamedTuple):
+    id: int
+    """See labelle.constants.SUPPORTED_PRODUCTS for a list of known IDs."""
+    dev: usb.core.Device
+    intf: usb.core.Interface
+    devout: usb.core.Endpoint
+    devin: usb.core.Endpoint
+
+
+def device_info(dev: usb.core.Device) -> str:
+    try:
+        dev.manufacturer
+    except ValueError:
+        instruct_on_access_denied(dev)
+    res = ""
+    res += f"{repr(dev)}\n"
+    res += f"  manufacturer: {dev.manufacturer}\n"
+    res += f"  product: {dev.product}\n"
+    res += f"  serial: {dev.serial_number}\n"
+    configs = dev.configurations()
+    if configs:
+        res += "  configurations:\n"
+        for cfg in configs:
+            res += f"  - {repr(cfg)}\n"
+            intfs = cfg.interfaces()
+            if intfs:
+                res += "    interfaces:\n"
+                for intf in intfs:
+                    res += f"    - {repr(intf)}\n"
+    return res
+
+
+def detect_device() -> DetectedDevice:
+    dymo_devs = list(usb.core.find(idVendor=DEV_VENDOR, find_all=True))
+    if len(dymo_devs) == 0:
+        print(f"No Dymo devices found (expected vendor {hex(DEV_VENDOR)})")
+        for dev in usb.core.find(find_all=True):
+            print(
+                f"- Vendor ID: {hex(dev.idVendor):6}  "
+                f"Product ID: {hex(dev.idProduct)}"
+            )
+        die("Unable to open device.")
+    if len(dymo_devs) > 1:
+        print("Found multiple Dymo devices:")
+        for dev in dymo_devs:
+            print(device_info(dev))
+        print("Using first device.")
+        dev = dymo_devs[0]
+    else:
+        dev = dymo_devs[0]
+        print(f"Found one Dymo device: {device_info(dev)}")
+    dev = dymo_devs[0]
+    if dev.idProduct in SUPPORTED_PRODUCTS:
+        print(f"Recognized device as {SUPPORTED_PRODUCTS[dev.idProduct]}")
+    else:
+        print(f"Unrecognized device: {hex(dev.idProduct)}. {UNCONFIRMED_MESSAGE}")
+
+    try:
+        dev.get_active_configuration()
+        print("Active device configuration already found.")
+    except usb.core.USBError:
+        try:
+            dev.set_configuration()
+            print("Device configuration set.")
+        except usb.core.USBError as e:
+            if e.errno == 13:
+                raise RuntimeError("Access denied")
+            if e.errno == 16:
+                print("Device is busy, but this is okay.")
+            else:
+                raise
+
+    intf = usb.util.find_descriptor(
+        dev.get_active_configuration(), bInterfaceClass=PRINTER_INTERFACE_CLASS
+    )
+    if intf is not None:
+        print(f"Opened printer interface: {repr(intf)}")
+    else:
+        intf = usb.util.find_descriptor(
+            dev.get_active_configuration(), bInterfaceClass=HID_INTERFACE_CLASS
+        )
+        if intf is not None:
+            print(f"Opened HID interface: {repr(intf)}")
+        else:
+            die("Could not open a valid interface.")
+    assert isinstance(intf, usb.core.Interface)
+
+    try:
+        if dev.is_kernel_driver_active(intf.bInterfaceNumber):
+            print(f"Detaching kernel driver from interface {intf.bInterfaceNumber}")
+            dev.detach_kernel_driver(intf.bInterfaceNumber)
+    except NotImplementedError:
+        print(f"Kernel driver detaching not necessary on " f"{platform.system()}.")
+    devout = usb.util.find_descriptor(
+        intf,
+        custom_match=(
+            lambda e: usb.util.endpoint_direction(e.bEndpointAddress)
+            == usb.util.ENDPOINT_OUT
+        ),
+    )
+    devin = usb.util.find_descriptor(
+        intf,
+        custom_match=(
+            lambda e: usb.util.endpoint_direction(e.bEndpointAddress)
+            == usb.util.ENDPOINT_IN
+        ),
+    )
+
+    if not devout or not devin:
+        die("The device endpoints not be found.")
+    return DetectedDevice(
+        id=dev.idProduct, dev=dev, intf=intf, devout=devout, devin=devin
+    )
+
+
+def instruct_on_access_denied(dev: usb.core.Device) -> NoReturn:
+    system = platform.system()
+    if system == "Linux":
+        instruct_on_access_denied_linux(dev)
+    elif system == "Windows":
+        raise RuntimeError(
+            "Couldn't access the device. Please make sure that the "
+            "device driver is set to WinUSB. This can be accomplished "
+            "with Zadig <https://zadig.akeo.ie/>."
+        )
+    elif system == "Darwin":
+        raise RuntimeError(
+            f"Could not access {dev}. Thanks for bravely trying this on a Mac. You "
+            f"are in uncharted territory. It would be appreciated if you share the "
+            f"results of your experimentation at {GITHUB_LINK}."
+        )
+    else:
+        raise RuntimeError(f"Unknown platform {system}")
+
+
+def instruct_on_access_denied_linux(dev: usb.core.Device) -> NoReturn:
+    # try:
+    #     os_release = platform.freedesktop_os_release()
+    # except OSError:
+    #     os_release = {}
+    # dists_with_empties = [os_release.get("ID", "")] + os_release.get(
+    #     "ID_LIKE", ""
+    # ).split(" ")
+    # dists = [dist for dist in dists_with_empties if dist]
+    # if "arch" in dists:
+    #     restart_udev_command = "sudo udevadm control --reload"
+    # elif "ubuntu" in dists or "debian" in dists:
+    #     restart_udev_command = "sudo systemctl restart udev.service"
+    # # detect whether we are in arch linux or ubuntu linux
+    # if Path("/etc/arch-release").exists():
+    #     restart_udev_command = "sudo udevadm control --reload"
+    # elif Path("/etc/lsb-release").exists():
+    #     restart_udev_command = "sudo systemctl restart udev.service"
+    # else:
+    #     restart_udev_command = None
+
+    lines = []
+    lines.append(
+        "You do not have sufficient access to the "
+        "device. You probably want to add the a udev rule in "
+        "/etc/udev/rules.d with the following command:"
+    )
+    lines.append("")
+    udev_rule = ", ".join(
+        [
+            'ACTION=="add"',
+            'SUBSYSTEMS=="usb"',
+            f'ATTRS{{idVendor}}=="{dev.idVendor:04x}"',
+            f'ATTRS{{idProduct}}=="{dev.idProduct:04x}"',
+            'MODE="0666"',
+        ]
+    )
+    lines.append(
+        f"  echo '{udev_rule}' "
+        f"| sudo tee /etc/udev/rules.d/91-dymo-{dev.idProduct:x}.rules"
+    )
+    lines.append("")
+    lines.append("Next refresh udev with:")
+    lines.append("")
+    lines.append("  sudo udevadm control --reload-rules")
+    lines.append('  sudo udevadm trigger --attr-match=idVendor="0922"')
+    lines.append("")
+    lines.append(
+        "Finally, turn your device off and back "
+        "on again to activate the new permissions."
+    )
+    lines.append("")
+    lines.append(
+        f"If this still does not resolve the problem, you might need to reboot. "
+        f"In case rebooting is necessary, please report this at {GITHUB_LINK}. "
+        f"We are still trying to figure out a simple procedure which works "
+        f"for everyone. In case you still cannot connect, "
+        f"or if you have any information or ideas, please post them at "
+        f"that link."
+    )
+    raise RuntimeError("\n\n" + "\n".join(lines) + "\n")