update readme

.gitignore

@@ -1,3 +1,4 @@
+output/
 credentials.yaml
 cookies*.txt
 

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 David Katsandres
+Copyright (c) 2019 David Katsandres, Cyberes
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,84 +1,54 @@
 # 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:
+The tool exports all of the following data for each course:
-- Course Assignments
-- Course Announcements
-- Course Discussions
-- Course Pages
-- Course Files
-- Course Modules
-- SingleFile HTML of Assignments, Announcements, Discussions, Modules
 
+- Assignments
+- Announcements
+- Discussions
+- Pages
+- Files
+- Modules
+- Single file webpage of the Canvas page for assignments, announcements, discussions, and modules
 
-The tool will export your data in JSON format, and will organize it nicely into folders named for every term of every year.
+Your data in will be exported in JSON format and organized into folders per term.
-Example:
-- Fall 2013
-  - Econ 101
-    - course files
-    - modules
-    - Econ 101.json
-  - English 101
-    - course files
-    - modules
-    - English 101.json
-- Fall 2014
-- Fall 2015
-- Fall 2016
-- Spring 2014
-- Spring 2015
-- Spring 2016
-- Spring 2017
-- Winter 2014
-- Winter 2015
-- Winter 2016
-- Winter 2017
-- all_output.json
 
-# Getting Started
+## Install
 
-## Dependencies
+```shell
-To run the program, you will need the following dependencies:  
+pip install -r requirements.txt
-`pip install requests`  
+npm install
-`pip install jsonpickle`  
-`pip install canvasapi`  
-`pip install python-dateutil`  
-`pip install PyYAML`
-
-`npm i github:gildas-lormeau/SingleFile`
-
-You can install these dependencies using
-`pip install -r requirements.txt` 
-AND
-`npm i`
-
-Then run from the command line:
-`python export.py`
-
-## Configuration
-These are the configuration parameters for the program:
-- Canvas API URL - this is the URL of your institution, for example `https://example.instructure.com`
-- Canvas API key - this can be created by going to Canvas and navigating to `Account` > `Settings` > `Approved Integrations` > `New Access Token`
-- Canvas User ID - this can be found at `https://example.instructure.com/api/v1/users/self` in the `id` field
-- Path to Cookies File - file needs to be in netscape format, you can get your cookies via a tool like "Get cookies.txt Clean" on chrome. This can also be left blank if an html images are unwanted.
-- Directory in which to download course information to (will be created if not present)
-- List of Course IDs that should be skipped
-
-If single file fails to find your browser, you can set a path in singlefile.py. If you also want to run additional singlefile arguments that can also be done there.
-
-### Loading credentials from a file
-To avoid manually entering credentials every time you run the program, you can create a `credentials.yaml` file in the same directory as the script that has the following fields:
-
-```yaml
-API_URL: < URL of your institution >
-API_KEY: < API Key from Canvas >
-USER_ID: < User ID from Canvas >
-COOKIES_PATH: < Path to cookies file >
 ```
 
-You can then run the script as normal:
+## Run
-`python export.py`
 
-# Contribute
+1. Get your Canvas API key by going to Canvas and navigating to `Account` > `Settings` > `Approved Integrations` > `New Access Token`
-I would love to see this script's functionality expanded and improved! I welcome all pull requests :) Thank you!
+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:
+
+```yaml
+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`.
+
+<br>
+
+Now, run the program:
+
+```shell
+python export.py
+```