README_zh-hans.md

canvas-grab

将 Canvas 课程系统上的所有文件抓取到本地目录！

入门指南

如果您希望享受直接运行源代码的快感，可以 在这里 下载最新版本源代码，并按照 “构建并从源代码运行” 章节进行。

或者，您也可以直接 在这里 下载构建好的二进制包，有能双击打开的 canvas_grab(.exe) 文件哦！

本程序将会在首次启动时提示输入一个 API 密钥， API 密钥可以通过 Canvas 的 “设置” 页面生成。通过修改 config.toml 文件还可以对程序进行自定义，想试试更多炫酷功能吗？去“配置”章节看看吧！

在下载过程中可以随时中断，程序在下次启动时会继续当前进度。

如果需要重新下载全部文件，可以删除检查点文件 .checkpoint 和文件下载目录 files/。

升级的步骤很简单。用新版的 canvas_grab 覆盖旧版即可。如果您希望使用新功能的话，您需要自己修改 config.toml。我们发布新版本时保证程序兼容旧配置，与旧版本的行为一致。

如果您有任何问题和建议，请在 这里 提交 issue。

配置

config.toml 文件可以对 canvas_grab 程序进行配置，这是一个可以用任何一个文本编辑器打开的纯文本文件。 可以参考 config.example.toml 或 config.example.zh-hans.toml文件中的注释进行配置。

炫酷功能

• 支持所有使用 Canvas 系统的网站！ 只要配置正确的 Canvas 系统网址即可。
• 自动记录下载状态！ 只要资源没有发生更新，文件就不会被反复下载。
• 设置文件尺寸过滤和类型过滤！ 可以设置允许下载的最大文件尺寸，还能通过文件扩展名过滤不想要的文件。
• 自动重试！ 当网络连接出错时，程序会自动进行重试，它随时都会停下来！
• 自动归类！ 所有文件都会被自动保存至对应课程的目录。课程目录名还可以利用像 {CANVAS_ID}-{NAME} 这样的模板来自定义！
• 按单元下载！ 您可以在 config.toml 中设置按单元下载。
• 解析视频！ 支持解析 v.sjtu.edu.cn 的视频 URL。在开启此功能之前，您需要安装 ffmpeg。

构建并从源代码运行

首先，请按照 Python 3.7 或更高版本。

对于 macOS 或 Linux 用户，运行：

pip3 install -r requirements.txt
./main.py

对于 Windows 用户，运行：

pip install -r requirements.windows.txt
python main.py

常见问题

• 获取 API 密钥 在 Canvas 系统中，依次找到“账户” - “设置” - “创建新访问许可证”.
• 交大人 可直接通过传送门生成访问令牌。
• 提示 An error occurred 如果出现"An error occurred when processing this course"说明课程中没有任何文件。
• 提示 File not available 此文件可能位于未发布的章节， canvas_grab 无法绕过平台的限制。
• 提示 No module named 'canvasapi' 请参考“构建并从源代码运行”章节进行构建或直接下载构建好的二进制包。
• 提示 Error when checking update 这个现象在较差的网络环境里发生是正常的。经常来 GitHub 看看有没有更新就行了。
• 提示 Unsupported Link canvas_grab 只支持 v.sjtu.edu.cn 视频的下载。现在暂时不支持 vshare.sjtu.edu.cn。
• 提示 Reserved escape sequence used 请使用"/"作为文件路径分隔符，不要使用"\"。
• 下载 FFMPEG 在 这里 可以下载已经编译好的 ffmpeg。
• macOS 提示文件损坏 macOS 的安全机制导致。请在设置-隐私中允许运行，或从源代码直接运行。
• 跳过导致程序崩溃的课程 在 config.toml 中，把 ID 加入 IGNORED_COURSE。
• 提示 Duplicated files detected C同一目录下出现了两个同名文件。您需要自己在 Canvas 上下载这个文件。
• 提示 Ignored Course 如果出现"Ignored Course"警告，表明 canvas_grab 无法访问此课程。可能是由于 (1) 课程没有发布 (2) 课程在之前的学期。只有 <= 1.7.4 的版本会有这个提示。

截图

参与者

@skyzh, @danyang685, @BugenZhao, @ElectronicElephant, @LuminousXLB

许可证

MIT

我们对（包括但不仅限于）以下行为不负任何责任：

1. 您泄露了自己的 API KEY，由此导致的一切后果。
2. 您把有版权的内容上传，由此导致的一切后果。