A simple tool that uses the Instructure Canvas API to download part or all of your Canvas courses. Contributions welcome!
The Canvas Course Downloader takes advantage of personal API keys, which you can generate under your personal user profile settings, to access and download virtually all of the information for any enrolled or past course. This includes assignment text, submissions, module items, files, etc.
To run this program, you'll need to generate a personal API key in your user profile settings. Set the following environment variables (example values below):
CANVAS_API_URL="https://canvas.wpi.edu"
CANVAS_API_KEY="7782~pu3VLqIb0SGVlQUhEtTlf0aWMVV02Y7WSCpWIZubhlNPRUtxsqWWOKxvVAuWICNh"
This tool relies on the public Canvas API, its Python bindings, and BeautifulSoup for HTML parsing. All dependencies and
their versions are described in standard format in requirements.txt
.
This script is relatively platform-independent and was developed on Windows 10 and several Linux distros.
TODO
- How/where to download your program
- Any modifications needed to be made to files/folders
Program entrypoint is course.py,' simplest usage should work with
python3 src/course.py` assuming environment variables are set.
TODO
- How to run the program
- Step-by-step bullets
TODO Any advise for common problems or issues.
command to run if program contains helper info
Benjamin Ward @WardBenjamin
Mani Kamali @maniyar1
- 0.2 (In Progress)
- Modularized application source to separate Canvas media types
- Removed hard-coded URLs/keys/etc.
- 0.1
- Initial Release
This project is licensed under the MIT License - see the LICENSE.md file for details.