nonebot-plugin-htmlrender 0.6.5__tar.gz → 0.6.6__tar.gz

nonebot_plugin_htmlrender-0.6.6/.dockerignore

@@ -0,0 +1,10 @@
+.github/
+docs/
+example/
+nonebot_plugin_htmlrender/
+tests/
+.gitignore
+.pre-commit-config.yaml
+docker-compose.yaml
+LICENSE
+*.md

nonebot_plugin_htmlrender-0.6.6/.github/workflows/docker_image.yml

@@ -0,0 +1,53 @@
+name: Build and upload docker image
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+  workflow_dispatch:
+
+concurrency:
+  group:
+    ${{ github.workflow }}-${{ github.ref_name }}-${{
+    github.event.pull_request.number || github.sha }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    name: "build image"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Extract metadata for Docker
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ghcr.io/${{ github.repository }}/nonebot2-playwrght-uv
+          tags: |
+            type=raw,value=latest,enable={{is_default_branch}}
+            type=ref,event=branch
+            type=sha,format=long
+
+      - name: Build and push
+        uses: docker/build-push-action@v6
+        with:
+          push: ${{ github.event_name != 'pull_request' }}
+          platforms: linux/amd64,linux/arm64
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha,scope=nonebot2-playwrght-uv
+          cache-to: type=gha,mode=min,scope=nonebot2-playwrght-uv

{nonebot_plugin_htmlrender-0.6.5 → nonebot_plugin_htmlrender-0.6.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nonebot-plugin-htmlrender
-Version: 0.6.5
+Version: 0.6.6
 Summary: 通过浏览器渲染图片
 Project-URL: Homepage, https://github.com/kexue-z/nonebot-plugin-htmlrender
 Project-URL: Bug Tracker, https://github.com/kexue-z/nonebot-plugin-htmlrender/issues
@@ -44,13 +44,13 @@ Description-Content-Type: text/markdown
 - 可通过查看`example`参考使用实例
 - 如果有安装浏览器等问题，先查看文档最底下的`常见问题`再去看 issue 有没有已经存在的
 
-# ✨ 功能
+## ✨ 功能
 
 - 通过 html 和浏览器生成图片
 - 支持`纯文本` `markdown` 和 `jinja2` 模板输入
 - 通过 CSS 来控制样式
 
-# 使用
+## 使用
 
 参考[example/plugins/render/**init**.py](example/plugins/render/__init__.py)
 
@@ -72,9 +72,9 @@ from nonebot_plugin_htmlrender import (
 # 注意顺序，先require再 from ... import ...
 ```
 
-# 配置
+## 配置
 
-## .env 配置项说明
+### .env 配置项说明
 
 ```ini
 # Playwright 浏览器引擎类型
@@ -112,9 +112,52 @@ htmlrender_browser_executable_path = ""
 # 可选，用于连接已运行的浏览器实例
 # 使用时需要在启动浏览器时添加参数 --remote-debugging-port=端口号
 htmlrender_connect_over_cdp = "http://127.0.0.1:9222"
+
+# Playwright ws 连接地址
+# 可选，用于连接 playwright 的 docker 容器
+# https://playwright.dev/docs/docker
+# 配套的 docker-compose.yaml 中，已经填好了
+htmlrender_connect="ws://playwright:3000"
 ```
 
-## markdown 转 图片
+## 部署
+
+### （建议）使用 docker compose 进行部署
+
+> 前提条件：你的项目使用 uv 管理 或 `pyproject.toml` 的 `dependencies` 中已经包含你的依赖
+>
+> 此方法会将 nonebot2 和 playwright 分开两个容器
+
+1. 将 `docker-compose.yaml` & `entrypoint.sh` 复制到你自己的项目根目录下
+2. 根据你的需要调整 `docker-compose.yaml` & `entrypoint.sh`
+3. 拉取镜像 `docker compose pull`
+4. 启动容器 `docker compose up -d`
+
+> - 查看日志 `docker compose logs -f`
+> - 停止/重启容器 `docker compose`
+
+### docker 单容器部署
+
+> 前提条件：你的项目使用 uv 管理 或 `pyproject.toml` 的 `dependencies` 中已经包含你的依赖
+>
+> 此方法会将 nonebot2 和 playwright 运行在同一个容器中
+>
+> 而且你还有需要清楚你要干什么
+
+1. 将 `docker-compose.yaml` & `entrypoint.sh` 复制到你自己的项目根目录下
+2. 根据你的情况，调整指令
+
+```bash
+docker run -d \
+--name nonebot2 \
+-v $(pwd):/app \
+-p 9012:9012 \
+-e "PLAYWRIGHT_BROWSERS_PATH=/app/pw-browsers" \
+ghcr.io/kexue-z/nonebot-plugin-htmlrender/nonebot2-playwrght-uv sh -c "./entrypoint.sh"
+```
+
+## 说明
+### markdown 转 图片
 
 - 使用 `GitHub-light` 样式
 - 支持绝大部分 md 语法
@@ -125,38 +168,38 @@ htmlrender_connect_over_cdp = "http://127.0.0.1:9222"
 - 图片需要使用外部连接并使用`html`格式 否则文末会超出截图范围
 - 图片可使用 md 语法 路径可为 `绝对路径`(建议), 或 `相对于template_path` 的路径
 
-## 模板 转 图片
+### 模板 转 图片
 
 - 使用 jinja2 模板引擎
 - 页面参数可自定义
 
-# 🌰 栗子
+## 🌰 栗子
 
 [example.md](docs/example.md)
 
-## 文本转图片（同时文本里面可以包括 html 图片）
+### 文本转图片（同时文本里面可以包括 html 图片）
 
 ![](docs/text2pic.png)
 
-## markdown 转图片（同时文本里面可以包括 html 图片）
+### markdown 转图片（同时文本里面可以包括 html 图片）
 
 ![](docs/md2pic.png)
 
-## 纯 html 转图片
+### 纯 html 转图片
 
 ![](docs/html2pic.png)
 
-## jinja2 模板转图片
+### jinja2 模板转图片
 
 ![](docs/template2pic.png)
 
-# 特别感谢
+## 特别感谢
 
 - [MeetWq](https://github.com/MeetWq) 提供数学公式支持代码和代码高亮
 
-# 常见疑难杂症
+## 常见疑难杂症
 
-## `playwright._impl._api_types.Error:` 初次运行时报错
+### `playwright._impl._api_types.Error:` 初次运行时报错
 
 - 一般为缺少必要的运行环境，如中文字体等
 
@@ -175,18 +218,3 @@ LANG zh_CN.UTF-8
 LANGUAGE zh_CN.UTF-8
 LC_ALL zh_CN.UTF-8
 ```
-
-### CentOS 使用 `yum`
-
-- ~~小心 CentOS~~
--
-参考[CentOS Dockerfile](https://github.com/kumaraditya303/playwright-centos/blob/master/Dockerfile)
-- 添加中文字体库
-- ~~最佳解决办法~~
-    - 使用 Docker 然后用 Python 镜像 按照上面 Ubuntu 的写 `dockerfile`
-
-下面这个依赖运行一下 也许就可以用了
-
-```sh
-dnf install -y alsa-lib at-spi2-atk at-spi2-core atk cairo cups-libs dbus-libs expat flac-libs gdk-pixbuf2 glib2 glibc gtk3 libX11 libXcomposite libXdamage libXext libXfixes libXrandr libXtst libcanberra-gtk3 libdrm libgcc libstdc++ libxcb libxkbcommon libxshmfence libxslt mesa-libgbm nspr nss nss-util pango policycoreutils policycoreutils-python-utils zlib cairo-gobject centos-indexhtml dbus-glib fontconfig freetype gtk2 libXcursor libXi libXrender libXt liberation-fonts-common liberation-sans-fonts libffi mozilla-filesystem p11-kit-trust pipewire-libs harfbuzz-icu libglvnd-glx libglvnd-egl libnotify opus woff2 gstreamer1-plugins-base gstreamer1-plugins-bad-free openjpeg2 libwebp enchant libsecret hyphen libglvnd-gles
-```

{nonebot_plugin_htmlrender-0.6.5 → nonebot_plugin_htmlrender-0.6.6}/README.md

@@ -4,13 +4,13 @@
 - 可通过查看`example`参考使用实例
 - 如果有安装浏览器等问题，先查看文档最底下的`常见问题`再去看 issue 有没有已经存在的
 
-# ✨ 功能
+## ✨ 功能
 
 - 通过 html 和浏览器生成图片
 - 支持`纯文本` `markdown` 和 `jinja2` 模板输入
 - 通过 CSS 来控制样式
 
-# 使用
+## 使用
 
 参考[example/plugins/render/**init**.py](example/plugins/render/__init__.py)
 
@@ -32,9 +32,9 @@ from nonebot_plugin_htmlrender import (
 # 注意顺序，先require再 from ... import ...
 ```
 
-# 配置
+## 配置
 
-## .env 配置项说明
+### .env 配置项说明
 
 ```ini
 # Playwright 浏览器引擎类型
@@ -72,9 +72,52 @@ htmlrender_browser_executable_path = ""
 # 可选，用于连接已运行的浏览器实例
 # 使用时需要在启动浏览器时添加参数 --remote-debugging-port=端口号
 htmlrender_connect_over_cdp = "http://127.0.0.1:9222"
+
+# Playwright ws 连接地址
+# 可选，用于连接 playwright 的 docker 容器
+# https://playwright.dev/docs/docker
+# 配套的 docker-compose.yaml 中，已经填好了
+htmlrender_connect="ws://playwright:3000"
 ```
 
-## markdown 转 图片
+## 部署
+
+### （建议）使用 docker compose 进行部署
+
+> 前提条件：你的项目使用 uv 管理 或 `pyproject.toml` 的 `dependencies` 中已经包含你的依赖
+>
+> 此方法会将 nonebot2 和 playwright 分开两个容器
+
+1. 将 `docker-compose.yaml` & `entrypoint.sh` 复制到你自己的项目根目录下
+2. 根据你的需要调整 `docker-compose.yaml` & `entrypoint.sh`
+3. 拉取镜像 `docker compose pull`
+4. 启动容器 `docker compose up -d`
+
+> - 查看日志 `docker compose logs -f`
+> - 停止/重启容器 `docker compose`
+
+### docker 单容器部署
+
+> 前提条件：你的项目使用 uv 管理 或 `pyproject.toml` 的 `dependencies` 中已经包含你的依赖
+>
+> 此方法会将 nonebot2 和 playwright 运行在同一个容器中
+>
+> 而且你还有需要清楚你要干什么
+
+1. 将 `docker-compose.yaml` & `entrypoint.sh` 复制到你自己的项目根目录下
+2. 根据你的情况，调整指令
+
+```bash
+docker run -d \
+--name nonebot2 \
+-v $(pwd):/app \
+-p 9012:9012 \
+-e "PLAYWRIGHT_BROWSERS_PATH=/app/pw-browsers" \
+ghcr.io/kexue-z/nonebot-plugin-htmlrender/nonebot2-playwrght-uv sh -c "./entrypoint.sh"
+```
+
+## 说明
+### markdown 转 图片
 
 - 使用 `GitHub-light` 样式
 - 支持绝大部分 md 语法
@@ -85,38 +128,38 @@ htmlrender_connect_over_cdp = "http://127.0.0.1:9222"
 - 图片需要使用外部连接并使用`html`格式 否则文末会超出截图范围
 - 图片可使用 md 语法 路径可为 `绝对路径`(建议), 或 `相对于template_path` 的路径
 
-## 模板 转 图片
+### 模板 转 图片
 
 - 使用 jinja2 模板引擎
 - 页面参数可自定义
 
-# 🌰 栗子
+## 🌰 栗子
 
 [example.md](docs/example.md)
 
-## 文本转图片（同时文本里面可以包括 html 图片）
+### 文本转图片（同时文本里面可以包括 html 图片）
 
 ![](docs/text2pic.png)
 
-## markdown 转图片（同时文本里面可以包括 html 图片）
+### markdown 转图片（同时文本里面可以包括 html 图片）
 
 ![](docs/md2pic.png)
 
-## 纯 html 转图片
+### 纯 html 转图片
 
 ![](docs/html2pic.png)
 
-## jinja2 模板转图片
+### jinja2 模板转图片
 
 ![](docs/template2pic.png)
 
-# 特别感谢
+## 特别感谢
 
 - [MeetWq](https://github.com/MeetWq) 提供数学公式支持代码和代码高亮
 
-# 常见疑难杂症
+## 常见疑难杂症
 
-## `playwright._impl._api_types.Error:` 初次运行时报错
+### `playwright._impl._api_types.Error:` 初次运行时报错
 
 - 一般为缺少必要的运行环境，如中文字体等
 
@@ -135,18 +178,3 @@ LANG zh_CN.UTF-8
 LANGUAGE zh_CN.UTF-8
 LC_ALL zh_CN.UTF-8
 ```
-
-### CentOS 使用 `yum`
-
-- ~~小心 CentOS~~
--
-参考[CentOS Dockerfile](https://github.com/kumaraditya303/playwright-centos/blob/master/Dockerfile)
-- 添加中文字体库
-- ~~最佳解决办法~~
-    - 使用 Docker 然后用 Python 镜像 按照上面 Ubuntu 的写 `dockerfile`
-
-下面这个依赖运行一下 也许就可以用了
-
-```sh
-dnf install -y alsa-lib at-spi2-atk at-spi2-core atk cairo cups-libs dbus-libs expat flac-libs gdk-pixbuf2 glib2 glibc gtk3 libX11 libXcomposite libXdamage libXext libXfixes libXrandr libXtst libcanberra-gtk3 libdrm libgcc libstdc++ libxcb libxkbcommon libxshmfence libxslt mesa-libgbm nspr nss nss-util pango policycoreutils policycoreutils-python-utils zlib cairo-gobject centos-indexhtml dbus-glib fontconfig freetype gtk2 libXcursor libXi libXrender libXt liberation-fonts-common liberation-sans-fonts libffi mozilla-filesystem p11-kit-trust pipewire-libs harfbuzz-icu libglvnd-glx libglvnd-egl libnotify opus woff2 gstreamer1-plugins-base gstreamer1-plugins-bad-free openjpeg2 libwebp enchant libsecret hyphen libglvnd-gles
-```

nonebot_plugin_htmlrender-0.6.6/docker-compose.yaml

@@ -0,0 +1,37 @@
+services:
+  nonebot:
+    image: ghcr.io/kexue-z/nonebot-plugin-htmlrender/nonebot2-playwrght-uv
+    env_file:
+      - .env.prod
+    ports:
+      # nonebot2 监听端口
+      - "9012:9012"
+    volumes:
+      - .:/app
+
+      # 如果使用 plugin-localstore，你应该同时挂载下面几个路径
+      # - plugin-localstore-cache:/root/.cache/nonebot2
+      # - plugin-localstore-data:/root/.local/share/nonebot2
+      # - plugin-localstore-config:/root/.config/nonebot2
+
+      # 挂载浏览器目录，持久化存储，同时修改下方环境变量
+      # - /path/to/your/host/browsers:/pw-browsers
+
+    environment:
+      - HTMLRENDER_CONNECT="ws://playwright:3000"
+      # - PLAYWRIGHT_BROWSERS_PATH=/pw-browsers
+
+  playwright:
+    image: mcr.microsoft.com/playwright:v1.52.0-noble
+    container_name: playwright
+    entrypoint: ["/bin/sh", "-c", "npx -y playwright@1.52.0 run-server --port 3000 --host 0.0.0.0"]
+    volumes:
+      # 挂载 nonebot 的文件路径，以便本地资源文件可以访问
+      - .:/app
+
+
+# 如果使用 plugin-localstore，你应该同时挂载下面几个路径
+# volumes:
+#   plugin-localstore-cache:
+#   plugin-localstore-data:
+#   plugin-localstore-config:

nonebot_plugin_htmlrender-0.6.6/dockerfile

@@ -0,0 +1,39 @@
+# Use a Python image with uv
+FROM docker.io/library/python:3.12-slim-bookworm
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /uvx /bin/
+
+# Setting env
+ENV TZ=Asia/Shanghai \
+    DEBIAN_FRONTEND=noninteractive \
+    # Enable bytecode compilation
+    UV_COMPILE_BYTECODE=1 \
+    UV_LINK_MODE=copy
+    
+# use mirrors
+# ENV UV_DEFAULT_INDEX="https://mirrors.aliyun.com/pypi/simple"
+
+# use mirrors
+# RUN echo "deb https://mirrors.tuna.tsinghua.edu.cn/debian/ bookworm main contrib" >> /etc/apt/sources.list\
+#   && echo "deb https://mirrors.tuna.tsinghua.edu.cn/debian/ bookworm-updates main contrib" >> /etc/apt/sources.list\
+#   && echo "deb https://mirrors.tuna.tsinghua.edu.cn/debian/ bookworm-backports main contrib" >> /etc/apt/sources.list\
+#   && echo "deb https://mirrors.tuna.tsinghua.edu.cn/debian-security bookworm-security main contrib" >> /etc/apt/sources.list
+
+# install nb-cli & playwright
+RUN uv pip install --system nb-cli playwright
+
+# install font fonts-noto-color-emoji
+RUN apt-get update \
+    && apt-get install -y --no-install-recommends fontconfig \
+    && rm -rf /tmp/sarasa /tmp/sarasa.7z /var/lib/apt/lists/*
+
+# RUN playwright install --only-shell --with-deps chromium \
+#     && rm -rf /var/lib/apt/lists/*
+
+
+# Set workdir `/app`
+WORKDIR /app
+
+# Clean uv entrypoint
+ENTRYPOINT [""]
+
+CMD ["sh","-c", "./entrypoint.sh"]

nonebot_plugin_htmlrender-0.6.6/entrypoint.sh

@@ -0,0 +1,71 @@
+#!/bin/bash
+
+# Font installation script
+
+set -e
+
+# Source fonts directory
+# FONT_SRC_DIR="/app/fonts"
+# Destination fonts directory
+# FONT_DEST_DIR="/usr/share/fonts"
+
+# Supported font file extensions
+# FONT_EXTS=("ttc" "ttf" "otf" "woff" "woff2")
+
+# Font installation function with existence check
+# install_fonts() {
+#     local dir="$1"
+    
+#     # Find all font files
+#     while IFS= read -r -d '' file; do
+#         # Get file extension
+#         ext="${file##*.}"
+        
+#         # Check if it's a supported font format
+#         if [[ " ${FONT_EXTS[@]} " =~ " ${ext,,} " ]]; then
+#             # Get relative path
+#             relative_path="${file%/*}"
+#             relative_path="${relative_path#$FONT_SRC_DIR/}"
+            
+#             # Create destination directory
+#             dest_dir="$FONT_DEST_DIR/$relative_path"
+#             mkdir -p "$dest_dir"
+            
+#             # Destination file path
+#             dest_file="$dest_dir/$(basename "$file")"
+            
+#             # Check if file already exists
+#             if [ ! -f "$dest_file" ]; then
+#                 # Copy font file
+#                 echo "Installing font: $file -> $dest_dir/"
+#                 install -m644 "$file" "$dest_dir/"
+#             else
+#                 echo "Skipping existing font: $dest_file"
+#             fi
+#         fi
+#     done < <(find "$dir" -type f -print0)
+# }
+
+# Main execution
+# if [ -d "$FONT_SRC_DIR" ]; then
+#     echo "Starting font installation..."
+#     install_fonts "$FONT_SRC_DIR"
+    
+#     # Update font cache
+#     echo "Updating font cache..."
+#     fc-cache -fv
+    
+#     echo "Font installation completed!"
+# else
+#     echo "Error: Font directory $FONT_SRC_DIR does not exist, skipping installation. Note: Playwright might lack Chinese fonts"
+# fi
+
+# Playwright browsers
+# echo "Install Playwright browsers..."
+# playwright install --only-shell --with-deps chromium \
+#     && rm -rf /var/lib/apt/lists/*
+
+# Install your project deps
+uv sync --frozen --no-install-project --no-dev
+
+nb run

nonebot_plugin_htmlrender-0.6.6/example/docker-compose.yaml

@@ -0,0 +1 @@
+../docker-compose.yaml

nonebot_plugin_htmlrender-0.6.6/example/entrypoint.sh

@@ -0,0 +1 @@
+../entrypoint.sh

nonebot_plugin_htmlrender-0.6.6/example/pyproject.toml

@@ -0,0 +1,24 @@
+[project]
+name = "example"
+version = "0.1.0"
+description = "example"
+readme = "README.md"
+requires-python = ">=3.9, <4.0"
+dependencies = [
+    "nonebot-adapter-onebot>=2.4.6",
+    "nonebot-plugin-htmlrender>=0.6.5",
+    "nonebot2[fastapi]>=2.4.2",
+    "pillow>=11.2.1",
+]
+
+[tool.nonebot]
+adapters = [
+    { name = "OneBot V11", module_name = "nonebot.adapters.onebot.v11" },
+]
+plugins = [""]
+plugin_dirs = ["plugins"]
+builtin_plugins = ["echo"]
+
+[[tool.uv.index]]
+url = "https://mirrors.aliyun.com/pypi/simple"
+default = true

{nonebot_plugin_htmlrender-0.6.5 → nonebot_plugin_htmlrender-0.6.6}/nonebot_plugin_htmlrender/browser.py

@@ -173,10 +173,10 @@ async def start_browser(**kwargs) -> Browser:
             kwargs["executable_path"] = plugin_config.htmlrender_browser_executable_path
         else:
             try:
-                await check_playwright_env()
+                await check_playwright_env(**kwargs)
             except RuntimeError:
                 await install_browser()
-                await check_playwright_env()
+                await check_playwright_env(**kwargs)
 
         _browser = await _launch(plugin_config.htmlrender_browser, **kwargs)
 
@@ -193,12 +193,12 @@ async def shutdown_browser() -> None:
             await _playwright.stop()
 
 
-async def check_playwright_env():
+async def check_playwright_env(**kwargs):
     """Check Playwright environment."""
     logger.info("Checking Playwright environment...")
     try:
         async with async_playwright() as p:
-            await getattr(p, plugin_config.htmlrender_browser).launch()
+            await getattr(p, plugin_config.htmlrender_browser).launch(**kwargs)
     except Exception as e:
         raise RuntimeError(
             "Playwright environment is not set up correctly. "

{nonebot_plugin_htmlrender-0.6.5 → nonebot_plugin_htmlrender-0.6.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "nonebot-plugin-htmlrender"
-version = "0.6.5"
+version = "0.6.6"
 description = "通过浏览器渲染图片"
 readme = "README.md"
 authors = [{ name = "kexue", email = "x@kexue-cloud.cn" }]