edx-dl


Nameedx-dl JSON
Version 0.1.5 PyPI version JSON
download
home_pagehttps://github.com/coursera-dl/edx-dl
SummarySimple tool to download video and lecture materials from edx.org.
upload_time2017-07-30 07:50:58
maintainer
docs_urlNone
authorIsmaël Mejía, Rogério Theodoro de Brito
requires_python
licenseLGPL
keywords edx-dl edx download education moocs video
VCS
bugtrack_url
requirements beautifulsoup4 html5lib six youtube_dl
Travis-CI
coveralls test coverage No coveralls.
            |Build Status| |Coverage Status| |Code Climate|

Description
===========

``edx-dl`` is a simple tool to download videos and lecture materials
from Open edX-based sites. It requires a
`Python <https://www.python.org/>`__ interpreter (>= 2.7) and very few
other dependencies. It is platform independent, and should work fine
under Unix (Linux, BSDs etc.), Windows or Mac OS X.

We strongly recommend that, if you don't already have a Python
interpreter installed, that you `install Python >=
3.4 <https://www.python.org/downloads/>`__, if possible, since it has
better security than Python 2.

Installation (recommended)
==========================

To install edx-dl run:

::

    pip install edx-dl

Manual Installation
===================

To install all the dependencies please do:

::

    pip install -r requirements.txt

youtube-dl
----------

One of the most important dependencies of ``edx-dl`` is ``youtube-dl``.
The installation step listed above already pulls in the most recent
version of ``youtube-dl`` for 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 of ``youtube-dl``. There are many ways to proceed
here, but the simplest is to simply use:

::

    pip install --upgrade youtube-dl

Quick Start
===========

Once you have installed everything, to use ``edx-dl.py``, let it
discover the courses in which you are enrolled, by issuing:

::

    edx-dl -u user@user.com --list-courses

From there, choose the course you are interested in, copy its URL and
use it in the following command:

::

    edx-dl -u user@user.com COURSE_URL

replacing ``COURSE_URL`` with the URL that you just copied in the first
step. It should look something like:
https://courses.edx.org/courses/edX/DemoX.1/2014/info

Your downloaded videos will be placed in a new directory called
``Downloaded``, inside your current directory, but you can also choose
another destination with the ``-o`` argument.

To see all available options and a brief description of what they do,
simply execute:

::

    edx-dl --help

*Important Note:* To use sites other than edx.org, you have to specify
the site along with the ``-x`` option. For example, ``-x stanford``, if
the course that you want to get is hosted on Stanford's site.

Docker container
================

You can run this application via `Docker <https://docker.com>`__ if you
want. Just install docker and run

::

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

Reporting issues
================

Before reporting any issue please follow the steps below:

1. Verify that you are running the latest version of all the programs
   (both of ``edx-dl`` and of ``youtube-dl``). Use the following command
   if in doubt:

   ::

       pip install --upgrade edx-dl

2. If the problem persists, feel free to `open an
   issue <https://github.com/coursera-dl/edx-dl/issues>`__ in our
   bugtracker, please fill the issue template with *as much information
   as possible*.

Supported sites
===============

These are the current supported sites:

-  `edX <http://edx.org>`__
-  `Stanford <http://lagunita.stanford.edu/>`__
-  `University of Sydney <http://online.it.usyd.edu.au>`__
-  `France Université
   Numérique <https://www.france-universite-numerique-mooc.fr/>`__
-  `GW Online SEAS <http://openedx.seas.gwu.edu/>`__ - George Washington
   University
-  `GW Online Open <http://mooc.online.gwu.edu/>`__ - George Washington
   University

This 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 our `issue
tracker <https://github.com/coursera-dl/edx-dl/issues>`__.

Authors
=======

See the contributors to the project in the
`AUTHORS.md <https://github.com/coursera-dl/edx-dl/blob/master/AUTHORS.md>`__
file. If you have contributed to the project, we would like to gladly
credit you for your work. Just send us a note to be added to that list.

.. |Build Status| image:: https://travis-ci.org/coursera-dl/edx-dl.svg?branch=master
   :target: https://travis-ci.org/coursera-dl/edx-dl
