Updating a Canvas page via a python program

In order to add information to a Canvas page we can GET the page and then PUT the page - after adding the information that we want to add. For example, the program Download update_page_example1.py 

gets a page, then computes some statistics about the page, and then uploads a new page with this additional information. In this case we have added the computed information to a paragraph at the end of the body, this paragraph looks like:

<p class="GQMContent">{"Characters": 339, "Textatistic.counts": {"polysyblword_count": 0, "word_count": 64, "sent_count": 6, "notdalechall_count": 10, "sybl_count": 79, "char_count": 272}, "Textatistic.flesch_score": 91.58020833333336, "Junk": "Chip", "Words": 64}</p>

In this case we have used some functions within python to compute the number of words and characters, then we used functions from Erin Hengel's package Textatistic Links to an external site. to compute some statistics including the Flesch Reading Ease score. The results can be seen in the example above. Note that to use this library you need to install the python3 development files (otherwise you will find that the include file "Python.h" is not available). You can install the Textastics package with "pip3 install textatistic".

Note that if there is a paragraph whose class is "GQMContent", then the json information in this paragraph will be read in and then the newly computer information will be added to it. This way different tools can be used to add to this information, without needing to know about the previously computed information. If there is no paragraph whose class is "GQMContent", then one will be added. Moreover, if this paragraph exists its will be removed before there is any computation performed on the text of the page (by doing a deep copy of the page).

You can find the pages that was used for testing at: https://kth.instructure.com/courses/11/pages/test-page-for-updates the program was run by saying:

./update_page_example1.py 11 test-page-for-updates

The program output:

'Mon Jul 11 20:15:35 2016'
raw_text: This is a test page for updates
The goal is to see if I can access this page, then make some change to it and return it to Canvas.
Initially there are two paragraphs on this page. The second paragraph contains the word "msspelled". This is followed by a third sentence in the 2nd paragraph. I am getting hungry. It is soon dinner time.
{"Junk": "Chip", "Words": 64, "Characters": 339}
Existing information as text is {"Junk": "Chip", "Words": 64, "Characters": 339}
Existing information is {'Characters': 339, 'Junk': 'Chip', 'Words': 64}
raw_text: This is a test page for updates
The goal is to see if I can access this page, then make some change to it and return it to Canvas.
Initially there are two paragraphs on this page. The second paragraph contains the word "msspelled". This is followed by a third sentence in the 2nd paragraph. I am getting hungry. It is soon dinner time.

updated document {} b'<html><body><h2>This is a test page for updates&lt;/h2>\r\n<p>The goal is to see if I can access this page, then make some change to it and return it to Canvas.</p>\r\n<p>Initially there are two paragraphs on this page. The second paragraph contains the word "msspelled". This is followed by a third sentence in the 2nd paragraph. I am getting hungry. It is soon dinner time.</p>\r\n<p class="GQMContent">{"Characters": 339, "Textatistic.counts": {"polysyblword_count": 0, "word_count": 64, "sent_count": 6, "notdalechall_count": 10, "sybl_count": 79, "char_count": 272}, "Textatistic.flesch_score": 91.58020833333336, "Junk": "Chip", "Words": 64}</p></body></html>'
'{"title":"Test page for '
'updates","created_at":"2016-07-11T12:56:25Z","url":"test-page-for-updates","editing_roles":"teachers","page_id":370,"last_edited_by":{"id":29,"display_name":"Gerald '
'Q. Maguire Jr. '
'temp","avatar_image_url":"https://secure.gravatar.com/avatar/52e6e0ae2260166c91cd528ba0c72263?s=50\\u0026d=http%3A%2F%2Fpeople.kth.se%2F%7Emaguire%2Fmaguire-march-2004-sq.jpg","html_url":"https://kth.instructure.com/courses/11/users/29"},"published":false,"hide_from_students":true,"front_page":false,"html_url":"https://kth.instructure.com/courses/11/pages/test-page-for-updates","updated_at":"2016-07-11T18:15:36Z","locked_for_user":false,"body":"\\n\\u003Ch2\\u003EThis '
'is a test page for updates\\u003C/h2\\u003E\\r\\n\\u003Cp\\u003EThe goal is '
'to see if I can access this page, then make some change to it and return it '
'to Canvas.\\u003C/p\\u003E\\r\\n\\u003Cp\\u003EInitially there are two '
'paragraphs on this page. The second paragraph contains the word '
'\\"msspelled\\". This is followed by a third sentence in the 2nd paragraph. '
'I am getting hungry. It is soon dinner time.\\u003C/p\\u003E\\r\\n\\u003Cp '
'class=\\"GQMContent\\"\\u003E{\\"Characters\\": 339, '
'\\"Textatistic.counts\\": {\\"polysyblword_count\\": 0, \\"word_count\\": '
'64, \\"sent_count\\": 6, \\"notdalechall_count\\": 10, \\"sybl_count\\": 79, '
'\\"char_count\\": 272}, \\"Textatistic.flesch_score\\": 91.58020833333336, '
'\\"Junk\\": \\"Chip\\", \\"Words\\": 64}\\u003C/p\\u003E"}'
status code 200
True
'Mon Jul 11 20:15:36 2016' 
'\n--DONE--\n\n'