kittytgp 0.0.1__tar.gz

kittytgp-0.0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

kittytgp-0.0.1/PKG-INFO

@@ -0,0 +1,91 @@
+Metadata-Version: 2.4
+Name: kittytgp
+Version: 0.0.1
+Summary: Tiny kitty graphics protocol PNG renderer using Unicode placeholders
+Author: Jeremy Howard
+License: Apache-2.0
+Project-URL: Source, https://github.com/answerdotai/kittytgp
+Keywords: kitty,terminal,graphics,tmux,png
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Terminals
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# kittytgp
+
+`kittytgp` is a small pure-Python package that renders a PNG with kitty's graphics protocol using Unicode placeholders (`U+10EEEE`).
+
+It follows kitty's tmux/editor-friendly placeholder flow:
+
+1. transmit PNG data with kitty graphics protocol
+2. create a **virtual** placement with `U=1`
+3. print `U+10EEEE` placeholder text colored with the image ID
+
+Because the visible part is ordinary Unicode text, the image moves with the text buffer and works inside hosts such as tmux.
+
+## Install
+
+```bash
+pip install kittytgp
+```
+
+## CLI
+
+```bash
+kittytgp plot.png
+```
+
+Useful options:
+
+```bash
+kittytgp plot.png --cols 40
+kittytgp plot.png --rows 20
+kittytgp plot.png --cell-size 10x20
+kittytgp plot.png --passthrough tmux
+kittytgp plot.png --image-id 0x123456
+kittytgp plot.png --no-newline
+```
+
+Inside tmux, enable passthrough:
+
+```tmux
+set -g allow-passthrough on
+```
+
+## Python API
+
+```python
+from kittytgp import render_png
+
+render_png("plot.png")
+```
+
+Or build the bytes yourself:
+
+```python
+from kittytgp import build_render_bytes
+
+payload = build_render_bytes("plot.png")
+```
+
+## Design notes
+
+This package intentionally stays small:
+
+- PNG input only
+- direct transfer (`f=100` PNG payload in APC chunks)
+- Unicode placeholders only
+- 24-bit image IDs encoded in truecolor foreground color
+- tmux passthrough only when needed
+
+By default it fits the image into the current terminal while preserving aspect ratio. If the terminal cannot report cell pixel size, pass `--cell-size`, `--cols`, or `--rows`.
+

kittytgp-0.0.1/README.md

@@ -0,0 +1,69 @@
+# kittytgp
+
+`kittytgp` is a small pure-Python package that renders a PNG with kitty's graphics protocol using Unicode placeholders (`U+10EEEE`).
+
+It follows kitty's tmux/editor-friendly placeholder flow:
+
+1. transmit PNG data with kitty graphics protocol
+2. create a **virtual** placement with `U=1`
+3. print `U+10EEEE` placeholder text colored with the image ID
+
+Because the visible part is ordinary Unicode text, the image moves with the text buffer and works inside hosts such as tmux.
+
+## Install
+
+```bash
+pip install kittytgp
+```
+
+## CLI
+
+```bash
+kittytgp plot.png
+```
+
+Useful options:
+
+```bash
+kittytgp plot.png --cols 40
+kittytgp plot.png --rows 20
+kittytgp plot.png --cell-size 10x20
+kittytgp plot.png --passthrough tmux
+kittytgp plot.png --image-id 0x123456
+kittytgp plot.png --no-newline
+```
+
+Inside tmux, enable passthrough:
+
+```tmux
+set -g allow-passthrough on
+```
+
+## Python API
+
+```python
+from kittytgp import render_png
+
+render_png("plot.png")
+```
+
+Or build the bytes yourself:
+
+```python
+from kittytgp import build_render_bytes
+
+payload = build_render_bytes("plot.png")
+```
+
+## Design notes
+
+This package intentionally stays small:
+
+- PNG input only
+- direct transfer (`f=100` PNG payload in APC chunks)
+- Unicode placeholders only
+- 24-bit image IDs encoded in truecolor foreground color
+- tmux passthrough only when needed
+
+By default it fits the image into the current terminal while preserving aspect ratio. If the terminal cannot report cell pixel size, pass `--cell-size`, `--cols`, or `--rows`.
+

kittytgp-0.0.1/kittytgp/__init__.py

@@ -0,0 +1,2 @@
+from .core import build_render_bytes, render_png
+__version__ = "0.0.1"

kittytgp-0.0.1/kittytgp/__main__.py

@@ -0,0 +1,3 @@
+from .core import main
+
+raise SystemExit(main())

kittytgp-0.0.1/kittytgp/core.py

