tinyprint 0.1.0__tar.gz → 0.2.0__tar.gz

{tinyprint-0.1.0 → tinyprint-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: tinyprint
-Version: 0.1.0
+Version: 0.2.0
 Summary: ui & cli to print zines with esc/pos printer
 Author-email: Levin Eric Zimmermann <levin.eric.zimmermann@posteo.eu>
 License: GPL
@@ -10,11 +10,13 @@ License-File: LICENSE
 Requires-Dist: python-escpos>=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: pytest; extra == "dev"
 Requires-Dist: mypy; extra == "dev"
 Requires-Dist: types-six; extra == "dev"
 Requires-Dist: types-pillow; extra == "dev"
+Dynamic: license-file
 
 # tinyprint
 

{tinyprint-0.1.0 → tinyprint-0.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "tinyprint"
-version = "0.1.0"
+version = "0.2.0"
 authors = [
     {name = "Levin Eric Zimmermann", email = "levin.eric.zimmermann@posteo.eu"},
 ]
@@ -11,6 +11,7 @@ dependencies = [
     'python-escpos>=3.1',
     'dataclasses-json>=0.6.0',
     'marko>=2.1.2',
+    'pdf2image>=1.17.0',
 ]
 
 [project.optional-dependencies]

tinyprint-0.2.0/tests/test_jobconfig.py

@@ -0,0 +1,12 @@
+from tinyprint.jobconfig import JobConfig, PageSize
+
+
+def test_io(tmpdir):
+    # json_path = f"{tmpdir}/test.json"
+    # config = JobConfig(
+    #     [("myfile.pdf", None)], "myprinter.yml", page_size=PageSize(70, 30)
+    # )
+    # config.to_file(json_path)
+    # c2 = JobConfig.from_file(json_path)
+    # assert c2 == config
+    pass

{tinyprint-0.1.0 → tinyprint-0.2.0}/tinyprint/__init__.py

@@ -1,3 +1,6 @@
+from . import patches
+del patches
+
 from . import config
 from . import xescpos
 from . import jobconfig

{tinyprint-0.1.0 → tinyprint-0.2.0}/tinyprint/__main__.py

@@ -17,7 +17,7 @@ from tkinter.filedialog import (
     asksaveasfilename,
 )
 
-from tinyprint.jobconfig import JobConfig
+from tinyprint.jobconfig import JobConfig, Resource
 from tinyprint.job import Job
 
 
@@ -35,7 +35,10 @@ def _main(tempdir: str):
     frm = ttk.Frame(root, padding=15)
     frm.grid()
 
-    _no_hidden_files(root)
+    try:  # support macos
+        _no_hidden_files(root)
+    except Exception:
+        pass
 
     jcm = JobConfigManager(
         JobConfigFields(frm), tempdir, filename_indicator=tk.StringVar(value="")
@@ -123,7 +126,7 @@ class JobConfigFields:
 
     def update(self, job_config: JobConfig):
         resource_list = "; ".join(
-            [r[0].split(os.sep)[-1] for r in job_config.resource_list]
+            [r.path.split(os.sep)[-1] for r in job_config.resource_list]
         )
         if len(resource_list) > 25:
             resource_list = resource_list[:30] + " ..."
@@ -151,7 +154,7 @@ class JobConfigManager:
         self.new(f"{self.tempdir}/tmp-print-job.json")
 
     def new(self, *args, **kwargs):
-        self.job_config = JobConfig([(self.temp_resource, None)])
+        self.job_config = JobConfig([Resource(self.temp_resource)])
         self.save_as(*args, **kwargs)
         self.updatefields()
 
@@ -205,7 +208,7 @@ class JobConfigManager:
         if not file_tuple:
             return
 
-        resource_list = [(p, None) for p in file_tuple]
+        resource_list = [Resource(p) for p in file_tuple]
 
         self.job_config.resource_list = resource_list
         self.updatefields()
@@ -216,7 +219,9 @@ class JobConfigManager:
             ("all files", "*.*"),
         )
         filename = askopenfilename(
-            title="Open a file", initialdir=str(Path.home()), filetypes=filetypes
+            title="Open a file",
+            initialdir=initialdir(self.job_config.printer_config),
+            filetypes=filetypes,
         )
         if filename:
             self.job_config.printer_config = filename
@@ -252,3 +257,7 @@ class JobManager:
         if self.job:
             self.job.stop()
             self.job = None
+
+
+def initialdir(var):
+    return (var and str(Path(var).parent)) or str(Path.home())

{tinyprint-0.1.0 → tinyprint-0.2.0}/tinyprint/job.py

@@ -130,7 +130,7 @@ class Job:
         page_list = []
         for resource in self.config.resource_list:
             preprocessor = self.resource_to_preprocessor(resource)
-            page_list.append(preprocessor(resource))
+            page_list.extend(preprocessor(resource))
         return tuple(page_list)
 
     def _send_to_printer(self, cmd_list: list[bytes]):
@@ -202,7 +202,7 @@ class Job:
         return logger
 
     def resource_to_preprocessor(self, resource: Resource):
-        path = resource[0]
+        path = resource.path
         p = None
         if _is_binary_file(path):
             m = mimetypes.guess_type(path)
@@ -230,6 +230,13 @@ def patch_printer_profile(printer):
     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":
@@ -239,6 +246,8 @@ def patch_printer_profile(printer):
                 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(
@@ -248,6 +257,12 @@ def patch_printer_profile(printer):
                 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

{tinyprint-0.1.0 → tinyprint-0.2.0}/tinyprint/jobconfig.py

@@ -48,9 +48,12 @@ class PageSize(DataClassJsonMixin):
                 raise NotImplementedError(f"can't parse {obj} to PageSize")
 
 
-ResourcePath: TypeAlias = str
-FragmentHeight: TypeAlias = Optional[int]
-Resource: TypeAlias = tuple[ResourcePath, FragmentHeight]
+@dataclass
+class Resource:
+    path: str
+    fragment_height: Optional[int] = None
+    # Either 0 (= black) or 1 (= red)
+    color: int = 0
 
 
 @dataclass

tinyprint-0.2.0/tinyprint/patches.py

@@ -0,0 +1,28 @@
+"""Monkey patches"""
+
+from marko import block
+
+# Allow multiple blank lines to create multiple blank lines
+
+
+class BlankLine(block.BlockElement):
+    """Blank lines"""
+
+    priority = 5
+
+    def __init__(self, start: int) -> None:
+        self._anchor = start
+
+    @classmethod
+    def match(cls, source) -> bool:
+        line = source.next_line()
+        return line is not None and not line.strip()
+
+    @classmethod
+    def parse(cls, source) -> int:
+        m = source.match
+        source.consume()
+        return m
+
+
+block.BlankLine = BlankLine

tinyprint-0.2.0/tinyprint/preprocessor.py

@@ -0,0 +1,231 @@
+from __future__ import annotations
+
+import abc
+from functools import cached_property
+from tempfile import TemporaryDirectory
+from typing import Callable, TypeAlias, Optional
+
+from escpos.escpos import Escpos  # type: ignore
+from escpos.constants import TXT_STYLE
+import marko  # type: ignore
+from PIL import Image  # type: ignore
+from pdf2image import convert_from_path  # type: ignore
+
+from tinyprint.jobconfig import Resource, Orientation
+from tinyprint.job import Job
+
+Page: TypeAlias = Callable[[Escpos], None]
+
+
+class Preprocessor(abc.ABC):
+    def __init__(self, job: Job):
+        self.job = job
+
+    @abc.abstractmethod
+    def __call__(self, resource: Resource) -> tuple[Page, ...]: ...
+
+
+class ImagePreprocessor(Preprocessor):
+    def __call__(self, resource: Resource):
+        return (get_image_printer(resource, self.job),)
+
+
+def get_image_printer(resource, job):
+    path, fragment_height = resource.path, resource.fragment_height
+    profile = job.printer.profile
+
+    # Immediately load & process image - in case image path is volatile
+    # (as it's the case if PdfPreprocessor parses us an img path), we
+    # don't loose the image. The downside of this is that we need to keep
+    # the image in our RAM. But because we resize, and the resolution of
+    # the ESC/POS printer is usually quite low, this is acceptable and
+    # should only create problem in case of very large books.
+    with Image.open(path) as im:
+        if job.config.orientation != Orientation.HORIZONTAL:
+            im = im.rotate(angle=-90, expand=True)
+        max_width = profile.profile_data["media"]["width"]["pixels"]
+        assert max_width != "Unknown", "max_width of printer unknown!"
+        max_width = int(max_width * profile.img_scale_factor)
+        width = im.width
+        heigth = im.height
+        factor = max_width / width
+        final_im = im.resize(
+            (
+                int(width * factor * profile.img_x_scale_factor),
+                int(heigth * factor * profile.img_y_scale_factor),
+            )
+        )
+
+    color = ("black", "red")[resource.color]
+
+    def _(printer):
+        printer._raw(TXT_STYLE["color"][color])
+        try:
+            # Add extra space between to make spaces between cuts even
+            # XXX Does number '10' need to change depending on printer?
+            if job.config.cut:
+                printer.line_spacing(10)
+                printer.ln()
+                printer.line_spacing()
+
+            img_kwargs = dict(job.printer.profile.img_kwargs)
+            if fragment_height:
+                img_kwargs["fragment_height"] = fragment_height
+
+            printer.image(
+                final_im,
+                **img_kwargs,
+            )
+        finally:
+            final_im.close()
+
+    return _
+
+
+class PdfPreprocessor(ImagePreprocessor):
+    def __call__(self, resource: Resource):
+        pdf_path = resource.path
+        with TemporaryDirectory() as tmp_path:
+            image_list = convert_from_path(pdf_path, output_folder=tmp_path, dpi=600)
+            if self.job.config.orientation == Orientation.HORIZONTAL:
+                image_list = [im.rotate(angle=-90, expand=True) for im in image_list]
+            page_list = []
+            for i, img in enumerate(image_list):
+                p = f"{tmp_path}/{i}.png"
+                img.save(p)
+                page_list.extend(super().__call__(Resource(p, 0)))
+        return tuple(page_list)
+
+
+class MarkdownPreprocessor(Preprocessor):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.markdown = marko.Markdown(renderer=_EscposRenderer)
+        self.markdown._setup_extensions()
+
+    def __call__(self, resource: Resource):
+        with open(resource.path, "r") as f:
+            md = f.read()
+
+        def _(printer):
+            self.markdown.renderer.set_printer(printer)
+            self.markdown.renderer.set_job(self.job)
+            self.markdown(md)
+
+        return (_,)
+
+
+class _EscposRenderer(marko.renderer.Renderer):
+    # Ref: https://github.com/frostming/marko/blob/master/marko/html_renderer.py
+
+    # TODO Add auto page breaks
+
+    def render_raw_text(self, element) -> str:
+        self._printer.text(element.children)
+        # XXX: Temporarily disable auto-line break until it can be configured in UI
+        # word_list = element.children.split(" ")
+        # max_char_count = self.max_char_count
+        # for word in word_list:
+        #     char_count = len(word)
+        #     # If word is too big for one line, just skip line breaking.
+        #     if char_count > max_char_count:
+        #         self._printer.text(word)
+        #         self.line_position = self.line_position % max_char_count
+        #         continue
+        #     add_whitespace = self.line_position > 0
+        #     new_pos = self.line_position + char_count + add_whitespace
+        #     diff = new_pos - max_char_count
+        #     if diff <= 0:
+        #         if add_whitespace:
+        #             self._printer.text(" ")
+        #         self._printer.text(word)
+        #         self.line_position = new_pos
+        #     else:  # diff > 0
+        #         space_count = max_char_count - self.line_position
+        #         if space_count:
+        #             self._printer.text(" " * space_count)
+        #         self._printer.text(word)
+        #         self.line_position = char_count
+        return ""
+
+    def render_emphasis(self, element) -> str:
+        self._set(bold=True)
+        self.render_children(element)
+        self._set(bold=False)
+        return ""
+
+    def render_image(self, element) -> str:
+        resource = Resource(path=element.dest)
+        get_image_printer(resource, self._job)(self._printer)
+        return ""
+
+    def render_strong_emphasis(self, element) -> str:
+        return self.render_emphasis(element)
+
+    def render_blank_line(self, element=None):
+        self.render_line_break(line_count=1)
+        return ""
+
+    def render_line_break(self, element=None, line_count: Optional[int] = None) -> str:
+        soft = element.soft if element else True
+        if line_count is None:
+            if soft:
+                line_count = 1
+            else:
+                line_count = 2
+        self._printer.ln(line_count)
+        self.line_position = 0
+        return ""
+
+    def render_paragraph(self, element) -> str:
+        self.render_children(element)
+        self.render_line_break()
+        return ""
+
+    def render_heading(self, element) -> str:
+        self.max_char_count = self.printer_profile.big_char_count
+        self._set(double_height=True, double_width=True)
+        self.render_children(element)
+        self._set(double_height=False, double_width=False, normal_textsize=True)
+        self.render_line_break(line_count=3)
+        self.max_char_count = self.printer_profile.default_char_count
+        return ""
+
+    def set_printer(self, printer):
+        self._printer = printer
+
+    def set_job(self, job):
+        self._job = job
+
+    def _set(self, *args, **kwargs):
+        if self._printer:
+            self._printer.set(*args, **kwargs)
+        else:
+            raise RuntimeError("printer not yet set")
+
+    @property
+    def line_position(self):
+        try:
+            return self._line_position
+        except AttributeError:
+            return 0
+
+    @line_position.setter
+    def line_position(self, line_position: int):
+        self._line_position = line_position
+
+    @cached_property
+    def printer_profile(self):
+        return self._job.printer.profile
+
+    @property
+    def max_char_count(self):
+        try:
+            return self._max_char_count
+        except AttributeError:
+            self.max_char_count = self.printer_profile.default_char_count
+            return self.max_char_count
+
+    @max_char_count.setter
+    def max_char_count(self, max_char_count: int):
+        self._max_char_count = max_char_count

{tinyprint-0.1.0 → tinyprint-0.2.0}/tinyprint.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: tinyprint
-Version: 0.1.0
+Version: 0.2.0
 Summary: ui & cli to print zines with esc/pos printer
 Author-email: Levin Eric Zimmermann <levin.eric.zimmermann@posteo.eu>
 License: GPL
@@ -10,11 +10,13 @@ License-File: LICENSE
 Requires-Dist: python-escpos>=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: pytest; extra == "dev"
 Requires-Dist: mypy; extra == "dev"
 Requires-Dist: types-six; extra == "dev"
 Requires-Dist: types-pillow; extra == "dev"
+Dynamic: license-file
 
 # tinyprint
 

{tinyprint-0.1.0 → tinyprint-0.2.0}/tinyprint.egg-info/SOURCES.txt

@@ -3,12 +3,12 @@ README.md
 pyproject.toml
 tests/test_job.py
 tests/test_jobconfig.py
-tests/test_markdown_preprocessor.py
 tinyprint/__init__.py
 tinyprint/__main__.py
 tinyprint/config.py
 tinyprint/job.py
 tinyprint/jobconfig.py
+tinyprint/patches.py
 tinyprint/preprocessor.py
 tinyprint/xescpos.py
 tinyprint.egg-info/PKG-INFO

{tinyprint-0.1.0 → tinyprint-0.2.0}/tinyprint.egg-info/requires.txt

@@ -1,6 +1,7 @@
 python-escpos>=3.1
 dataclasses-json>=0.6.0
 marko>=2.1.2
+pdf2image>=1.17.0
 
 [dev]
 pytest

tinyprint-0.1.0/tests/test_jobconfig.py

@@ -1,11 +0,0 @@
-from tinyprint.jobconfig import JobConfig, PageSize
-
-
-def test_io(tmpdir):
-    json_path = f"{tmpdir}/test.json"
-    config = JobConfig(
-        [("myfile.pdf", None)], "myprinter.yml", page_size=PageSize(70, 30)
-    )
-    config.to_file(json_path)
-    c2 = JobConfig.from_file(json_path)
-    assert c2 == config

tinyprint-0.1.0/tests/test_markdown_preprocessor.py

@@ -1,27 +0,0 @@
-from tinyprint.job import Job
-from tinyprint.jobconfig import JobConfig
-
-
-def test_markdown_preprocessor(tmpdir):
-    md_file_path = f"{tmpdir}/test.md"
-    with open(md_file_path, "w") as f:
-        f.write(md)
-
-    config = JobConfig([[md_file_path, 0]])
-    job = Job(config)
-    page_tuple = job._generate_page_tuple()
-    for p in page_tuple:
-        p(job.printer)
-
-
-md = r"""
-
-# hello world
-
-this is a test.
-
-this is still a *test*.
-
-[abc](https://codeberg.org)
-
-"""

tinyprint-0.1.0/tinyprint/preprocessor.py

@@ -1,132 +0,0 @@
-from __future__ import annotations
-
-import abc
-from typing import Callable, TypeAlias
-
-from escpos.escpos import Escpos  # type: ignore
-import marko  # type: ignore
-from PIL import Image  # type: ignore
-
-from tinyprint.jobconfig import Resource
-from tinyprint.job import Job
-
-
-Page: TypeAlias = Callable[[Escpos], None]
-
-
-class Preprocessor(abc.ABC):
-    def __init__(self, job: Job):
-        self.job = job
-
-    @abc.abstractmethod
-    def __call__(self, resource: Resource) -> Page: ...
-
-
-class ImagePreprocessor(Preprocessor):
-    def __call__(self, resource: Resource):
-        profile = self.job.printer.profile
-
-        def _(printer):
-
-            with Image.open(resource[0]) as im:
-                max_width = profile.profile_data["media"]["width"]["pixels"]
-                assert max_width != "Unknown", "max_width of printer unknown!"
-                max_width = int(max_width * profile.img_scale_factor)
-                width = im.width
-                heigth = im.height
-                factor = max_width / width
-                im = im.resize(
-                    (
-                        int(width * factor * profile.img_x_scale_factor),
-                        int(heigth * factor * profile.img_y_scale_factor),
-                    )
-                )
-
-                # Add extra space between to make spaces between cuts even
-                # XXX Does number '10' need to change depending on printer?
-                if self.job.config.cut:
-                    printer.line_spacing(10)
-                    printer.ln()
-                    printer.line_spacing()
-
-                img_kwargs = dict(self.job.printer.profile.img_kwargs)
-                if fragment_height := resource[1]:
-                    img_kwargs["fragment_height"] = fragment_height
-
-                printer.image(
-                    im,
-                    **img_kwargs,
-                )
-
-        return _
-
-
-# https://github.com/Belval/pdf2image
-# but then we depend on 1 more external program: poppler
-class PdfPreprocessor(Preprocessor): ...
-
-
-class MarkdownPreprocessor(Preprocessor):
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        self.markdown = marko.Markdown(renderer=_EscposRenderer)
-        self.markdown._setup_extensions()
-
-    def __call__(self, resource: Resource):
-        with open(resource[0], "r") as f:
-            md = f.read()
-
-        def _(printer):
-            self.markdown.renderer.set_printer(printer)
-            self.markdown(md)
-
-        return _
-
-
-class _EscposRenderer(marko.renderer.Renderer):
-    # Ref: https://github.com/frostming/marko/blob/master/marko/html_renderer.py
-
-    # TODO Allow images
-    # TODO Add auto line breaks
-    # TODO Add auto page breaks
-
-    def render_raw_text(self, element) -> str:
-        self._printer.text(element.children)
-        return ""
-
-    def render_emphasis(self, element) -> str:
-        self._set(bold=True)
-        self.render_children(element)
-        self._set(bold=False)
-        return ""
-
-    def render_strong_emphasis(self, element) -> str:
-        return self.render_emphasis(element)
-
-    def render_line_break(self, element) -> str:
-        self._printer.ln(2)
-        return ""
-
-    def render_paragraph(self, element) -> str:
-        self.render_children(element)
-        self._printer.ln(2)
-        return ""
-
-    def render_heading(self, element) -> str:
-        self._set(double_height=True, double_width=True)
-        self.render_children(element)
-        self._set(double_height=False, double_width=False, normal_textsize=True)
-        self._printer.ln(3)
-        return ""
-
-    def set_printer(self, printer):
-        self._printer = printer
-
-    def set_job(self, job):
-        self._job = job
-
-    def _set(self, *args, **kwargs):
-        if self._printer:
-            self._printer.set(*args, **kwargs)
-        else:
-            raise RuntimeError("printer not yet set")