nonebot-plugin-htmlrender 0.3.5__tar.gz → 0.5.0__tar.gz

nonebot_plugin_htmlrender-0.5.0/.flake8

@@ -0,0 +1,3 @@
+[flake8]
+max-line-length = 90
+ignore= F401

nonebot_plugin_htmlrender-0.5.0/.github/workflows/codecov.yml

@@ -0,0 +1,43 @@
+name: Code Coverage
+
+on:
+  push:
+    branches:
+      - "master"
+      - "dev"
+  pull_request:
+    branches:
+      - "master"
+
+jobs:
+  test:
+    name: Test
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+        os: [ubuntu-latest, windows-latest, macos-latest]
+      fail-fast: false
+    env:
+      OS: ${{ matrix.os }}
+      PYTHON_VERSION: ${{ matrix.python-version }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+          python-version: ${{ matrix.python-version }}
+
+      - run: uv sync
+        shell: bash
+
+      - name: Run tests
+        run: uv run pytest -s
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v2
+        with:
+          env_vars: OS,PYTHON_VERSION

nonebot_plugin_htmlrender-0.5.0/.github/workflows/publish.yml

@@ -0,0 +1,55 @@
+on:
+  push:
+    tags:
+      - "*"
+  workflow_dispatch:
+
+jobs:
+  pypi-publish:
+    name: Upload release to PyPI
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+
+      - name: "Set up Python"
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: ".python-version"
+
+      - run: uv sync
+        shell: bash
+
+      # - name: Get Version
+      #   id: version
+      #   run: |
+      #     echo "VERSION=$(uvx pdm show --version)" >> $GITHUB_OUTPUT
+      #     echo "TAG_VERSION=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT
+      #     echo "TAG_NAME=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT
+
+      # - name: Check Version
+      # if: steps.version.outputs.VERSION != steps.version.outputs.TAG_VERSION
+      #   run: exit 1
+
+      - name: Build Package
+        run: uv build
+
+      - name: pypi-publish
+        uses: pypa/gh-action-pypi-publish@v1.11.0
+
+      # - name: Publish Package to PyPI
+      #   run: uv publish
+
+      # - name: Publish Package to GitHub Release
+      #   run: gh release create ${{ steps.version.outputs.TAG_NAME }} dist/*.tar.gz dist/*.whl -t "🔖 ${{ steps.version.outputs.TAG_NAME }}" --generate-notes
+      #   env:
+      #     GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

nonebot_plugin_htmlrender-0.5.0/.gitignore

@@ -0,0 +1,129 @@
+*DS_Store*
+test
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+.pdm-python

nonebot_plugin_htmlrender-0.5.0/.python-version

@@ -0,0 +1 @@
+3.12

{nonebot_plugin_htmlrender-0.3.5 → nonebot_plugin_htmlrender-0.5.0}/PKG-INFO

@@ -1,8 +1,10 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: nonebot-plugin-htmlrender
-Version: 0.3.5
+Version: 0.5.0
 Summary: 通过浏览器渲染图片
-Author-Email: kexue <xana278@foxmail.com>
+Project-URL: Homepage, https://github.com/kexue-z/nonebot-plugin-htmlrender
+Project-URL: Bug Tracker, https://github.com/kexue-z/nonebot-plugin-htmlrender/issues
+Author-email: kexue <x@kexue-cloud.cn>
 License: MIT License
         
         Copyright (c) 2021 kexue
@@ -24,17 +26,15 @@ License: MIT License
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
-Project-URL: Homepage, https://github.com/kexue-z/nonebot-plugin-htmlrender
-Project-URL: Bug tracker, https://github.com/kexue-z/nonebot-plugin-htmlrender/issues
 Requires-Python: <4.0,>=3.9
-Requires-Dist: playwright>=1.17.2
-Requires-Dist: nonebot2>=2.2.0
+Requires-Dist: aiofiles>=0.8.0
 Requires-Dist: jinja2>=3.0.3
 Requires-Dist: markdown>=3.3.6
-Requires-Dist: Pygments>=2.10.0
-Requires-Dist: python-markdown-math>=0.8
+Requires-Dist: nonebot2>=2.2.0
+Requires-Dist: playwright>=1.48.0
+Requires-Dist: pygments>=2.10.0
 Requires-Dist: pymdown-extensions>=9.1
-Requires-Dist: aiofiles>=0.8.0
+Requires-Dist: python-markdown-math>=0.8
 Description-Content-Type: text/markdown
 
 # nonebot-plugin-htmlrender
@@ -90,6 +90,14 @@ htmlrender_proxy_host = "http://127.0.0.1:7890"
 # 手动编辑可以直接使用系统自带浏览器而不用重新下载 chromium
 # 可不写
 htmlrender_browser_channel = ""
+
+# 浏览器执行文件路径 可不写
+htmlrender_browser_executable_path = ""
+
+# 使用 cdp 连接现有浏览器
+# 使用方法，自行启动浏览，在启动浏览器时添加参数 --remote-debugging-port=1234
+# 可不写
+htmlrender_connect_over_cdp = "http://127.0.0.1:1234"
 ```
 
 ## markdown 转 图片

{nonebot_plugin_htmlrender-0.3.5 → nonebot_plugin_htmlrender-0.5.0}/README.md

@@ -51,6 +51,14 @@ htmlrender_proxy_host = "http://127.0.0.1:7890"
 # 手动编辑可以直接使用系统自带浏览器而不用重新下载 chromium
 # 可不写
 htmlrender_browser_channel = ""
+
+# 浏览器执行文件路径 可不写
+htmlrender_browser_executable_path = ""
+
+# 使用 cdp 连接现有浏览器
+# 使用方法，自行启动浏览，在启动浏览器时添加参数 --remote-debugging-port=1234
+# 可不写
+htmlrender_connect_over_cdp = "http://127.0.0.1:1234"
 ```
 
 ## markdown 转 图片

nonebot_plugin_htmlrender-0.5.0/docs/example.md

@@ -0,0 +1,119 @@
+md2pic <div align="center">
+<h1>html格式支持和居中</h1>
+<img width="250" src="https://v2.nonebot.dev/logo.png"/>
+<div>
+html格式 图片支持
+</div> 
+</div> 
+
+# 一级标题
+## 二级标题
+### 三级标题
+#### 四级标题
+##### 五级标题
+###### 六级标题
+
+# 文本
+*斜体文本*
+
+_斜体文本_
+
+**粗体文本**
+
+__粗体文本__
+
+***粗斜体文本***
+
+___粗斜体文本___
+
+<s>删除线</s>
+
+~~删除线~~
+
+<u>下划线</u>
+
+~小号~字体
+
+emoji 😀😃😄😁😆😅
+
+列表
+
+* 第一项
+* 第二项
+* 第三项
+
+1. 第一项
+2. 第二项
+3. 第三项
+
+任务列表
+
+- [X] 第一项
+- [ ] 第二项
+
+# 嵌套
+1. 第一项：
+    - 第一项嵌套的第一个元素
+    - 第一项嵌套的第二个元素
+2. 第二项：
+    - 第二项嵌套的第一个元素
+    - 第二项嵌套的第二个元素
+
+- [X] 任务 1
+    * [X] 任务 A
+    * [ ] 任务 B
+        + [x] 任务 a
+        + [ ] 任务 b
+        + [x] 任务 c
+    * [X] 任务 C
+- [ ] 任务 2
+- [ ] 任务 3
+
+分割线
+----
+
+# 图片
+
+- 必须指定宽度或大小 如 `250` 或 `100%`
+```html
+<img width="20%" src="https://v2.nonebot.dev/logo.png"/>
+```
+
+# html同款标签
+
+如 <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd>
+
+# 引用
+
+> 最外层
+> > 第一层嵌套
+> > > 第二层嵌套
+
+# 代码
+
+```python
+import this
+```
+行内代码 `print("nonebot")`
+
+# 表格
+| 左对齐 | 右对齐 | 居中对齐 |
+| :-----| ----: | :----: |
+| 单元格 | 单元格 | 单元格 |
+| 单元格 | 单元格 | 单元格 |
+
+# 数学公式
+
+单行公式
+
+$$(1+x)^\alpha =1+\alpha x +\frac{\alpha (\alpha -1}{2!} x^2+\cdots+\frac{\alpha (\alpha - 1)\cdots(\alpha - n+1)}{n!}x^n+o(x^n)$$
+
+`$$...$$`
+
+行内公式 $f'(x_0)=\lim_{x\rightarrow x_0} \frac{f(x)-f(x_0)}{\Delta x}$ 行内公式
+
+`$...$`
+
+# 不支持
+- md 格式图片插入（必须使用html格式）
+- 某些符号会被自动转换

nonebot_plugin_htmlrender-0.5.0/example/.env.dev

@@ -0,0 +1,7 @@
+HOST=127.0.0.1
+PORT=9905
+DEBUG=true
+SUPERUSERS=["1"]
+COMMAND_START=["/", ""]
+COMMAND_SEP=["."]
+FASTAPI_RELOAD_DIRS=["data/"]

nonebot_plugin_htmlrender-0.5.0/example/bot.py

@@ -0,0 +1,12 @@
+import nonebot
+from nonebot.adapters.onebot.v11 import Adapter as OneBotV11Adapter
+
+nonebot.init()
+driver = nonebot.get_driver()
+driver.register_adapter(OneBotV11Adapter)
+
+nonebot.load_plugins("plugins")
+
+
+if __name__ == "__main__":
+    nonebot.run()

nonebot_plugin_htmlrender-0.5.0/example/plugins/render/__init__.py

@@ -0,0 +1,144 @@
+from nonebot import require
+require("nonebot_plugin_htmlrender")
+# 注意顺序，先require再 from ... import ...
+# 注意顺序，先require再 from ... import ...
+# 注意顺序，先require再 from ... import ...
+from nonebot_plugin_htmlrender import (
+    text_to_pic,
+    md_to_pic,
+    template_to_pic,
+    get_new_page,
+)
+# 注意顺序，先require再 from ... import ...
+# 注意顺序，先require再 from ... import ...
+# 注意顺序，先require再 from ... import ...
+
+from nonebot import on_command
+from nonebot.adapters.onebot.v11 import Bot, MessageEvent, MessageSegment
+from PIL import Image
+import io
+
+from .utils import count_to_color
+
+# 纯文本转图片
+text2pic = on_command("text2pic")
+
+
+@text2pic.handle()
+async def _text2pic(bot: Bot, event: MessageEvent):
+    msg = str(event.get_message())
+
+    # css_path 可选
+    # from pathlib import Path
+    # pic = await text_to_pic(
+    #     text=msg, css_path=str(Path(__file__).parent / "templates" / "markdown.css")
+    # )
+
+    pic = await text_to_pic(text=msg)
+    a = Image.open(io.BytesIO(pic))
+    a.save("text2pic.png", format="PNG")
+    await text2pic.finish(MessageSegment.image(pic))
+
+
+# 加载本地 html 方法
+html2pic = on_command("html2pic")
+
+
+@html2pic.handle()
+async def _html2pic(bot: Bot, event: MessageEvent):
+    from pathlib import Path
+
+    # html 可使用本地资源
+    async with get_new_page(viewport={"width": 300, "height": 300}) as page:
+        await page.goto(
+            "file://" + (str(Path(__file__).parent / "html2pic.html")),
+            wait_until="networkidle",
+        )
+        pic = await page.screenshot(full_page=True, path="./html2pic.png")
+
+    await html2pic.finish(MessageSegment.image(pic))
+
+
+# 使用 template2pic 加载模板
+template2pic = on_command("template2pic")
+
+
+@template2pic.handle()
+async def _template2pic(bot: Bot, event: MessageEvent):
+    from pathlib import Path
+
+    text_list = ["1", "2", "3", "4"]
+    template_path = str(Path(__file__).parent / "templates")
+    template_name = "text.html"
+    # 设置模板
+    # 模板中本地资源地址需要相对于 base_url 或使用绝对路径
+    pic = await template_to_pic(
+        template_path=template_path,
+        template_name=template_name,
+        templates={"text_list": text_list},
+        pages={
+            "viewport": {"width": 600, "height": 300},
+            "base_url": f"file://{template_path}",
+        },
+        wait=2,
+    )
+
+    a = Image.open(io.BytesIO(pic))
+    a.save("template2pic.png", format="PNG")
+
+    await template2pic.finish(MessageSegment.image(pic))
+
+
+# 使用自定义过滤器
+template_filter = on_command("template_filter")
+
+
+@template_filter.handle()
+async def _():
+    from pathlib import Path
+
+    count_list = ["1", "2", "3", "4"]
+    template_path = str(Path(__file__).parent / "templates")
+    template_name = "progress.html.jinja2"
+
+    pic = await template_to_pic(
+        template_path=template_path,
+        template_name=template_name,
+        templates={"counts": count_list},
+        filters={"count_to_color": count_to_color},
+        pages={
+            "viewport": {"width": 600, "height": 300},
+            "base_url": f"file://{template_path}",
+        }
+    )
+
+    a = Image.open(io.BytesIO(pic))
+    a.save("template_filter.png", format="PNG")
+
+    await template_filter.finish(MessageSegment.image(pic))
+
+
+# 使用 md2pic
+md2pic = on_command("md2pic")
+
+
+@md2pic.handle()
+async def _md2pic(bot: Bot, event: MessageEvent):
+    from pathlib import Path
+
+    # 如果是直接获取消息内容 需要 unescape
+    from nonebot.adapters.onebot.v11 import unescape
+
+    msg = unescape(str(event.get_message()))
+
+    # css_path 可选
+    # pic = await md_to_pic(
+    #     md=msg, css_path=str(Path(__file__).parent / "templates" / "markdown.css")
+    # )
+
+    pic = await md_to_pic(md=msg)
+
+    a = Image.open(io.BytesIO(pic))
+    a.save("md2pic.png", format="PNG")
+
+    await md2pic.finish(MessageSegment.image(pic))

nonebot_plugin_htmlrender-0.5.0/example/plugins/render/html2pic.html

@@ -0,0 +1,31 @@
+<!DOCTYPE html>
+<html>
+
+<head>
+    <meta charset="utf-8">
+    <title>菜鸟教程(runoob.com)</title>
+</head>
+
+<body>
+
+    <div style="opacity:0.5;position:absolute;left:50px;width:300px;height:150px;background-color:#40B3DF"></div>
+
+    <div style="font-family:verdana;padding:20px;border-radius:10px;border:10px solid #EE872A;">
+
+        <div style="opacity:0.3;position:absolute;left:120px;width:100px;height:200px;background-color:#8AC007"></div>
+
+        <h3>Look! Styles and colors</h3>
+
+        <div style="letter-spacing:12px;">Manipulate Text</div>
+
+        <div style="color:#40B3DF;">Colors
+            <span style="background-color:#B4009E;color:#ffffff;">Boxes</span>
+        </div>
+
+        <div style="color:#000000;">and more...</div>
+
+    </div>
+
+</body>
+
+</html>

nonebot_plugin_htmlrender-0.5.0/example/plugins/render/templates/progress.html.jinja2

@@ -0,0 +1,27 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Example</title>
+
+    {# 使用 tailwindclss CDN（仅用于举例，不建议在生产环境中使用） #}
+    <script src="https://cdn.tailwindcss.com"></script> 
+</head>
+<body>
+  {% for count in counts %}
+    <div>
+      <div class="mb-2 flex justify-between items-center">
+          <h3 class="text-sm font-semibold text-black">Count: {{ count }}</h3>
+          <span class="text-sm text-black">{{ count | count_to_color }}</span>
+      </div>
+      <div class="flex w-full h-2 bg-gray-200 rounded-full overflow-hidden" role="progressbar" aria-valuenow="{{ count }}" aria-valuemin="0" aria-valuemax="100">
+        <div
+          class="flex flex-col justify-center rounded-full overflow-hidden text-xs text-white text-center whitespace-nowrap transition duration-500"
+          style="width: 50%; background-color: {{ count | count_to_color }};"
+        >
+        </div>
+    </div>
+  {% endfor %}
+</body>
+</html>

nonebot_plugin_htmlrender-0.5.0/example/plugins/render/utils.py

@@ -0,0 +1,12 @@
+from nonebot.log import logger
+
+def count_to_color(count: str) -> str:
+    logger.debug(f"Filtering count: {count}") 
+    if count == '1':
+        return "#facc15"
+    elif count == '2':
+        return "#f87171"
+    elif count == '3':
+        return "#c084fc"
+    else:
+        return "#60a5fa"

{nonebot_plugin_htmlrender-0.3.5 → nonebot_plugin_htmlrender-0.5.0}/nonebot_plugin_htmlrender/__init__.py

@@ -6,6 +6,7 @@ from .browser import (
     get_browser as get_browser,
     get_new_page as get_new_page,
     shutdown_browser as shutdown_browser,
+    init_browser as init_browser,
 )
 from .data_source import (
     capture_element as capture_element,
@@ -35,9 +36,8 @@ async def init(**kwargs):
     Returns:
         Browser: Browser
     """
-    browser = await get_browser(**kwargs)
-    logger.info("Browser Started.")
-    return browser
+    logger.info("Browser Starting.")
+    return await init_browser(**kwargs)
 
 
 @driver.on_shutdown