@@ -0,0 +1,403 @@
+from __future__ import annotations
+
+import argparse
+import base64
+import math
+import os
+import secrets
+import shutil
+import struct
+import subprocess
+import sys
+from dataclasses import dataclass
+from importlib import resources
+from pathlib import Path
+from typing import BinaryIO
+
+try:
+    import fcntl
+    import termios
+except ImportError:  # pragma: no cover
+    fcntl = None
+    termios = None
+
+PLACEHOLDER = "\U0010EEEE"
+PNG_SIGNATURE = b"\x89PNG\r\n\x1a\n"
+DEFAULT_CHUNK_SIZE = 4096
+
+
+@dataclass(frozen=True)
+class TerminalGeometry:
+    cols: int
+    rows: int
+    cell_width_px: int
+    cell_height_px: int
+
+
+def _load_diacritics() -> tuple[str, ...]:
+    text = resources.files("kittytgp").joinpath("rowcolumn_diacritics.txt").read_text(encoding="utf-8")
+    out: list[str] = []
+    for line in text.splitlines():
+        line = line.strip()
+        if not line or line.startswith("#"):
+            continue
+        out.append(chr(int(line.split(";", 1)[0], 16)))
+    if not out:
+        raise RuntimeError("Could not load kitty row/column diacritics")
+    return tuple(out)
+
+
+DIACRITICS = _load_diacritics()
+
+
+def _parse_png_size(data: bytes) -> tuple[int, int]:
+    if not data.startswith(PNG_SIGNATURE):
+        raise ValueError("input is not a PNG file")
+    if len(data) < 24:
+        raise ValueError("PNG is too short")
+    ihdr_len = struct.unpack(">I", data[8:12])[0]
+    if ihdr_len != 13 or data[12:16] != b"IHDR":
+        raise ValueError("PNG does not start with an IHDR chunk")
+    width, height = struct.unpack(">II", data[16:24])
+    if width <= 0 or height <= 0:
+        raise ValueError("PNG has invalid dimensions")
+    return width, height
+
+
+def _read_png(path_or_bytes: str | os.PathLike[str] | bytes) -> tuple[bytes, int, int]:
+    if isinstance(path_or_bytes, bytes):
+        data = path_or_bytes
+    else:
+        data = Path(path_or_bytes).read_bytes()
+    width, height = _parse_png_size(data)
+    return data, width, height
+
+
+def _ioctl_winsize(fileno: int) -> tuple[int, int, int, int] | None:
+    if fcntl is None or termios is None:
+        return None
+    try:
+        packed = fcntl.ioctl(fileno, termios.TIOCGWINSZ, struct.pack("HHHH", 0, 0, 0, 0))
+        rows, cols, xpixel, ypixel = struct.unpack("HHHH", packed)
+    except OSError:
+        return None
+    return rows, cols, xpixel, ypixel
+
+
+def _tmux_cell_size() -> tuple[int, int] | None:
+    if not os.environ.get("TMUX"):
+        return None
+    try:
+        proc = subprocess.run(
+            ["tmux", "display-message", "-p", "#{client_cell_width} #{client_cell_height}"],
+            check=True,
+            stdout=subprocess.PIPE,
+            stderr=subprocess.DEVNULL,
+            text=True,
+        )
+    except Exception:
+        return None
+    parts = proc.stdout.strip().split()
+    if len(parts) != 2:
+        return None
+    try:
+        width, height = (int(parts[0]), int(parts[1]))
+    except ValueError:
+        return None
+    if width <= 0 or height <= 0:
+        return None
+    return width, height
+
+
+def _geometry_from_fileno(
+    fileno: int,
+    *,
+    cell_width_px: int | None,
+    cell_height_px: int | None,
+) -> TerminalGeometry | None:
+    winsize = _ioctl_winsize(fileno)
+    if winsize is None:
+        return None
+    rows, cols, xpixel, ypixel = winsize
+    if cols <= 0 or rows <= 0:
+        return None
+    if cell_width_px is not None and cell_height_px is not None:
+        return TerminalGeometry(cols=cols, rows=rows, cell_width_px=cell_width_px, cell_height_px=cell_height_px)
+    if xpixel > 0 and ypixel > 0:
+        return TerminalGeometry(
+            cols=cols,
+            rows=rows,
+            cell_width_px=max(1, xpixel // cols),
+            cell_height_px=max(1, ypixel // rows),
+        )
+    tmux_cell = _tmux_cell_size()
+    if tmux_cell is not None:
+        return TerminalGeometry(cols=cols, rows=rows, cell_width_px=tmux_cell[0], cell_height_px=tmux_cell[1])
+    return None
+
+
+def get_terminal_geometry(
+    fileno: int,
+    *,
+    cell_width_px: int | None = None,
+    cell_height_px: int | None = None,
+) -> TerminalGeometry:
+    geom = _geometry_from_fileno(fileno, cell_width_px=cell_width_px, cell_height_px=cell_height_px)
+    if geom is not None:
+        return geom
+    try:
+        with open("/dev/tty", "rb", buffering=0) as tty:
+            geom = _geometry_from_fileno(tty.fileno(), cell_width_px=cell_width_px, cell_height_px=cell_height_px)
+    except OSError:
+        geom = None
+    if geom is not None:
+        return geom
+    size = shutil.get_terminal_size(fallback=(80, 24))
+    if cell_width_px is not None and cell_height_px is not None:
+        return TerminalGeometry(
+            cols=size.columns,
+            rows=size.lines,
+            cell_width_px=cell_width_px,
+            cell_height_px=cell_height_px,
+        )
+    raise RuntimeError("unable to determine terminal cell size; pass --cell-size, --cols, or --rows")
+
+
+def _fit_cells(
+    image_width_px: int,
+    image_height_px: int,
+    geometry: TerminalGeometry,
+    *,
+    cols: int | None,
+    rows: int | None,
+    newline: bool,
+) -> tuple[int, int]:
+    if cols is not None and cols <= 0:
+        raise ValueError("cols must be positive")
+    if rows is not None and rows <= 0:
+        raise ValueError("rows must be positive")
+
+    cw = geometry.cell_width_px
+    ch = geometry.cell_height_px
+
+    if cols is not None and rows is not None:
+        return cols, rows
+    if cols is not None:
+        rows = math.ceil((image_height_px * cols * cw) / (image_width_px * ch))
+        return max(1, cols), max(1, rows)
+    if rows is not None:
+        cols = math.ceil((image_width_px * rows * ch) / (image_height_px * cw))
+        return max(1, cols), max(1, rows)
+
+    avail_cols = max(1, geometry.cols)
+    avail_rows = max(1, geometry.rows - (1 if newline else 0))
+    scale = min(
+        (avail_cols * cw) / image_width_px,
+        (avail_rows * ch) / image_height_px,
+        1.0,
+    )
+    width_px = max(1, math.ceil(image_width_px * scale))
+    height_px = max(1, math.ceil(image_height_px * scale))
+    return max(1, math.ceil(width_px / cw)), max(1, math.ceil(height_px / ch))
+
+
+def _resolve_passthrough(mode: str) -> str:
+    if mode not in {"auto", "none", "tmux"}:
+        raise ValueError("passthrough must be 'auto', 'none', or 'tmux'")
+    if mode == "auto":
+        return "tmux" if os.environ.get("TMUX") else "none"
+    return mode
+
+
+def _wrap_tmux_passthrough(seq: bytes) -> bytes:
+    return b"\x1bPtmux;" + seq.replace(b"\x1b", b"\x1b\x1b") + b"\x1b\\"
+
+
+def _graphics_apc(control: str, payload: bytes, *, passthrough: str) -> bytes:
+    seq = b"\x1b_G" + control.encode("ascii") + b";" + payload + b"\x1b\\"
+    return _wrap_tmux_passthrough(seq) if passthrough == "tmux" else seq
+
+
+def _iter_transmit_chunks(
+    png_data: bytes,
+    *,
+    cols: int,
+    rows: int,
+    image_id: int,
+    chunk_size: int,
+    passthrough: str,
+) -> list[bytes]:
+    encoded = base64.standard_b64encode(png_data)
+    chunks = [encoded[i : i + chunk_size] for i in range(0, len(encoded), chunk_size)] or [b""]
+    out: list[bytes] = []
+    for i, chunk in enumerate(chunks):
+        more = 1 if i < len(chunks) - 1 else 0
+        meta = f"a=T,f=100,q=2,U=1,i={image_id},c={cols},r={rows}," if i == 0 else ""
+        out.append(_graphics_apc(f"{meta}m={more}", chunk, passthrough=passthrough))
+    return out
+
+
+def _placeholder_grid(cols: int, rows: int, image_id: int) -> str:
+    if rows > len(DIACRITICS):
+        raise ValueError(f"too many rows for kitty Unicode placeholders: {rows} > {len(DIACRITICS)}")
+    if cols <= 0 or rows <= 0:
+        raise ValueError("cols and rows must be positive")
+    r = (image_id >> 16) & 255
+    g = (image_id >> 8) & 255
+    b = image_id & 255
+    prefix = f"\x1b[38;2;{r};{g};{b}m"
+    line_fill = PLACEHOLDER * max(0, cols - 1)
+    lines = [PLACEHOLDER + DIACRITICS[row] + line_fill for row in range(rows)]
+    return prefix + "\n".join(lines) + "\x1b[39m"
+
+
+def normalize_image_id(image_id: int | None) -> int:
+    if image_id is None:
+        return secrets.randbelow((1 << 24) - 1) + 1
+    image_id &= 0xFFFFFFFF
+    if image_id == 0:
+        raise ValueError("image_id must be non-zero")
+    if image_id >= (1 << 24):
+        raise ValueError("image_id must fit in 24 bits for this minimal renderer")
+    return image_id
+
+
+def build_render_bytes(
+    png: str | os.PathLike[str] | bytes,
+    *,
+    cols: int | None = None,
+    rows: int | None = None,
+    image_id: int | None = None,
+    passthrough: str = "auto",
+    cell_width_px: int | None = None,
+    cell_height_px: int | None = None,
+    chunk_size: int = DEFAULT_CHUNK_SIZE,
+    newline: bool = True,
+    out: BinaryIO | None = None,
+) -> bytes:
+    if chunk_size <= 0:
+        raise ValueError("chunk_size must be positive")
+
+    png_data, image_width_px, image_height_px = _read_png(png)
+    image_id = normalize_image_id(image_id)
+    passthrough = _resolve_passthrough(passthrough)
+
+    if cols is None or rows is None:
+        stream = out or sys.stdout.buffer
+        geometry = get_terminal_geometry(
+            stream.fileno(),
+            cell_width_px=cell_width_px,
+            cell_height_px=cell_height_px,
+        )
+        cols, rows = _fit_cells(
+            image_width_px,
+            image_height_px,
+            geometry,
+            cols=cols,
+            rows=rows,
+            newline=newline,
+        )
+
+    pieces = _iter_transmit_chunks(
+        png_data,
+        cols=cols,
+        rows=rows,
+        image_id=image_id,
+        chunk_size=chunk_size,
+        passthrough=passthrough,
+    )
+    pieces.append(_placeholder_grid(cols, rows, image_id).encode("utf-8"))
+    if newline:
+        pieces.append(b"\n")
+    return b"".join(pieces)
+
+
+def render_png(
+    png: str | os.PathLike[str] | bytes,
+    *,
+    cols: int | None = None,
+    rows: int | None = None,
+    image_id: int | None = None,
+    passthrough: str = "auto",
+    cell_width_px: int | None = None,
+    cell_height_px: int | None = None,
+    chunk_size: int = DEFAULT_CHUNK_SIZE,
+    newline: bool = True,
+    out: BinaryIO | None = None,
+) -> int:
+    image_id = normalize_image_id(image_id)
+    payload = build_render_bytes(
+        png,
+        cols=cols,
+        rows=rows,
+        image_id=image_id,
+        passthrough=passthrough,
+        cell_width_px=cell_width_px,
+        cell_height_px=cell_height_px,
+        chunk_size=chunk_size,
+        newline=newline,
+        out=out,
+    )
+    stream = out or sys.stdout.buffer
+    stream.write(payload)
+    stream.flush()
+    return image_id
+
+
+def _parse_cell_size(value: str) -> tuple[int, int]:
+    value = value.lower()
+    if "x" not in value:
+        raise argparse.ArgumentTypeError("cell size must be WIDTHxHEIGHT")
+    left, right = value.split("x", 1)
+    try:
+        width, height = int(left), int(right)
+    except ValueError as exc:
+        raise argparse.ArgumentTypeError("cell size must be WIDTHxHEIGHT") from exc
+    if width <= 0 or height <= 0:
+        raise argparse.ArgumentTypeError("cell size must use positive integers")
+    return width, height
+
+
+def build_arg_parser() -> argparse.ArgumentParser:
+    parser = argparse.ArgumentParser(description="Render a PNG with kitty Unicode placeholders")
+    parser.add_argument("png", help="Path to a PNG file, or - to read PNG bytes from stdin")
+    parser.add_argument("--cols", type=int, help="target width in terminal cells")
+    parser.add_argument("--rows", type=int, help="target height in terminal cells")
+    parser.add_argument("--cell-size", type=_parse_cell_size, help="manual terminal cell size in pixels, e.g. 10x20")
+    parser.add_argument("--image-id", type=lambda s: int(s, 0), help="24-bit image id (decimal or 0x-prefixed hex)")
+    parser.add_argument(
+        "--passthrough",
+        choices=("auto", "none", "tmux"),
+        default="auto",
+        help="wrap kitty APC commands for tmux passthrough",
+    )
+    parser.add_argument("--chunk-size", type=int, default=DEFAULT_CHUNK_SIZE, help="base64 bytes per graphics chunk")
+    parser.add_argument("--no-newline", action="store_true", help="do not print a trailing newline after the image")
+    return parser
+
+
+def _load_cli_png(arg: str) -> bytes | str:
+    return sys.stdin.buffer.read() if arg == "-" else arg
+
+
+def main(argv: list[str] | None = None) -> int:
+    parser = build_arg_parser()
+    args = parser.parse_args(argv)
+    cell_width_px = cell_height_px = None
+    if args.cell_size is not None:
+        cell_width_px, cell_height_px = args.cell_size
+    try:
+        render_png(
+            _load_cli_png(args.png),
+            cols=args.cols,
+            rows=args.rows,
+            image_id=args.image_id,
+            passthrough=args.passthrough,
+            cell_width_px=cell_width_px,
+            cell_height_px=cell_height_px,
+            chunk_size=args.chunk_size,
+            newline=not args.no_newline,
+        )
+    except Exception as exc:
+        parser.exit(1, f"kittytgp: {exc}\n")
+    return 0

kittytgp-0.0.1/kittytgp/rowcolumn_diacritics.txt

@@ -0,0 +1,310 @@
+# This file lists the diacritics used to indicate row/column numbers for
+# Unicode terminal image placeholders. It is derived from UnicodeData.txt for
+# Unicode 6.0.0 (chosen somewhat arbitrarily: it's old enough, but still
+# contains more than 255 suitable combining chars) using the following
+# command:
+#
+#     cat UnicodeData.txt | grep "Mn;230;NSM;;" | grep -v "0300\|0301\|0302\|0303\|0304\|0306\|0307\|0308\|0309\|030A\|030B\|030C\|030F\|0311\|0313\|0314\|0342\|0653\|0654"
+#
+# That is, we use combining chars of the same combining class 230 (above the
+# base character) that do not have decomposition mappings, and we also remove
+# some characters that may be fused with other characters during normalization,
+# like 0041 0300 -> 00C0  which is À (A with grave).
+#
+0305;COMBINING OVERLINE;Mn;230;NSM;;;;;N;NON-SPACING OVERSCORE;;;;
+030D;COMBINING VERTICAL LINE ABOVE;Mn;230;NSM;;;;;N;NON-SPACING VERTICAL LINE ABOVE;;;;
+030E;COMBINING DOUBLE VERTICAL LINE ABOVE;Mn;230;NSM;;;;;N;NON-SPACING DOUBLE VERTICAL LINE ABOVE;;;;
+0310;COMBINING CANDRABINDU;Mn;230;NSM;;;;;N;NON-SPACING CANDRABINDU;;;;
+0312;COMBINING TURNED COMMA ABOVE;Mn;230;NSM;;;;;N;NON-SPACING TURNED COMMA ABOVE;;;;
+033D;COMBINING X ABOVE;Mn;230;NSM;;;;;N;NON-SPACING X ABOVE;;;;
+033E;COMBINING VERTICAL TILDE;Mn;230;NSM;;;;;N;NON-SPACING VERTICAL TILDE;;;;
+033F;COMBINING DOUBLE OVERLINE;Mn;230;NSM;;;;;N;NON-SPACING DOUBLE OVERSCORE;;;;
+0346;COMBINING BRIDGE ABOVE;Mn;230;NSM;;;;;N;;;;;
+034A;COMBINING NOT TILDE ABOVE;Mn;230;NSM;;;;;N;;;;;
+034B;COMBINING HOMOTHETIC ABOVE;Mn;230;NSM;;;;;N;;;;;
+034C;COMBINING ALMOST EQUAL TO ABOVE;Mn;230;NSM;;;;;N;;;;;
+0350;COMBINING RIGHT ARROWHEAD ABOVE;Mn;230;NSM;;;;;N;;;;;
+0351;COMBINING LEFT HALF RING ABOVE;Mn;230;NSM;;;;;N;;;;;
+0352;COMBINING FERMATA;Mn;230;NSM;;;;;N;;;;;
+0357;COMBINING RIGHT HALF RING ABOVE;Mn;230;NSM;;;;;N;;;;;
+035B;COMBINING ZIGZAG ABOVE;Mn;230;NSM;;;;;N;;;;;
+0363;COMBINING LATIN SMALL LETTER A;Mn;230;NSM;;;;;N;;;;;
+0364;COMBINING LATIN SMALL LETTER E;Mn;230;NSM;;;;;N;;;;;
+0365;COMBINING LATIN SMALL LETTER I;Mn;230;NSM;;;;;N;;;;;
+0366;COMBINING LATIN SMALL LETTER O;Mn;230;NSM;;;;;N;;;;;
+0367;COMBINING LATIN SMALL LETTER U;Mn;230;NSM;;;;;N;;;;;
+0368;COMBINING LATIN SMALL LETTER C;Mn;230;NSM;;;;;N;;;;;
+0369;COMBINING LATIN SMALL LETTER D;Mn;230;NSM;;;;;N;;;;;
+036A;COMBINING LATIN SMALL LETTER H;Mn;230;NSM;;;;;N;;;;;
+036B;COMBINING LATIN SMALL LETTER M;Mn;230;NSM;;;;;N;;;;;
+036C;COMBINING LATIN SMALL LETTER R;Mn;230;NSM;;;;;N;;;;;
+036D;COMBINING LATIN SMALL LETTER T;Mn;230;NSM;;;;;N;;;;;
+036E;COMBINING LATIN SMALL LETTER V;Mn;230;NSM;;;;;N;;;;;
+036F;COMBINING LATIN SMALL LETTER X;Mn;230;NSM;;;;;N;;;;;
+0483;COMBINING CYRILLIC TITLO;Mn;230;NSM;;;;;N;CYRILLIC NON-SPACING TITLO;;;;
+0484;COMBINING CYRILLIC PALATALIZATION;Mn;230;NSM;;;;;N;CYRILLIC NON-SPACING PALATALIZATION;;;;
+0485;COMBINING CYRILLIC DASIA PNEUMATA;Mn;230;NSM;;;;;N;CYRILLIC NON-SPACING DASIA PNEUMATA;;;;
+0486;COMBINING CYRILLIC PSILI PNEUMATA;Mn;230;NSM;;;;;N;CYRILLIC NON-SPACING PSILI PNEUMATA;;;;
+0487;COMBINING CYRILLIC POKRYTIE;Mn;230;NSM;;;;;N;;;;;
+0592;HEBREW ACCENT SEGOL;Mn;230;NSM;;;;;N;;;;;
+0593;HEBREW ACCENT SHALSHELET;Mn;230;NSM;;;;;N;;;;;
+0594;HEBREW ACCENT ZAQEF QATAN;Mn;230;NSM;;;;;N;;;;;
+0595;HEBREW ACCENT ZAQEF GADOL;Mn;230;NSM;;;;;N;;;;;
+0597;HEBREW ACCENT REVIA;Mn;230;NSM;;;;;N;;;;;
+0598;HEBREW ACCENT ZARQA;Mn;230;NSM;;;;;N;;;;;
+0599;HEBREW ACCENT PASHTA;Mn;230;NSM;;;;;N;;;;;
+059C;HEBREW ACCENT GERESH;Mn;230;NSM;;;;;N;;;;;
+059D;HEBREW ACCENT GERESH MUQDAM;Mn;230;NSM;;;;;N;;;;;
+059E;HEBREW ACCENT GERSHAYIM;Mn;230;NSM;;;;;N;;;;;
+059F;HEBREW ACCENT QARNEY PARA;Mn;230;NSM;;;;;N;;;;;
+05A0;HEBREW ACCENT TELISHA GEDOLA;Mn;230;NSM;;;;;N;;;;;
+05A1;HEBREW ACCENT PAZER;Mn;230;NSM;;;;;N;;;;;
+05A8;HEBREW ACCENT QADMA;Mn;230;NSM;;;;;N;;;;;
+05A9;HEBREW ACCENT TELISHA QETANA;Mn;230;NSM;;;;;N;;;;;
+05AB;HEBREW ACCENT OLE;Mn;230;NSM;;;;;N;;;;;
+05AC;HEBREW ACCENT ILUY;Mn;230;NSM;;;;;N;;;;;
+05AF;HEBREW MARK MASORA CIRCLE;Mn;230;NSM;;;;;N;;;;;
+05C4;HEBREW MARK UPPER DOT;Mn;230;NSM;;;;;N;;;;;
+0610;ARABIC SIGN SALLALLAHOU ALAYHE WASSALLAM;Mn;230;NSM;;;;;N;;;;;
+0611;ARABIC SIGN ALAYHE ASSALLAM;Mn;230;NSM;;;;;N;;;;;
+0612;ARABIC SIGN RAHMATULLAH ALAYHE;Mn;230;NSM;;;;;N;;;;;
+0613;ARABIC SIGN RADI ALLAHOU ANHU;Mn;230;NSM;;;;;N;;;;;
+0614;ARABIC SIGN TAKHALLUS;Mn;230;NSM;;;;;N;;;;;
+0615;ARABIC SMALL HIGH TAH;Mn;230;NSM;;;;;N;;;;;
+0616;ARABIC SMALL HIGH LIGATURE ALEF WITH LAM WITH YEH;Mn;230;NSM;;;;;N;;;;;
+0617;ARABIC SMALL HIGH ZAIN;Mn;230;NSM;;;;;N;;;;;
+0657;ARABIC INVERTED DAMMA;Mn;230;NSM;;;;;N;;;;;
+0658;ARABIC MARK NOON GHUNNA;Mn;230;NSM;;;;;N;;;;;
+0659;ARABIC ZWARAKAY;Mn;230;NSM;;;;;N;;;;;
+065A;ARABIC VOWEL SIGN SMALL V ABOVE;Mn;230;NSM;;;;;N;;;;;
+065B;ARABIC VOWEL SIGN INVERTED SMALL V ABOVE;Mn;230;NSM;;;;;N;;;;;
+065D;ARABIC REVERSED DAMMA;Mn;230;NSM;;;;;N;;;;;
+065E;ARABIC FATHA WITH TWO DOTS;Mn;230;NSM;;;;;N;;;;;
+06D6;ARABIC SMALL HIGH LIGATURE SAD WITH LAM WITH ALEF MAKSURA;Mn;230;NSM;;;;;N;;;;;
+06D7;ARABIC SMALL HIGH LIGATURE QAF WITH LAM WITH ALEF MAKSURA;Mn;230;NSM;;;;;N;;;;;
+06D8;ARABIC SMALL HIGH MEEM INITIAL FORM;Mn;230;NSM;;;;;N;;;;;
+06D9;ARABIC SMALL HIGH LAM ALEF;Mn;230;NSM;;;;;N;;;;;
+06DA;ARABIC SMALL HIGH JEEM;Mn;230;NSM;;;;;N;;;;;
+06DB;ARABIC SMALL HIGH THREE DOTS;Mn;230;NSM;;;;;N;;;;;
+06DC;ARABIC SMALL HIGH SEEN;Mn;230;NSM;;;;;N;;;;;
+06DF;ARABIC SMALL HIGH ROUNDED ZERO;Mn;230;NSM;;;;;N;;;;;
+06E0;ARABIC SMALL HIGH UPRIGHT RECTANGULAR ZERO;Mn;230;NSM;;;;;N;;;;;
+06E1;ARABIC SMALL HIGH DOTLESS HEAD OF KHAH;Mn;230;NSM;;;;;N;;;;;
+06E2;ARABIC SMALL HIGH MEEM ISOLATED FORM;Mn;230;NSM;;;;;N;;;;;
+06E4;ARABIC SMALL HIGH MADDA;Mn;230;NSM;;;;;N;;;;;
+06E7;ARABIC SMALL HIGH YEH;Mn;230;NSM;;;;;N;;;;;
+06E8;ARABIC SMALL HIGH NOON;Mn;230;NSM;;;;;N;;;;;
+06EB;ARABIC EMPTY CENTRE HIGH STOP;Mn;230;NSM;;;;;N;;;;;
+06EC;ARABIC ROUNDED HIGH STOP WITH FILLED CENTRE;Mn;230;NSM;;;;;N;;;;;
+0730;SYRIAC PTHAHA ABOVE;Mn;230;NSM;;;;;N;;;;;
+0732;SYRIAC PTHAHA DOTTED;Mn;230;NSM;;;;;N;;;;;
+0733;SYRIAC ZQAPHA ABOVE;Mn;230;NSM;;;;;N;;;;;
+0735;SYRIAC ZQAPHA DOTTED;Mn;230;NSM;;;;;N;;;;;
+0736;SYRIAC RBASA ABOVE;Mn;230;NSM;;;;;N;;;;;
+073A;SYRIAC HBASA ABOVE;Mn;230;NSM;;;;;N;;;;;
+073D;SYRIAC ESASA ABOVE;Mn;230;NSM;;;;;N;;;;;
+073F;SYRIAC RWAHA;Mn;230;NSM;;;;;N;;;;;
+0740;SYRIAC FEMININE DOT;Mn;230;NSM;;;;;N;;;;;
+0741;SYRIAC QUSHSHAYA;Mn;230;NSM;;;;;N;;;;;
+0743;SYRIAC TWO VERTICAL DOTS ABOVE;Mn;230;NSM;;;;;N;;;;;
+0745;SYRIAC THREE DOTS ABOVE;Mn;230;NSM;;;;;N;;;;;
+0747;SYRIAC OBLIQUE LINE ABOVE;Mn;230;NSM;;;;;N;;;;;
+0749;SYRIAC MUSIC;Mn;230;NSM;;;;;N;;;;;
+074A;SYRIAC BARREKH;Mn;230;NSM;;;;;N;;;;;
+07EB;NKO COMBINING SHORT HIGH TONE;Mn;230;NSM;;;;;N;;;;;
+07EC;NKO COMBINING SHORT LOW TONE;Mn;230;NSM;;;;;N;;;;;
+07ED;NKO COMBINING SHORT RISING TONE;Mn;230;NSM;;;;;N;;;;;
+07EE;NKO COMBINING LONG DESCENDING TONE;Mn;230;NSM;;;;;N;;;;;
+07EF;NKO COMBINING LONG HIGH TONE;Mn;230;NSM;;;;;N;;;;;
+07F0;NKO COMBINING LONG LOW TONE;Mn;230;NSM;;;;;N;;;;;
+07F1;NKO COMBINING LONG RISING TONE;Mn;230;NSM;;;;;N;;;;;
+07F3;NKO COMBINING DOUBLE DOT ABOVE;Mn;230;NSM;;;;;N;;;;;
+0816;SAMARITAN MARK IN;Mn;230;NSM;;;;;N;;;;;
+0817;SAMARITAN MARK IN-ALAF;Mn;230;NSM;;;;;N;;;;;
+0818;SAMARITAN MARK OCCLUSION;Mn;230;NSM;;;;;N;;;;;
+0819;SAMARITAN MARK DAGESH;Mn;230;NSM;;;;;N;;;;;
+081B;SAMARITAN MARK EPENTHETIC YUT;Mn;230;NSM;;;;;N;;;;;
+081C;SAMARITAN VOWEL SIGN LONG E;Mn;230;NSM;;;;;N;;;;;
+081D;SAMARITAN VOWEL SIGN E;Mn;230;NSM;;;;;N;;;;;
+081E;SAMARITAN VOWEL SIGN OVERLONG AA;Mn;230;NSM;;;;;N;;;;;
+081F;SAMARITAN VOWEL SIGN LONG AA;Mn;230;NSM;;;;;N;;;;;
+0820;SAMARITAN VOWEL SIGN AA;Mn;230;NSM;;;;;N;;;;;
+0821;SAMARITAN VOWEL SIGN OVERLONG A;Mn;230;NSM;;;;;N;;;;;
+0822;SAMARITAN VOWEL SIGN LONG A;Mn;230;NSM;;;;;N;;;;;
+0823;SAMARITAN VOWEL SIGN A;Mn;230;NSM;;;;;N;;;;;
+0825;SAMARITAN VOWEL SIGN SHORT A;Mn;230;NSM;;;;;N;;;;;
+0826;SAMARITAN VOWEL SIGN LONG U;Mn;230;NSM;;;;;N;;;;;
+0827;SAMARITAN VOWEL SIGN U;Mn;230;NSM;;;;;N;;;;;
+0829;SAMARITAN VOWEL SIGN LONG I;Mn;230;NSM;;;;;N;;;;;
+082A;SAMARITAN VOWEL SIGN I;Mn;230;NSM;;;;;N;;;;;
+082B;SAMARITAN VOWEL SIGN O;Mn;230;NSM;;;;;N;;;;;
+082C;SAMARITAN VOWEL SIGN SUKUN;Mn;230;NSM;;;;;N;;;;;
+082D;SAMARITAN MARK NEQUDAA;Mn;230;NSM;;;;;N;;;;;
+0951;DEVANAGARI STRESS SIGN UDATTA;Mn;230;NSM;;;;;N;;;;;
+0953;DEVANAGARI GRAVE ACCENT;Mn;230;NSM;;;;;N;;;;;
+0954;DEVANAGARI ACUTE ACCENT;Mn;230;NSM;;;;;N;;;;;
+0F82;TIBETAN SIGN NYI ZLA NAA DA;Mn;230;NSM;;;;;N;TIBETAN CANDRABINDU WITH ORNAMENT;;;;
+0F83;TIBETAN SIGN SNA LDAN;Mn;230;NSM;;;;;N;TIBETAN CANDRABINDU;;;;
+0F86;TIBETAN SIGN LCI RTAGS;Mn;230;NSM;;;;;N;;;;;
+0F87;TIBETAN SIGN YANG RTAGS;Mn;230;NSM;;;;;N;;;;;
+135D;ETHIOPIC COMBINING GEMINATION AND VOWEL LENGTH MARK;Mn;230;NSM;;;;;N;;;;;
+135E;ETHIOPIC COMBINING VOWEL LENGTH MARK;Mn;230;NSM;;;;;N;;;;;
+135F;ETHIOPIC COMBINING GEMINATION MARK;Mn;230;NSM;;;;;N;;;;;
+17DD;KHMER SIGN ATTHACAN;Mn;230;NSM;;;;;N;;;;;
+193A;LIMBU SIGN KEMPHRENG;Mn;230;NSM;;;;;N;;;;;
+1A17;BUGINESE VOWEL SIGN I;Mn;230;NSM;;;;;N;;;;;
+1A75;TAI THAM SIGN TONE-1;Mn;230;NSM;;;;;N;;;;;
+1A76;TAI THAM SIGN TONE-2;Mn;230;NSM;;;;;N;;;;;
+1A77;TAI THAM SIGN KHUEN TONE-3;Mn;230;NSM;;;;;N;;;;;
+1A78;TAI THAM SIGN KHUEN TONE-4;Mn;230;NSM;;;;;N;;;;;
+1A79;TAI THAM SIGN KHUEN TONE-5;Mn;230;NSM;;;;;N;;;;;
+1A7A;TAI THAM SIGN RA HAAM;Mn;230;NSM;;;;;N;;;;;
+1A7B;TAI THAM SIGN MAI SAM;Mn;230;NSM;;;;;N;;;;;
+1A7C;TAI THAM SIGN KHUEN-LUE KARAN;Mn;230;NSM;;;;;N;;;;;
+1B6B;BALINESE MUSICAL SYMBOL COMBINING TEGEH;Mn;230;NSM;;;;;N;;;;;
+1B6D;BALINESE MUSICAL SYMBOL COMBINING KEMPUL;Mn;230;NSM;;;;;N;;;;;
+1B6E;BALINESE MUSICAL SYMBOL COMBINING KEMPLI;Mn;230;NSM;;;;;N;;;;;
+1B6F;BALINESE MUSICAL SYMBOL COMBINING JEGOGAN;Mn;230;NSM;;;;;N;;;;;
+1B70;BALINESE MUSICAL SYMBOL COMBINING KEMPUL WITH JEGOGAN;Mn;230;NSM;;;;;N;;;;;
+1B71;BALINESE MUSICAL SYMBOL COMBINING KEMPLI WITH JEGOGAN;Mn;230;NSM;;;;;N;;;;;
+1B72;BALINESE MUSICAL SYMBOL COMBINING BENDE;Mn;230;NSM;;;;;N;;;;;
+1B73;BALINESE MUSICAL SYMBOL COMBINING GONG;Mn;230;NSM;;;;;N;;;;;
+1CD0;VEDIC TONE KARSHANA;Mn;230;NSM;;;;;N;;;;;
+1CD1;VEDIC TONE SHARA;Mn;230;NSM;;;;;N;;;;;
+1CD2;VEDIC TONE PRENKHA;Mn;230;NSM;;;;;N;;;;;
+1CDA;VEDIC TONE DOUBLE SVARITA;Mn;230;NSM;;;;;N;;;;;
+1CDB;VEDIC TONE TRIPLE SVARITA;Mn;230;NSM;;;;;N;;;;;
+1CE0;VEDIC TONE RIGVEDIC KASHMIRI INDEPENDENT SVARITA;Mn;230;NSM;;;;;N;;;;;
+1DC0;COMBINING DOTTED GRAVE ACCENT;Mn;230;NSM;;;;;N;;;;;
+1DC1;COMBINING DOTTED ACUTE ACCENT;Mn;230;NSM;;;;;N;;;;;
+1DC3;COMBINING SUSPENSION MARK;Mn;230;NSM;;;;;N;;;;;
+1DC4;COMBINING MACRON-ACUTE;Mn;230;NSM;;;;;N;;;;;
+1DC5;COMBINING GRAVE-MACRON;Mn;230;NSM;;;;;N;;;;;
+1DC6;COMBINING MACRON-GRAVE;Mn;230;NSM;;;;;N;;;;;
+1DC7;COMBINING ACUTE-MACRON;Mn;230;NSM;;;;;N;;;;;
+1DC8;COMBINING GRAVE-ACUTE-GRAVE;Mn;230;NSM;;;;;N;;;;;
+1DC9;COMBINING ACUTE-GRAVE-ACUTE;Mn;230;NSM;;;;;N;;;;;
+1DCB;COMBINING BREVE-MACRON;Mn;230;NSM;;;;;N;;;;;
+1DCC;COMBINING MACRON-BREVE;Mn;230;NSM;;;;;N;;;;;
+1DD1;COMBINING UR ABOVE;Mn;230;NSM;;;;;N;;;;;
+1DD2;COMBINING US ABOVE;Mn;230;NSM;;;;;N;;;;;
+1DD3;COMBINING LATIN SMALL LETTER FLATTENED OPEN A ABOVE;Mn;230;NSM;;;;;N;;;;;
+1DD4;COMBINING LATIN SMALL LETTER AE;Mn;230;NSM;;;;;N;;;;;
+1DD5;COMBINING LATIN SMALL LETTER AO;Mn;230;NSM;;;;;N;;;;;
+1DD6;COMBINING LATIN SMALL LETTER AV;Mn;230;NSM;;;;;N;;;;;
+1DD7;COMBINING LATIN SMALL LETTER C CEDILLA;Mn;230;NSM;;;;;N;;;;;
+1DD8;COMBINING LATIN SMALL LETTER INSULAR D;Mn;230;NSM;;;;;N;;;;;
+1DD9;COMBINING LATIN SMALL LETTER ETH;Mn;230;NSM;;;;;N;;;;;
+1DDA;COMBINING LATIN SMALL LETTER G;Mn;230;NSM;;;;;N;;;;;
+1DDB;COMBINING LATIN LETTER SMALL CAPITAL G;Mn;230;NSM;;;;;N;;;;;
+1DDC;COMBINING LATIN SMALL LETTER K;Mn;230;NSM;;;;;N;;;;;
+1DDD;COMBINING LATIN SMALL LETTER L;Mn;230;NSM;;;;;N;;;;;
+1DDE;COMBINING LATIN LETTER SMALL CAPITAL L;Mn;230;NSM;;;;;N;;;;;
+1DDF;COMBINING LATIN LETTER SMALL CAPITAL M;Mn;230;NSM;;;;;N;;;;;
+1DE0;COMBINING LATIN SMALL LETTER N;Mn;230;NSM;;;;;N;;;;;
+1DE1;COMBINING LATIN LETTER SMALL CAPITAL N;Mn;230;NSM;;;;;N;;;;;
+1DE2;COMBINING LATIN LETTER SMALL CAPITAL R;Mn;230;NSM;;;;;N;;;;;
+1DE3;COMBINING LATIN SMALL LETTER R ROTUNDA;Mn;230;NSM;;;;;N;;;;;
+1DE4;COMBINING LATIN SMALL LETTER S;Mn;230;NSM;;;;;N;;;;;
+1DE5;COMBINING LATIN SMALL LETTER LONG S;Mn;230;NSM;;;;;N;;;;;
+1DE6;COMBINING LATIN SMALL LETTER Z;Mn;230;NSM;;;;;N;;;;;
+1DFE;COMBINING LEFT ARROWHEAD ABOVE;Mn;230;NSM;;;;;N;;;;;
+20D0;COMBINING LEFT HARPOON ABOVE;Mn;230;NSM;;;;;N;NON-SPACING LEFT HARPOON ABOVE;;;;
+20D1;COMBINING RIGHT HARPOON ABOVE;Mn;230;NSM;;;;;N;NON-SPACING RIGHT HARPOON ABOVE;;;;
+20D4;COMBINING ANTICLOCKWISE ARROW ABOVE;Mn;230;NSM;;;;;N;NON-SPACING ANTICLOCKWISE ARROW ABOVE;;;;
+20D5;COMBINING CLOCKWISE ARROW ABOVE;Mn;230;NSM;;;;;N;NON-SPACING CLOCKWISE ARROW ABOVE;;;;
+20D6;COMBINING LEFT ARROW ABOVE;Mn;230;NSM;;;;;N;NON-SPACING LEFT ARROW ABOVE;;;;
+20D7;COMBINING RIGHT ARROW ABOVE;Mn;230;NSM;;;;;N;NON-SPACING RIGHT ARROW ABOVE;;;;
+20DB;COMBINING THREE DOTS ABOVE;Mn;230;NSM;;;;;N;NON-SPACING THREE DOTS ABOVE;;;;
+20DC;COMBINING FOUR DOTS ABOVE;Mn;230;NSM;;;;;N;NON-SPACING FOUR DOTS ABOVE;;;;
+20E1;COMBINING LEFT RIGHT ARROW ABOVE;Mn;230;NSM;;;;;N;NON-SPACING LEFT RIGHT ARROW ABOVE;;;;
+20E7;COMBINING ANNUITY SYMBOL;Mn;230;NSM;;;;;N;;;;;
+20E9;COMBINING WIDE BRIDGE ABOVE;Mn;230;NSM;;;;;N;;;;;
+20F0;COMBINING ASTERISK ABOVE;Mn;230;NSM;;;;;N;;;;;
+2CEF;COPTIC COMBINING NI ABOVE;Mn;230;NSM;;;;;N;;;;;
+2CF0;COPTIC COMBINING SPIRITUS ASPER;Mn;230;NSM;;;;;N;;;;;
+2CF1;COPTIC COMBINING SPIRITUS LENIS;Mn;230;NSM;;;;;N;;;;;
+2DE0;COMBINING CYRILLIC LETTER BE;Mn;230;NSM;;;;;N;;;;;
+2DE1;COMBINING CYRILLIC LETTER VE;Mn;230;NSM;;;;;N;;;;;
+2DE2;COMBINING CYRILLIC LETTER GHE;Mn;230;NSM;;;;;N;;;;;
+2DE3;COMBINING CYRILLIC LETTER DE;Mn;230;NSM;;;;;N;;;;;
+2DE4;COMBINING CYRILLIC LETTER ZHE;Mn;230;NSM;;;;;N;;;;;
+2DE5;COMBINING CYRILLIC LETTER ZE;Mn;230;NSM;;;;;N;;;;;
+2DE6;COMBINING CYRILLIC LETTER KA;Mn;230;NSM;;;;;N;;;;;
+2DE7;COMBINING CYRILLIC LETTER EL;Mn;230;NSM;;;;;N;;;;;
+2DE8;COMBINING CYRILLIC LETTER EM;Mn;230;NSM;;;;;N;;;;;
+2DE9;COMBINING CYRILLIC LETTER EN;Mn;230;NSM;;;;;N;;;;;
+2DEA;COMBINING CYRILLIC LETTER O;Mn;230;NSM;;;;;N;;;;;
+2DEB;COMBINING CYRILLIC LETTER PE;Mn;230;NSM;;;;;N;;;;;
+2DEC;COMBINING CYRILLIC LETTER ER;Mn;230;NSM;;;;;N;;;;;
+2DED;COMBINING CYRILLIC LETTER ES;Mn;230;NSM;;;;;N;;;;;
+2DEE;COMBINING CYRILLIC LETTER TE;Mn;230;NSM;;;;;N;;;;;
+2DEF;COMBINING CYRILLIC LETTER HA;Mn;230;NSM;;;;;N;;;;;
+2DF0;COMBINING CYRILLIC LETTER TSE;Mn;230;NSM;;;;;N;;;;;
+2DF1;COMBINING CYRILLIC LETTER CHE;Mn;230;NSM;;;;;N;;;;;
+2DF2;COMBINING CYRILLIC LETTER SHA;Mn;230;NSM;;;;;N;;;;;
+2DF3;COMBINING CYRILLIC LETTER SHCHA;Mn;230;NSM;;;;;N;;;;;
+2DF4;COMBINING CYRILLIC LETTER FITA;Mn;230;NSM;;;;;N;;;;;
+2DF5;COMBINING CYRILLIC LETTER ES-TE;Mn;230;NSM;;;;;N;;;;;
+2DF6;COMBINING CYRILLIC LETTER A;Mn;230;NSM;;;;;N;;;;;
+2DF7;COMBINING CYRILLIC LETTER IE;Mn;230;NSM;;;;;N;;;;;
+2DF8;COMBINING CYRILLIC LETTER DJERV;Mn;230;NSM;;;;;N;;;;;
+2DF9;COMBINING CYRILLIC LETTER MONOGRAPH UK;Mn;230;NSM;;;;;N;;;;;
+2DFA;COMBINING CYRILLIC LETTER YAT;Mn;230;NSM;;;;;N;;;;;
+2DFB;COMBINING CYRILLIC LETTER YU;Mn;230;NSM;;;;;N;;;;;
+2DFC;COMBINING CYRILLIC LETTER IOTIFIED A;Mn;230;NSM;;;;;N;;;;;
+2DFD;COMBINING CYRILLIC LETTER LITTLE YUS;Mn;230;NSM;;;;;N;;;;;
+2DFE;COMBINING CYRILLIC LETTER BIG YUS;Mn;230;NSM;;;;;N;;;;;
+2DFF;COMBINING CYRILLIC LETTER IOTIFIED BIG YUS;Mn;230;NSM;;;;;N;;;;;
+A66F;COMBINING CYRILLIC VZMET;Mn;230;NSM;;;;;N;;;;;
+A67C;COMBINING CYRILLIC KAVYKA;Mn;230;NSM;;;;;N;;;;;
+A67D;COMBINING CYRILLIC PAYEROK;Mn;230;NSM;;;;;N;;;;;
+A6F0;BAMUM COMBINING MARK KOQNDON;Mn;230;NSM;;;;;N;;;;;
+A6F1;BAMUM COMBINING MARK TUKWENTIS;Mn;230;NSM;;;;;N;;;;;
+A8E0;COMBINING DEVANAGARI DIGIT ZERO;Mn;230;NSM;;;;;N;;;;;
+A8E1;COMBINING DEVANAGARI DIGIT ONE;Mn;230;NSM;;;;;N;;;;;
+A8E2;COMBINING DEVANAGARI DIGIT TWO;Mn;230;NSM;;;;;N;;;;;
+A8E3;COMBINING DEVANAGARI DIGIT THREE;Mn;230;NSM;;;;;N;;;;;
+A8E4;COMBINING DEVANAGARI DIGIT FOUR;Mn;230;NSM;;;;;N;;;;;
+A8E5;COMBINING DEVANAGARI DIGIT FIVE;Mn;230;NSM;;;;;N;;;;;
+A8E6;COMBINING DEVANAGARI DIGIT SIX;Mn;230;NSM;;;;;N;;;;;
+A8E7;COMBINING DEVANAGARI DIGIT SEVEN;Mn;230;NSM;;;;;N;;;;;
+A8E8;COMBINING DEVANAGARI DIGIT EIGHT;Mn;230;NSM;;;;;N;;;;;
+A8E9;COMBINING DEVANAGARI DIGIT NINE;Mn;230;NSM;;;;;N;;;;;
+A8EA;COMBINING DEVANAGARI LETTER A;Mn;230;NSM;;;;;N;;;;;
+A8EB;COMBINING DEVANAGARI LETTER U;Mn;230;NSM;;;;;N;;;;;
+A8EC;COMBINING DEVANAGARI LETTER KA;Mn;230;NSM;;;;;N;;;;;
+A8ED;COMBINING DEVANAGARI LETTER NA;Mn;230;NSM;;;;;N;;;;;
+A8EE;COMBINING DEVANAGARI LETTER PA;Mn;230;NSM;;;;;N;;;;;
+A8EF;COMBINING DEVANAGARI LETTER RA;Mn;230;NSM;;;;;N;;;;;
+A8F0;COMBINING DEVANAGARI LETTER VI;Mn;230;NSM;;;;;N;;;;;
+A8F1;COMBINING DEVANAGARI SIGN AVAGRAHA;Mn;230;NSM;;;;;N;;;;;
+AAB0;TAI VIET MAI KANG;Mn;230;NSM;;;;;N;;;;;
+AAB2;TAI VIET VOWEL I;Mn;230;NSM;;;;;N;;;;;
+AAB3;TAI VIET VOWEL UE;Mn;230;NSM;;;;;N;;;;;
+AAB7;TAI VIET MAI KHIT;Mn;230;NSM;;;;;N;;;;;
+AAB8;TAI VIET VOWEL IA;Mn;230;NSM;;;;;N;;;;;
+AABE;TAI VIET VOWEL AM;Mn;230;NSM;;;;;N;;;;;
+AABF;TAI VIET TONE MAI EK;Mn;230;NSM;;;;;N;;;;;
+AAC1;TAI VIET TONE MAI THO;Mn;230;NSM;;;;;N;;;;;
+FE20;COMBINING LIGATURE LEFT HALF;Mn;230;NSM;;;;;N;;;;;
+FE21;COMBINING LIGATURE RIGHT HALF;Mn;230;NSM;;;;;N;;;;;
+FE22;COMBINING DOUBLE TILDE LEFT HALF;Mn;230;NSM;;;;;N;;;;;
+FE23;COMBINING DOUBLE TILDE RIGHT HALF;Mn;230;NSM;;;;;N;;;;;
+FE24;COMBINING MACRON LEFT HALF;Mn;230;NSM;;;;;N;;;;;
+FE25;COMBINING MACRON RIGHT HALF;Mn;230;NSM;;;;;N;;;;;
+FE26;COMBINING CONJOINING MACRON;Mn;230;NSM;;;;;N;;;;;
+10A0F;KHAROSHTHI SIGN VISARGA;Mn;230;NSM;;;;;N;;;;;
+10A38;KHAROSHTHI SIGN BAR ABOVE;Mn;230;NSM;;;;;N;;;;;
+1D185;MUSICAL SYMBOL COMBINING DOIT;Mn;230;NSM;;;;;N;;;;;
+1D186;MUSICAL SYMBOL COMBINING RIP;Mn;230;NSM;;;;;N;;;;;
+1D187;MUSICAL SYMBOL COMBINING FLIP;Mn;230;NSM;;;;;N;;;;;
+1D188;MUSICAL SYMBOL COMBINING SMEAR;Mn;230;NSM;;;;;N;;;;;
+1D189;MUSICAL SYMBOL COMBINING BEND;Mn;230;NSM;;;;;N;;;;;
+1D1AA;MUSICAL SYMBOL COMBINING DOWN BOW;Mn;230;NSM;;;;;N;;;;;
+1D1AB;MUSICAL SYMBOL COMBINING UP BOW;Mn;230;NSM;;;;;N;;;;;
+1D1AC;MUSICAL SYMBOL COMBINING HARMONIC;Mn;230;NSM;;;;;N;;;;;
+1D1AD;MUSICAL SYMBOL COMBINING SNAP PIZZICATO;Mn;230;NSM;;;;;N;;;;;
+1D242;COMBINING GREEK MUSICAL TRISEME;Mn;230;NSM;;;;;N;;;;;
+1D243;COMBINING GREEK MUSICAL TETRASEME;Mn;230;NSM;;;;;N;;;;;
+1D244;COMBINING GREEK MUSICAL PENTASEME;Mn;230;NSM;;;;;N;;;;;

kittytgp-0.0.1/kittytgp.egg-info/PKG-INFO

@@ -0,0 +1,91 @@
+Metadata-Version: 2.4
+Name: kittytgp
+Version: 0.0.1
+Summary: Tiny kitty graphics protocol PNG renderer using Unicode placeholders
+Author: Jeremy Howard
+License: Apache-2.0
+Project-URL: Source, https://github.com/answerdotai/kittytgp
+Keywords: kitty,terminal,graphics,tmux,png
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Terminals
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# kittytgp
+
+`kittytgp` is a small pure-Python package that renders a PNG with kitty's graphics protocol using Unicode placeholders (`U+10EEEE`).
+
+It follows kitty's tmux/editor-friendly placeholder flow:
+
+1. transmit PNG data with kitty graphics protocol
+2. create a **virtual** placement with `U=1`
+3. print `U+10EEEE` placeholder text colored with the image ID
+
+Because the visible part is ordinary Unicode text, the image moves with the text buffer and works inside hosts such as tmux.
+
+## Install
+
+```bash
+pip install kittytgp
+```
+
+## CLI
+
+```bash
+kittytgp plot.png
+```
+
+Useful options:
+
+```bash
+kittytgp plot.png --cols 40
+kittytgp plot.png --rows 20
+kittytgp plot.png --cell-size 10x20
+kittytgp plot.png --passthrough tmux
+kittytgp plot.png --image-id 0x123456
+kittytgp plot.png --no-newline
+```
+
+Inside tmux, enable passthrough:
+
+```tmux
+set -g allow-passthrough on
+```
+
+## Python API
+
+```python
+from kittytgp import render_png
+
+render_png("plot.png")
+```
+
+Or build the bytes yourself:
+
+```python
+from kittytgp import build_render_bytes
+
+payload = build_render_bytes("plot.png")
+```
+
+## Design notes
+
+This package intentionally stays small:
+
+- PNG input only
+- direct transfer (`f=100` PNG payload in APC chunks)
+- Unicode placeholders only
+- 24-bit image IDs encoded in truecolor foreground color
+- tmux passthrough only when needed
+
+By default it fits the image into the current terminal while preserving aspect ratio. If the terminal cannot report cell pixel size, pass `--cell-size`, `--cols`, or `--rows`.
+

kittytgp-0.0.1/kittytgp.egg-info/SOURCES.txt

@@ -0,0 +1,18 @@
+LICENSE
+README.md
+pyproject.toml
+setup.py
+./kittytgp/__init__.py
+./kittytgp/__main__.py
+./kittytgp/core.py
+./kittytgp/rowcolumn_diacritics.txt
+kittytgp/__init__.py
+kittytgp/__main__.py
+kittytgp/core.py
+kittytgp/rowcolumn_diacritics.txt
+kittytgp.egg-info/PKG-INFO
+kittytgp.egg-info/SOURCES.txt
+kittytgp.egg-info/dependency_links.txt
+kittytgp.egg-info/entry_points.txt
+kittytgp.egg-info/top_level.txt
+tests/test_core.py

kittytgp-0.0.1/kittytgp.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

kittytgp-0.0.1/kittytgp.egg-info/entry_points.txt

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

kittytgp-0.0.1/kittytgp.egg-info/top_level.txt

@@ -0,0 +1 @@
+kittytgp

kittytgp-0.0.1/pyproject.toml

@@ -0,0 +1,47 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "kittytgp"
+dynamic = ["version"]
+description = "Tiny kitty graphics protocol PNG renderer using Unicode placeholders"
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "Apache-2.0" }
+authors = [ {name = "Jeremy Howard"} ]
+keywords = ["kitty", "terminal", "graphics", "tmux", "png"]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Environment :: Console",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: POSIX",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+  "Topic :: Terminals",
+]
+
+dependencies = [
+]
+
+[project.urls]
+Source = "https://github.com/answerdotai/kittytgp"
+
+[project.scripts]
+kittytgp = "kittytgp.__main__:main"
+
+[tool.setuptools]
+package-dir = {"" = "."}
+include-package-data = true
+
+[tool.setuptools.dynamic]
+version = { attr = "kittytgp.__version__" }
+
+[tool.setuptools.package-data]
+kittytgp = ["rowcolumn_diacritics.txt"]
+
+[tool.setuptools.packages.find]
+include = ["kittytgp*"]
+

