贡献¶

本项目的 GitHub 仓库是 simonw/shot-scraper。

要为此工具做贡献，首先检出代码。然后创建一个新的虚拟环境

cd shot-scraper
python -m venv venv
source venv/bin/activate

或者如果您正在使用 pipenv

pipenv shell

现在安装依赖项和测试依赖项

pip install -e '.[test]'

然后您还需要安装 Playwright 浏览器

shot-scraper install

要运行测试

pytest

一些测试直接演练 CLI 工具。像这样运行它们

tests/run_examples.sh

文档¶

本项目的文档使用 MyST 编写 - 它使用 Markdown 编写，并使用 Sphinx 渲染。

要在本地构建文档，请运行以下命令

cd docs
pip install -r requirements.txt
make livehtml

这将启动一个实时预览服务器，使用 sphinx-autobuild。

文档中的 CLI --help 示例使用 Cog 管理。像这样更新这些文件

cog -r docs/*.md

推送发行版后，我使用以下命令创建发行说明的屏幕截图，用于社交媒体帖子

shot-scraper https://github.com/simonw/shot-scraper/releases/tag/0.15 \
  --selector '.Box-body' --width 700 \
  --retina