terminal-qrcode 1.0.0

A terminal image renderer with support for iTerm2, Kitty and fallback modes.

terminal-qrcode

终端二维码图片渲染工具，支持图形协议、字符降级渲染和终端能力探测。

📦 安装

基础安装：

uv add terminal-qrcode

✨ API

from terminal_qrcode import draw

out = draw("test.png", renderer="halfblock")
out.print()

graphic = draw("test.png")
graphic.print()

配合 Rich 使用时，console.print(draw(...)) 会强制走 halfblock 文本渲染

from rich.console import Console
from terminal_qrcode import draw

console = Console()
console.print(draw("test.png"))

🖼️ 支持图片格式

• PNG
• JPEG
• WEBP

解码后端：

• PNG: libpng
• JPEG: libjpeg-turbo
• WEBP: libwebp

🧩 API 支持输入

• 本地图片路径：str / pathlib.Path
• 图像字节流：bytes / bytearray
• 兼容 PIL 的图像对象
• qrcode.image.BaseImage 包装对象
• 布尔矩阵：list[list[bool]]

💻 支持的终端渲染器

• kitty（Kitty Graphics Protocol）
• iterm2（Inline Image Protocol）
• wezterm（iTerm2 兼容协议）
• sixel（DEC Sixel）
• halfblock（Unicode 半块字符降级）

🔧 CLI

uv run python scripts/cli.py <image_path> [options]

仅探测当前终端能力：

uv run python scripts/cli.py --detect

常见渲染选项：

uv run python scripts/cli.py qrcode.png --renderer halfblock
uv run python scripts/cli.py qrcode.png --renderer auto

🛠️ 本地开发

uv sync

Windows

uv run --no-project python scripts/install-dev.py
uv sync

📄 License

MIT