kittytgp-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

kittytgp-0.0.1/setup.py

@@ -0,0 +1,3 @@
+from setuptools import setup
+
+setup()

kittytgp-0.0.1/tests/test_core.py

@@ -0,0 +1,59 @@
+import base64
+
+from kittytgp.core import (
+    DIACRITICS,
+    PLACEHOLDER,
+    _parse_png_size,
+    _placeholder_grid,
+    _wrap_tmux_passthrough,
+    build_render_bytes,
+    normalize_image_id,
+)
+
+PNG_1X1 = base64.b64decode(
+    b"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mP8/x8AAwMCAO2pF6kAAAAASUVORK5CYII="
+)
+
+
+def test_parse_png_size():
+    assert _parse_png_size(PNG_1X1) == (1, 1)
+
+
+def test_tmux_wrap_doubles_escapes():
+    wrapped = _wrap_tmux_passthrough(b"\x1b_Gm=0;abc\x1b\\")
+    assert wrapped.startswith(b"\x1bPtmux;")
+    assert wrapped.endswith(b"\x1b\\")
+    assert b"\x1b\x1b_G" in wrapped
+
+
+def test_placeholder_grid_uses_row_inheritance_form():
+    grid = _placeholder_grid(3, 2, 0x123456)
+    assert grid.startswith("\x1b[38;2;18;52;86m")
+    assert PLACEHOLDER in grid
+    assert DIACRITICS[0] in grid
+    assert DIACRITICS[1] in grid
+    assert DIACRITICS[2] not in grid
+    assert grid.count(PLACEHOLDER) == 6
+
+
+def test_build_render_bytes_contains_protocol_and_placeholder():
+    payload = build_render_bytes(
+        PNG_1X1,
+        cols=1,
+        rows=1,
+        image_id=0x123456,
+        passthrough="none",
+        newline=False,
+    )
+    assert payload.startswith(b"\x1b_Ga=T,f=100,q=2,U=1,i=1193046,c=1,r=1,m=0;")
+    assert PLACEHOLDER.encode("utf-8") in payload
+    assert payload.endswith(b"\x1b[39m")
+
+
+def test_image_id_is_limited_to_24_bits():
+    try:
+        normalize_image_id(1 << 24)
+    except ValueError as exc:
+        assert "24 bits" in str(exc)
+    else:  # pragma: no cover
+        raise AssertionError("expected ValueError")