Package: edx-helper
edx-helperedx-helperis forked fromedx-dlwhich is no longer maintained.IntroductionInstallation instructionsInstallation (recommended)Manual InstallationDocker containerOptional: update youtube-dlQuick StartList coursesDownload courseMore download optionsTroubleshootingchina-issuesReporting issuesSupported sitesDisclaimerIntroductionedx-helperis a simple tool to download videos and lecture materials from Open
edX-based sites.It is platform independent, and should work fine under Unix (Linux, BSDs etc.), Windows or Mac OS X.Installation instructionsedx-helperrequires Python 3 and very few other dependencies. (As of October 2023,edx-helperpassed the test of Python versions 3.7, 3.8, 3.9, 3.10, and 3.11).Installation (recommended)Opening a terminal and typing the command If you have installed Python:pip install edx-helperManual Installationpip install git+https://github.com/csyezheng/edx-helper.gitorgit clone https://github.com/csyezheng/edx-helper.git
cd edx-helper
pip install -r requirements.txt
python setup.py installDocker containerYou can run this application viaDockerif you want. Just install docker and rundocker run --rm -it \
       -v "$(pwd):/Downloaded" \
       csyezheng/edx-helper -u <USER> -p <PASSWORD> COURSE_URLPlease note that it will prompt that unable to find the image locally, please wait patiently for downloading.The course files will be downloaded to your current directory.Optional: update youtube-dlOne of the most important dependencies ofedx-helperisyoutube-dl. The
installation step listed above already pulls in the most recent version ofyoutube-dlfor you.Unfortunately, since many Open edX sites store their videos on Youtube and
Youtube changes their layout from time to time, it may be necessary to
upgrade your copy ofyoutube-dl.  There are many ways to proceed here, but
the simplest is to simply use:pip install --upgrade youtube-dlQuick StartRun the following command to query the usage and options:edx-helper --helpList coursesRun the following command to query the courses in which you are enrolled:edx-helper -u <email> --list-coursesDownload courseFrom there, choose the course you are interested in, copy its URL and use it
in the following command:edx-helper -u <email> COURSE_URLYour downloaded videos will be placed in a new directory calledDownloaded, inside your current directory, but you can also choose another
destination with the-oargument.More download optionsNormal download:edx-helper -u <user> COURSE_URLDownload with subtitles:edx-helper -u <user> --with-subtitles COURSE_URLSpecify download directory：edx-helper -u <user> -o ~/courses/ COURSE_URLSpecify additional downloads by extension:edx-helper -u <user> --file-formats "png,jpg" COURSE_URLDownload CDN videos, do not download youtube videos:edx-helper -u <user> --prefer-cdn-videos COURSE_URLTo see all available options and a brief description of what they do, simply
execute:edx-helper --helpImportant Note:To use sites other than <edx.org>, youhaveto specify the
site along with the-xoption. For example,-x stanford, if the course
that you want to get is hosted on Stanford's site.Troubleshootingchina-issuesChina cannot access YouTube. Please use the--prefer-cdn-videosoption first, or use the--ignore-errorsoption. If you want to download YouTube videos, please use a proxy.Reporting issuesBefore reporting any issue please follow the steps below:Verify that you are running the latest version of all the programs (both ofedx-helperand ofyoutube-dl).  Use the following command if in doubt:pip install --upgrade edx-helperIf you get an error like"YouTube said: Please sign in to view this video.", then we can't do much about it. You can try to pass your credentials toyoutube-dl(seehttps://github.com/rg3/youtube-dl#authentication-options) with the use ofedx-helper's option--youtube-dl-options. If it doesn't work, then you will have to telledx-helperto ignore the download of that particular video with the option--ignore-errors.If the problem persists, feel free toopen an issuein our bug tracker, please fill the issue template withas much information as
possible.Supported sitesExcept for edx, they have not been tested and are not supported yet. They may be supported in the future.These are the current supported sites:edXStanfordUniversity of SydneyFrance Université NumériqueGW Online SEAS- George Washington UniversityGW Online Open- George Washington UniversityThis is the full [list of sites powered by Open edX][https://github.com/edx/edx-platform/wiki/Sites-powered-by-Open-edX]. Not all of them are supported at the moment, we welcome you to contribute support for them
and send a pull request also via ourissue tracker.Disclaimeredx-helperis meant to be used only for your material that edX gives you access to download. We do not encourage any use that violates their Terms Of Use.