tinyprint 0.2.4__py3-none-any.whl

tinyprint/printer/profile.py

@@ -0,0 +1,91 @@
+"""Printer profile management for the tinyprint application.
+
+This module provides functionality to manage and configure printer profiles
+for different ESC/POS compatible printers. It handles printer-specific settings
+and configurations to ensure optimal printing results across different printer
+models.
+
+The module includes functionality to:
+- Apply custom configurations to printer profiles
+- Handle printer model-specific settings
+- Configure connection-specific parameters
+- Set default values for various printing parameters
+"""
+
+from escpos.printer.usb import Usb as UsbPrinter  # type: ignore
+
+
+def patch_printer_profile(printer):
+    """Apply custom configuration to a printer's profile.
+
+    This function extends the printer's profile with additional settings and
+    configurations that are not included in the default ESC/POS profile. It
+    handles model-specific configurations and sets appropriate defaults for
+    various printing parameters.
+    """
+    profile = printer.profile
+
+    # Default values in case printer is unknown
+    profile.img_kwargs = {}
+    profile.img_cut_index = 3
+    profile.img_scale_factor = 1
+    profile.img_x_scale_factor = 1
+    profile.img_y_scale_factor = 1
+    profile.sleep_time = 0
+
+    # How many characters fit on one line with normal font size.
+    # 42 is also default for TM-T88III.
+    profile.default_char_count = 42
+    # How many characters fit on one line with heading font size.
+    # 21 is also default for TM-T88III.
+    profile.big_char_count = 21
+
+    # Special treatment for specific printer models.
+    match profile.profile_data["name"]:
+        case "TM-T88III":
+            profile.img_kwargs = dict(
+                impl="bitImageColumn",
+                high_density_vertical=True,
+                high_density_horizontal=True,
+                center=False,
+            )
+            profile.default_char_count = 42
+            profile.big_char_count = 21
+            profile.img_cut_index = 4
+        case "TM-U220B":
+            profile.img_kwargs = dict(
+                impl="bitImageColumn",
+                high_density_vertical=False,
+                high_density_horizontal=False,
+                center=False,
+                fragment_height=32,
+            )
+            # NOTE Numbers need less space than letters in case of this
+            # printer (there is space for 40 numbers). Let's use the
+            # smaller number to make sure everything always fits in one
+            # line.
+            profile.default_char_count = 33
+            profile.big_char_count = 16
+            profile.img_cut_index = 9
+            # Profile is wrong, it's 200 dots, not 400
+            # https://files.support.epson.com/pdf/pos/bulk/tm-u220_trg_en_std_reve.pdf
+            # https://github.com/receipt-print-hq/escpos-printer-db/pull/87/commits/242299097
+            profile.profile_data["media"]["width"]["pixels"] = 200
+
+        case _:
+            pass
+
+    # Special treatment for specific connections to printer.
+    match printer:
+        case UsbPrinter():
+            # Usb printer immediately returns, but is usually slower
+            # than Python - improve synchronicity & sleep after each
+            # print command. Otherwise we get a lot of timeouts &
+            # printed gibberish. The time here seems to depend on the
+            # printed material. If it's more dense & blackish / colorful,
+            # then we need a higher value to not run into any trouble.
+            # More spare material seems to be less problematic. Also
+            # the problem becomes bigger if we print multiple pages.
+            profile.sleep_time = 0.3
+        case _:
+            pass

tinyprint/xescpos.py

