pallets/click

Add Screenshot workflow

Open

#3,081 建立於 2025年9月22日

在 GitHub 查看
 (14 留言) (0 反應) (0 負責人)Python (14,710 star) (1,419 fork)batch import
docsgood first issue

描述

In a few places in the docs, it would be really nice to be able to run some code take a screen shot, and draw boxes around different parts. For example setup an example click app with multiple sub commands, options, epilog help, and arguments and then draw boxes and label the various blocks. Requirements:

  • run locally for doc generation (actually locally not calling out to api)
  • run in ci job (not calling out to external service)
  • No added dependencies that are not pip installable
  • have the screen shots not be blurry (common problem)
  • draw boxes around various sections.

Conduct some research and propose some options. A maintainer will pick from the options. and you can implement it. Here is an example of what I was thinking is in the comments below.

貢獻者指南

技術棧
python
領域
documentation
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
active
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Python programmingClick CLI frameworkGitHub Actions basics
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
70
研究方向
Start by reviewing the discussion in the issue comments, especially the example mentioned by the maintainer. Then research Python screenshot libraries that are pip installable and can run headlessly, such as Pillow (with ImageGrab), pyautogui, or selenium with a headless browser. Evaluate each against the requirements: local execution, CI compatibility (without external services), image quality (non blurry), and ability to draw boxes (e.g., using Pillow's ImageDraw). Document your findings with pros and cons, and propose a recommended approach. Also consider how to integrate the screenshot generation into the existing documentation build process; look at the docs directory in the repository for any existing build scripts (e.g., in docs/conf.py or Makefile).