cornellGrading 2.21.0__tar.gz → 2.22.0__tar.gz

{cornellgrading-2.21.0/cornellGrading.egg-info → cornellgrading-2.22.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cornellGrading
-Version: 2.21.0
+Version: 2.22.0
 Summary: Routines for interacting with Cornell installations of Canvas and Qualtrics
 Home-page: https://github.com/dsavransky/grading
 Author: Dmitry Savransky

{cornellgrading-2.21.0 → cornellgrading-2.22.0}/cornellGrading/__init__.py

@@ -1,4 +1,4 @@
 name = "cornellGrading"
-__version__ = "2.21.0"
+__version__ = "2.22.0"
 from .cornellGrading import cornellGrading
 from .cornellQualtrics import cornellQualtrics

{cornellgrading-2.21.0 → cornellgrading-2.22.0}/cornellGrading/cornellGrading.py

@@ -2426,7 +2426,7 @@ class cornellGrading:
         return q
 
     def genNewQuizMultipleChoice(
-        self, question, options, correct_ind, points=1, position=0
+        self, question, options, correct_ind, points=1, position=0, fightml=None
     ):
         """Generate a new quiz-style multiple choice question dictionary
 
@@ -2441,6 +2441,8 @@ class cornellGrading:
                 Number of points for correct answer (defaults to 1).
             position (int):
                 Position of question in quiz.  Defaults to 0
+            fightml (str, optional):
+                HTML string from figure upload. Defaults to None.
 
         Returns:
             dict:
@@ -2462,6 +2464,10 @@ class cornellGrading:
                 }
             )
 
+        qtxt = f"<p>{convalllatex(question)}</p>"
+        if fightml is not None:
+            qtxt = f"{qtxt}\n<p>{fightml}</p>"
+
         q = {
             "position": position,
             "points_possible": float(points),
@@ -2472,7 +2478,7 @@ class cornellGrading:
             "status": "mutable",
             "entry": {
                 "title": question,
-                "item_body": f"<p>{convalllatex(question)}</p>",
+                "item_body": qtxt,
                 "calculator_type": "none",
                 "interaction_data": {"choices": choices},
                 "properties": {
@@ -2604,27 +2610,34 @@ class cornellGrading:
             # process figure (if any)
             if not (pandas.isna(row.Figure)):
                 impath = os.path.join(imagePath, f"{row.Figure}.png")
-                assert os.path.exists(impath), f"Can not locate {impath}."
-                status, fig = figFolder.upload(impath)
-                assert status, f"Failed to upload {impath}."
+                fightml = self.uploadFigure(impath, figFolder)
             else:
-                fig = None
+                fightml = None
 
             # create and add the question depending on quiz type
             if isinstance(quiz, canvasapi.new_quiz.NewQuiz):
                 q = self.genNewQuizMultipleChoice(
-                    question, opts.astype(str), correct_ind, position=k + 1, fig=fig
+                    question,
+                    opts.astype(str),
+                    correct_ind,
+                    position=k + 1,
+                    fightml=fightml,
                 )
 
                 self.addNewQuizItem(quiz.id, q)
             else:
                 q = self.genQuizMultipleChoice(
-                    question, opts.astype(str), correct_ind, position=k + 1, fig=fig
+                    question,
+                    opts.astype(str),
+                    correct_ind,
+                    position=k + 1,
+                    fightml=fightml,
                 )
                 quiz.create_question(question=q)
 
     def uploadFigure(self, impath, figFolder):
-        """Upload a figure and generate an HTML string for embedding it
+        """Upload a figure and generate an HTML string for embedding it. If filename
+        already exists in the folder, use that rather than overwriting.
 
         Args:
             impath (str):
@@ -2637,9 +2650,22 @@ class cornellGrading:
                 HTML string representing the figure
         """
 
-        assert os.path.exists(impath), f"Can not locate {impath}."
-        status, fig = figFolder.upload(impath)
-        assert status, f"Failed to upload {impath}."
+        filename = os.path.split(impath)[-1]
+        haveFile = False
+        for file in figFolder.get_files():
+            if file.filename == filename:
+                haveFile = True
+                fig = {
+                    "id": file.id,
+                    "uuid": file.uuid,
+                    "display_name": file.display_name,
+                }
+                break
+
+        if not haveFile:
+            assert os.path.exists(impath), f"Can not locate {impath}."
+            status, fig = figFolder.upload(impath)
+            assert status, f"Failed to upload {impath}."
 
         figsrc = (
             f"{self.canvas._Canvas__requester.original_url}/courses/"

{cornellgrading-2.21.0 → cornellgrading-2.22.0}/cornellGrading/cornellQualtrics.py

@@ -690,6 +690,79 @@ class cornellQualtrics:
 
         return response.json()["result"]
 
+    def exportUploadedFiles(self, surveyId, DataExportTags, saveDir=None):
+        """Download all user uploaded files associated with specific questions from one
+        survey
+
+        Args:
+            surveyId (str):
+                Unique id string of survey.  Get either from web interface or via
+                getSurveyId
+            DataExportTags (list):
+                Data Export Tags for all questions with uploaded files
+            saveDir (str, optional):
+                Full path to save location.  If None (default) uses system tmp dir
+
+        Returns:
+            str:
+                Full path to directory where the survey results and all files are saved.
+                The survey results will be a CSV file with a filename that is the same
+                as the survey name, except with any colons replaced with underscores.
+                The files will be named as: ResponseId-FileId-fileName where ResponseId
+                and FileId match the entries in the survey results and fileName is the
+                original fileName of the upload.
+
+        Notes:
+            https://api.qualtrics.com/1071635f5a615-retrieve-a-user-uploaded-file
+
+        """
+
+        # get survey name from ID
+        if surveyId not in self.surveyIds:
+            self.listSurveys()
+            assert surveyId in self.surveyIds, f"Survey ID {surveyId} not found."
+
+        surveyname = self.surveyNames[self.surveyIds == surveyId][0]
+
+        # synthesize base URL
+        baseUrl = (
+            f"https://{self.dataCenter}{self.qualtricsapi}surveys/{surveyId}/responses/"
+        )
+
+        # export survey results and read output
+        tmpdir = self.exportSurvey(surveyId, saveDir=saveDir)
+        if ":" in surveyname:
+            surveyname = surveyname.replace(":", "_")
+        surveyfile = os.path.join(tmpdir, surveyname + ".csv")
+        assert os.path.isfile(surveyfile), "Survey results not where expected."
+        surveyres = pandas.read_csv(surveyfile, header=[0, 1, 2])
+
+        # get all response IDs
+        responseIds = surveyres["ResponseId"].values.flatten()
+
+        # loop through each data export tag and download the associated file for each
+        # response
+        for DataExportTag in DataExportTags:
+            # get all ids and filenames for current tag
+            fids = surveyres[f"{DataExportTag}_Id"].values.flatten()
+            fnames = surveyres[f"{DataExportTag}_Name"].values.flatten()
+
+            # loop through everything
+            for rid, fid, fname in zip(responseIds, fids, fnames):
+                durl = f"{baseUrl}{rid}/uploaded-files/{fid}"
+                requestDownload = requests.request(
+                    "GET", durl, headers=self.headers_post, stream=True
+                )
+                assert (
+                    requestDownload.status_code == 200
+                ), f"Download failed for file {fid} on response {rid}."
+
+                outname = os.path.join(tmpdir, f"{rid}-{fid}-{fname}")
+                with open(outname, "wb") as ff:
+                    ff.write(requestDownload.content)
+
+        return tmpdir
+
     def exportSurvey(self, surveyId, fileFormat="csv", useLabels="true", saveDir=None):
         """Download and extract survey results
 
@@ -701,7 +774,7 @@ class cornellQualtrics:
                 Format to download (must be csv, tsv, or spss)
             useLabels (str):
                 Use choice labels ("true" or "false", defaults "true")
-            saveDir (str):
+            saveDir (str, optional):
                 Full path to save location.  If None (default) uses system tmp dir
 
         Returns:

{cornellgrading-2.21.0 → cornellgrading-2.22.0/cornellGrading.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cornellGrading
-Version: 2.21.0
+Version: 2.22.0
 Summary: Routines for interacting with Cornell installations of Canvas and Qualtrics
 Home-page: https://github.com/dsavransky/grading
 Author: Dmitry Savransky