@@ -0,0 +1,166 @@
+"""Patching escpos library to cut between images without whitespace between
+
+See comment at Job.print for more details.
+"""
+
+from dataclasses import dataclass
+import logging
+import time
+from typing import Optional
+
+import six  # type: ignore
+
+from escpos.image import EscposImage  # type: ignore
+from escpos.escpos import Escpos  # type: ignore
+from escpos.constants import ESC, GS  # type: ignore
+from escpos.exceptions import ImageWidthError  # type: ignore
+from escpos.printer.usb import Usb as UsbPrinter  # type: ignore
+
+
+@dataclass
+class Cmd:
+    index: int
+    cmd: bytes
+
+
+if 1:
+
+    def _image(
+        self,
+        img_source,
+        high_density_vertical: bool = True,
+        high_density_horizontal: bool = True,
+        impl: str = "bitImageRaster",
+        fragment_height: int = 960,
+        center: bool = False,
+        cmd_index_offset: int = 0,
+    ) -> Optional[int]:
+        """Print an image.
+
+        You can select whether the printer should print in high density or not. The default value is high density.
+        When printing in low density, the image will be stretched.
+
+        Esc/Pos supplies several commands for printing. This function supports three of them. Please try to vary the
+        implementations if you have any problems. For example the printer `IT80-002` will have trouble aligning
+        images that are not printed in Column-mode.
+
+        The available printing implementations are:
+
+            * `bitImageRaster`: prints with the `GS v 0`-command
+            * `graphics`: prints with the `GS ( L`-command
+            * `bitImageColumn`: prints with the `ESC *`-command
+
+        When trying to center an image make sure you have initialized the printer with a valid profile, that
+        contains a media width pixel field. Otherwise the centering will have no effect.
+
+        :param img_source: PIL image or filename to load: `jpg`, `gif`, `png` or `bmp`
+        :param high_density_vertical: print in high density in vertical direction *default:* True
+        :param high_density_horizontal: print in high density in horizontal direction *default:* True
+        :param impl: choose image printing mode between `bitImageRaster`, `graphics` or `bitImageColumn`
+        :param fragment_height: Images larger than this will be split into multiple fragments *default:* 960
+        :param center: Center image horizontally *default:* False
+
+        """
+        im = EscposImage(img_source)
+
+        try:
+            if self.profile.profile_data["media"]["width"]["pixels"] == "Unknown":
+                logging.debug(
+                    "The media.width.pixel field of the printer profile is not set. "
+                    + "The center flag will have no effect."
+                )
+
+            max_width = int(self.profile.profile_data["media"]["width"]["pixels"])
+
+            if im.width > max_width:
+                raise ImageWidthError(f"{im.width} > {max_width}")
+
+            if center:
+                im.center(max_width)
+        except KeyError:
+            # If the printer's pixel width is not known, print anyways...
+            pass
+        except ValueError:
+            # If the max_width cannot be converted to an int, print anyways...
+            pass
+
+        if im.height > fragment_height:
+            fragments = im.split(fragment_height)
+            cmd_index_offset = 0
+            for fragment in fragments:
+                cmd_index_offset = self.image(
+                    fragment,
+                    high_density_vertical=high_density_vertical,
+                    high_density_horizontal=high_density_horizontal,
+                    impl=impl,
+                    fragment_height=fragment_height,
+                    cmd_index_offset=cmd_index_offset,
+                )
+                # XXX dummy printer doesn't have '_sleep_in_fragment' method
+                # self._sleep_in_fragment()
+            return None
+
+        if impl == "bitImageRaster":
+            # GS v 0, raster format bit image
+            density_byte = (0 if high_density_horizontal else 1) + (
+                0 if high_density_vertical else 2
+            )
+            header = (
+                GS
+                + b"v0"
+                + bytes((density_byte,))
+                + self._int_low_high(im.width_bytes, 2)
+                + self._int_low_high(im.height, 2)
+            )
+            self._raw(header + im.to_raster_format())
+
+        if impl == "graphics":
+            # GS ( L raster format graphics
+            img_header = self._int_low_high(im.width, 2) + self._int_low_high(
+                im.height, 2
+            )
+            tone = b"0"
+            colors = b"1"
+            ym = b"\x01" if high_density_vertical else b"\x02"
+            xm = b"\x01" if high_density_horizontal else b"\x02"
+            header = tone + xm + ym + colors + img_header
+            raster_data = im.to_raster_format()
+            self._image_send_graphics_data(b"0", b"p", header + raster_data)
+            self._image_send_graphics_data(b"0", b"2", b"")
+
+        if impl == "bitImageColumn":
+            # ESC *, column format bit image
+            density_byte = (1 if high_density_horizontal else 0) + (
+                32 if high_density_vertical else 0
+            )
+            header = (
+                ESC
+                + b"*"
+                + six.int2byte(density_byte)
+                + self._int_low_high(im.width, 2)
+            )
+            self._raw(Cmd(cmd_index_offset, ESC + b"3" + six.int2byte(16)))
+            for i, blob in enumerate(im.to_column_format(high_density_vertical)):
+                cmd_index = i + 1 + cmd_index_offset
+                self._raw(Cmd(cmd_index, header + blob + b"\n"))
+            self._raw(ESC + b"2")
+            return cmd_index_offset + i + 1
+
+        return None
+
+    Escpos.image = _image
+
+
+if 1:
+
+    # Usb printer: reduce likelihood for timeout gibberish
+
+    _Usb_raw_original = UsbPrinter._raw
+
+    def _Usb_raw(self, *args, **kwargs) -> None:
+        _Usb_raw_original(self, *args, **kwargs)
+        # NOTE Patch to reduce likelihood for timeout gibberish
+        while self._read():
+            time.sleep(0.01)
+
+    UsbPrinter._raw = _Usb_raw

tinyprint-0.2.4.dist-info/METADATA

