`edx-dl` 使用与安装指南

一、安装指南

edx-dl 是一个简单的工具，用于从基于 Open edX 的网站下载视频和讲义材料。它需要一个 Python 解释器（版本 >= 2.7）和很少的其他依赖项。它是跨平台的，可以在 Unix（Linux、BSDs 等）、Windows 或 Mac OS X 上正常工作。

如果您还没有安装 Python 解释器，我们强烈建议您安装 Python >= 3.6，因为通常情况下它表现更好。

推荐安装

要安装 edx-dl，请运行以下命令：

pip install edx-dl

手动安装

要安装所有依赖项，请执行以下命令：

pip install -r requirements.txt

安装 youtube-dl

edx-dl 最重要的依赖之一是 youtube-dl。上述安装步骤已经为您拉取了 youtube-dl 的最新版本。

由于许多 Open edX 网站将视频存储在 YouTube 上，而 YouTube 会不时更改其布局，因此可能需要升级您的 youtube-dl 副本。最简单的方法是使用以下命令：

pip install --upgrade youtube-dl

二、项目使用说明

在安装完所有内容之后，要使用 edx-dl.py，让它发现您已报名的课程，请执行以下命令：

edx-dl -u [e-mail] --list-courses

然后，选择您感兴趣的课程，复制其 URL 并在以下命令中使用：

edx-dl -u [e-mail] COURSE_URL

将 COURSE_URL 替换为您在第一步复制的 URL。它应该看起来像这样：

https://courses.edx.org/courses/edX/DemoX.1/2014/info

下载的视频将被放置在当前目录下名为 Downloaded 的新目录中，但您也可以使用 -o 参数选择其他目的地。

要查看所有可用选项及其简要说明，只需执行：

edx-dl --help

重要提示： 如果要使用除 <edx.org> 以外的网站，您必须指定网站以及 -x 选项。例如，如果要获取斯坦福大学的课程，可以使用 -x stanford。

三、项目API使用文档

项目不提供特定的 API 文档，但所有命令行选项和参数在执行 edx-dl --help 时都有说明。

四、项目安装方式

除了上述的 pip install 方式外，您还可以使用 Docker 容器运行此应用程序。只需安装 Docker 并运行以下命令：

docker run --rm -it \
       -v "$(pwd)/edx/:/Downloaded" \
       strm/edx-dl -u <USER> -p <PASSWORD>

在报告任何问题之前，请确保您运行的是所有程序（包括 edx-dl 和 youtube-dl）的最新版本。如果在怀疑，请使用以下命令：

pip install --upgrade edx-dl