essay_grader.py

"""essay_grader.py - uses the Canvas API to download essay questions for quick grading at the command line"""

from sys import platform

import os
from canvasapi import Canvas
import canvas_lib


#determine platform to ensure env variables come from correct source
if platform == 'ios':
	import keychain
	USER_ID = int(keychain.get_password('CANVAS_USER_ID','a'))
	API_KEY = keychain.get_password('CANVAS_API_KEY','a')
	PROD_URL = keychain.get_password('CANVAS_PRODUCTION_URL','a')
	BETA_URL = keychain.get_password('CANVAS_BETA_URL','a')

if platform == 'windows' or 'win32':
	API_KEY = os.environ['CANVAS_API_KEY']
	BETA_URL = os.environ['CANVAS_BETA_URL']
	PROD_URL = os.environ['CANVAS_PRODUCTION_URL']
	USER_ID = os.environ['CANVAS_USER_ID']


def get_ungraded_assignments(courses):
	"""takes list of canvas course objects to find ones with ungraded items"""
	ungraded_items_list=[]
	list_item = 0
	
	for count, course in enumerate(courses):
		assignments = courses[count].get_assignments(bucket='ungraded')
		for assignment in assignments:
			list_item +=1
			print(str(list_item) + '. ' + course.name + ' -- ' + assignment.name)
			ungraded_items_list.append({
				'item_number':list_item,
				'course':course,
				'assignment':assignment
				})
	return ungraded_items_list

def get_submissions(course, assignment_id):
	"""gets all ungraded submissions from a Canvas assignment object"""
	
	#TODO Does this really need to be its own function?

	submissions = course.get_assignment(assignment_id).get_submissions()

	return submissions

def parse_submission(submission_object):
	"""gets key information from submission for easier processing"""

	#build dictionary with the following:
	"""
	{
		"submission_id": xxxx,
		"number_of_questions": xxxx,
		"total_points_possible": xxxx,
		"grader_id": xxxx, #will be null if ungraded - can use to filter ungraded
		"question1_response"
	}
	"""


	# TODO: The way to get all quiz responses is to get Quiz submissions: https://canvas.instructure.com/doc/api/quiz_submission_events.html
	# It isn't via assignment or quiz objects, so my original approach to getting ungraded assignments and parsing those submissions isn't going to work.

def main():
	canvas = Canvas(BETA_URL, API_KEY)
	
	global courses
	courses = canvas_lib.get_current_courses(canvas, USER_ID)
	
	#developing only code
	global submissions
	submissions = get_submissions(courses[1], 362450)
	


if __name__ == "__main__": main()