.. |Coverage Status| image:: https://coveralls.io/repos/coursera-dl/edx-dl/badge.svg?branch=master&service=github
   :target: https://coveralls.io/github/coursera-dl/edx-dl?branch=master
.. |Code Climate| image:: https://codeclimate.com/github/coursera-dl/edx-dl/badges/gpa.svg
   :target: https://codeclimate.com/github/coursera-dl/edx-dl
            

Raw data

            {
    "maintainer": "", 
    "docs_url": null, 
    "requires_python": "", 
    "maintainer_email": "", 
    "cheesecake_code_kwalitee_id": null, 
    "keywords": "edx-dl,edX,download,education,MOOCs,video", 
    "upload_time": "2017-07-30 07:50:58", 
    "requirements": [
        {
            "name": "beautifulsoup4", 
            "specs": [
                [
                    ">=", 
                    "4.1.3"
                ]
            ]
        }, 
        {
            "name": "html5lib", 
            "specs": [
                [
                    ">=", 
                    "1.0b2"
                ]
            ]
        }, 
        {
            "name": "six", 
            "specs": [
                [
                    ">=", 
                    "1.5.0"
                ]
            ]
        }, 
        {
            "name": "youtube_dl", 
            "specs": [
                [
                    ">=", 
                    "2015.05.20"
                ]
            ]
        }
    ], 
    "author": "Isma\u00ebl Mej\u00eda, Rog\u00e9rio Theodoro de Brito", 
    "home_page": "https://github.com/coursera-dl/edx-dl", 
    "github_user": "coursera-dl", 
    "download_url": "https://pypi.python.org/packages/72/93/7049b806dc63871b2a78edf405a485a9bcedea3a2f8e8f92e94152bf3b3c/edx-dl-0.1.5.tar.gz", 
    "platform": "any", 
    "version": "0.1.5", 
    "cheesecake_documentation_id": null, 
    "description": "|Build Status| |Coverage Status| |Code Climate|\n\nDescription\n===========\n\n``edx-dl`` is a simple tool to download videos and lecture materials\nfrom Open edX-based sites. It requires a\n`Python <https://www.python.org/>`__ interpreter (>= 2.7) and very few\nother dependencies. It is platform independent, and should work fine\nunder Unix (Linux, BSDs etc.), Windows or Mac OS X.\n\nWe strongly recommend that, if you don't already have a Python\ninterpreter installed, that you `install Python >=\n3.4 <https://www.python.org/downloads/>`__, if possible, since it has\nbetter security than Python 2.\n\nInstallation (recommended)\n==========================\n\nTo install edx-dl run:\n\n::\n\n    pip install edx-dl\n\nManual Installation\n===================\n\nTo install all the dependencies please do:\n\n::\n\n    pip install -r requirements.txt\n\nyoutube-dl\n----------\n\nOne of the most important dependencies of ``edx-dl`` is ``youtube-dl``.\nThe installation step listed above already pulls in the most recent\nversion of ``youtube-dl`` for you.\n\nUnfortunately, since many Open edX sites store their videos on Youtube\nand Youtube changes their layout from time to time, it may be necessary\nto upgrade your copy of ``youtube-dl``. There are many ways to proceed\nhere, but the simplest is to simply use:\n\n::\n\n    pip install --upgrade youtube-dl\n\nQuick Start\n===========\n\nOnce you have installed everything, to use ``edx-dl.py``, let it\ndiscover the courses in which you are enrolled, by issuing:\n\n::\n\n    edx-dl -u user@user.com --list-courses\n\nFrom there, choose the course you are interested in, copy its URL and\nuse it in the following command:\n\n::\n\n    edx-dl -u user@user.com COURSE_URL\n\nreplacing ``COURSE_URL`` with the URL that you just copied in the first\nstep. It should look something like:\nhttps://courses.edx.org/courses/edX/DemoX.1/2014/info\n\nYour downloaded videos will be placed in a new directory called\n``Downloaded``, inside your current directory, but you can also choose\nanother destination with the ``-o`` argument.\n\nTo see all available options and a brief description of what they do,\nsimply execute:\n\n::\n\n    edx-dl --help\n\n*Important Note:* To use sites other than edx.org, you have to specify\nthe site along with the ``-x`` option. For example, ``-x stanford``, if\nthe course that you want to get is hosted on Stanford's site.\n\nDocker container\n================\n\nYou can run this application via `Docker <https://docker.com>`__ if you\nwant. Just install docker and run\n\n::\n\n    docker run --rm -it \\\n           -v \"$(pwd)/edx/:/Downloaded\" \\\n           strm/edx-dl -u <USER> -p <PASSWORD>\n\nReporting issues\n================\n\nBefore reporting any issue please follow the steps below:\n\n1. Verify that you are running the latest version of all the programs\n   (both of ``edx-dl`` and of ``youtube-dl``). Use the following command\n   if in doubt:\n\n   ::\n\n       pip install --upgrade edx-dl\n\n2. If the problem persists, feel free to `open an\n   issue <https://github.com/coursera-dl/edx-dl/issues>`__ in our\n   bugtracker, please fill the issue template with *as much information\n   as possible*.\n\nSupported sites\n===============\n\nThese are the current supported sites:\n\n-  `edX <http://edx.org>`__\n-  `Stanford <http://lagunita.stanford.edu/>`__\n-  `University of Sydney <http://online.it.usyd.edu.au>`__\n-  `France Universit\u00e9\n   Num\u00e9rique <https://www.france-universite-numerique-mooc.fr/>`__\n-  `GW Online SEAS <http://openedx.seas.gwu.edu/>`__ - George Washington\n   University\n-  `GW Online Open <http://mooc.online.gwu.edu/>`__ - George Washington\n   University\n\nThis is the full `list of sites powered by Open\nedX <https://github.com/edx/edx-platform/wiki/Sites-powered-by-Open-edX>`__.\nNot all of them are supported at the moment, we welcome you to\ncontribute support for them and send a pull request also via our `issue\ntracker <https://github.com/coursera-dl/edx-dl/issues>`__.\n\nAuthors\n=======\n\nSee the contributors to the project in the\n`AUTHORS.md <https://github.com/coursera-dl/edx-dl/blob/master/AUTHORS.md>`__\nfile. If you have contributed to the project, we would like to gladly\ncredit you for your work. Just send us a note to be added to that list.\n\n.. |Build Status| image:: https://travis-ci.org/coursera-dl/edx-dl.svg?branch=master\n   :target: https://travis-ci.org/coursera-dl/edx-dl\n.. |Coverage Status| image:: https://coveralls.io/repos/coursera-dl/edx-dl/badge.svg?branch=master&service=github\n   :target: https://coveralls.io/github/coursera-dl/edx-dl?branch=master\n.. |Code Climate| image:: https://codeclimate.com/github/coursera-dl/edx-dl/badges/gpa.svg\n   :target: https://codeclimate.com/github/coursera-dl/edx-dl", 
    "tox": true, 
    "lcname": "edx-dl", 
    "bugtrack_url": null, 
    "github": true, 
    "coveralls": false, 
    "name": "edx-dl", 
    "license": "LGPL", 
    "travis_ci": true, 
    "github_project": "edx-dl", 
    "summary": "Simple tool to download video and lecture materials from edx.org.", 
    "split_keywords": [
        "edx-dl", 
        "edx", 
        "download", 
        "education", 
        "moocs", 
        "video"
    ], 
    "author_email": "iemejia@gmail.com, rbrito@ime.usp.br", 
    "urls": [
        {
            "has_sig": false, 
            "upload_time": "2017-07-30T07:50:58", 
            "comment_text": "", 
            "python_version": "source", 
            "url": "https://pypi.python.org/packages/72/93/7049b806dc63871b2a78edf405a485a9bcedea3a2f8e8f92e94152bf3b3c/edx-dl-0.1.5.tar.gz", 
            "md5_digest": "0142f69b0e5491833a31521e117398d9", 
            "downloads": 0, 
            "filename": "edx-dl-0.1.5.tar.gz", 
            "packagetype": "sdist", 
            "path": "72/93/7049b806dc63871b2a78edf405a485a9bcedea3a2f8e8f92e94152bf3b3c/edx-dl-0.1.5.tar.gz", 
            "size": 19779
        }
    ], 
    "_id": null, 
    "cheesecake_installability_id": null
}