@@ -0,0 +1,53 @@
+Metadata-Version: 2.4
+Name: tinyprint
+Version: 0.2.4
+Summary: ui & cli to print zines with esc/pos printer
+Author-email: Levin Eric Zimmermann <levin.eric.zimmermann@posteo.com>
+License: GPL
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: python-escpos[serial,usb]>=3.1
+Requires-Dist: dataclasses-json>=0.6.0
+Requires-Dist: marko>=2.1.2
+Requires-Dist: pdf2image>=1.17.0
+Provides-Extra: dev
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: syrupy; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: types-six; extra == "dev"
+Requires-Dist: types-pillow; extra == "dev"
+Dynamic: license-file
+
+# tinyprint
+
+Software for printing tiny zines with ESC/POS printer.
+
+![gui screenshot](screenshot.jpg)
+
+## Installation
+
+### MacOS
+
+Open a console and type:
+
+```bash
+/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)
+brew install python
+brew install python-tk
+brew install pipx
+pipx install tinyprint
+```
+
+## Linux
+
+Install python, and then just use pip:
+
+```bash
+pip3 install tinyprint
+```
+
+## Windows
+
+I don't know, but if someone manages, please let us know.

tinyprint-0.2.4.dist-info/RECORD

@@ -0,0 +1,22 @@
+tinyprint/__init__.py,sha256=CsfZ8XmcGxZWncloB7ThieYJ7JrlUVpaur4lPo__LQY,143
+tinyprint/__main__.py,sha256=tMge3GTK-YL3eA2K35I9MDptKg5UIgp_xLrfHZoynow,421
+tinyprint/config.py,sha256=PPd4PYnYKsX0_cSW1aihyYjC0dnPVzKSzBICZWCDhe8,58
+tinyprint/gui.py,sha256=uVaDzteZamqs0HjG7R2e-jgju4u_AhS6bRq5GoKMffA,8603
+tinyprint/gui_misc.py,sha256=YUnuNUDT9lubv9_OacadJNvXIpLq1Zh7WXwARxuqqy0,4624
+tinyprint/job.py,sha256=uXxzkU-nFifEN5EP8M0VKf9N0mkLWJpqzb_xnRt73Bw,4970
+tinyprint/jobconfig.py,sha256=h_bLTb9gQPTNtHM_Q-nb4KXpwxYPz8hejCJUsh2Hoeg,1683
+tinyprint/patches.py,sha256=tlk2FNlbMU24OMHm24BmEGVgNvZzRQdKbL8BYeIjoxQ,551
+tinyprint/preprocessor.py,sha256=CI0IgL3M1vdLAt_HAvitft_gp0Dy1PNqUjzYxe3M908,10009
+tinyprint/xescpos.py,sha256=QCrocWFDq4pElgw6_1HOdNE0JHb-aQv_UOjIxzxXyxo,6173
+tinyprint/patches/__init__.py,sha256=Mp1lgkpNc6PqSOj9K36_eRJpV3OWvsZePTjN_7S5o9M,63
+tinyprint/patches/escpos.py,sha256=b9HcGgmQ-ZjNieE3cN-ENyTUth1vcOURoOfkc0pHEK0,6490
+tinyprint/patches/mako.py,sha256=NTL5ZXuHRZivwDtnnUJFgewbbM8aT08hzQLvWKFfoLU,545
+tinyprint/printer/__init__.py,sha256=DjfK6xdR56ZLM4vVZKad2ZUHRx1_Jw8DGsRZ2LiDObE,44
+tinyprint/printer/manager.py,sha256=Am1h77wtB3BPZ6Kh-6vollN_kUgacAzeCAEeAtS_yXo,4711
+tinyprint/printer/profile.py,sha256=7k-T8BjH-n13Z_Dca_I-UZjPiOe1Li31juETLQcofUw,3671
+tinyprint-0.2.4.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+tinyprint-0.2.4.dist-info/METADATA,sha256=iR56rCdNbs2voYx9rcwgcFIkpM_bUuW3HtsTVtieh2M,1209
+tinyprint-0.2.4.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+tinyprint-0.2.4.dist-info/entry_points.txt,sha256=HIRCgyspB4RGducBJkc106a99iXPCHNWTXbbZG51ut4,54
+tinyprint-0.2.4.dist-info/top_level.txt,sha256=wZggB6MuNZLbIYB99OeMuQXDT8Za-OIIEk7xY9ylaoU,10
+tinyprint-0.2.4.dist-info/RECORD,,

tinyprint-0.2.4.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.10.2)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

tinyprint-0.2.4.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+tinyprint = tinyprint.__main__:main