canvas-student-data-export/README.md

1.4 KiB

Introduction

Forked from https://github.com/davekats/canvas-student-data-export

Major rewrite and improvement.


The Canvas Student Data Export Tool can export nearly all of a student's data from Instructure Canvas Learning Management System (Canvas LMS). This is useful when you are graduating or leaving your college or university, and would like to have a backup of all the data you had in canvas.

The tool exports all of the following data for each course:

  • Assignments
  • Announcements
  • Discussions
  • Pages
  • Files
  • Modules
  • Single file webpage of the Canvas page for assignments, announcements, discussions, and modules

Your data in will be exported in JSON format and organized into folders per term.

Install

pip install -r requirements.txt
npm install

Run

  1. Get your Canvas API key by going to Canvas and navigating to Account > Settings > Approved Integrations > New Access Token
  2. Get your Canvas User ID at https://example.instructure.com/api/v1/users/self in the id field
  3. Save your cookies for your Canvas domain

Then, create the file credentials.yaml with the following content:

API_URL: [ base Canvas URL of your institution ]
API_KEY: [ API Key from Canvas ]
USER_ID: [ user ID from Canvas ]
COOKIES_PATH: [ path to cookies file ]

Make credentials.yaml is in the same directory as export.py.


Now, run the program:

python export.py