in2lambda 0.3.2__tar.gz → 0.3.3__tar.gz

{in2lambda-0.3.2 → in2lambda-0.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: in2lambda
-Version: 0.3.2
+Version: 0.3.3
 Summary: Converts content ready for import into Lambda Feedback
 Home-page: https://lambda-feedback.github.io/in2lambda
 License: MIT

{in2lambda-0.3.2 → in2lambda-0.3.3}/in2lambda/api/module.py

@@ -112,10 +112,13 @@ class Module:
             ...     module.to_json(temp_dir)
             ...     # Check the contents of the directory
             ...     sorted(os.listdir(temp_dir))
+            ...     # Check the contents of the set directory
+            ...     sorted(os.listdir(f"{temp_dir}/set"))
             ...     # Check the title of the first question
-            ...     with open(f"{temp_dir}/question_1/question_1.json") as file:
+            ...     with open(f"{temp_dir}/set/question_1.json") as file:
             ...         print(f"Question 1's title: {json.load(file)['title']}")
-            ['question_1', 'question_1.zip', 'question_2', 'question_2.zip']
+            ['set', 'set.zip']
+            ['media', 'question_1.json', 'question_2.json']
             Question 1's title: Question 1
 
         """

{in2lambda-0.3.2 → in2lambda-0.3.3}/in2lambda/filters/markdown.py

@@ -32,12 +32,12 @@ def image_directories(tex_file: str) -> list[str]:
         >>> temp_dir = tempfile.mkdtemp()
         >>> tex_file = os.path.join(temp_dir, 'test.tex')
         >>> with open(tex_file, 'w') as f:
-        ...     f.write("\graphicspath{{subdir1/}{subdir2/}{subdir3/}}")
+        ...     f.write("\\graphicspath{{subdir1/}{subdir2/}{subdir3/}}")
         45
         >>> image_directories(tex_file)
         ['subdir1/', 'subdir2/', 'subdir3/']
         >>> with open(tex_file, 'w') as f:
-        ...    f.write("\graphicspath{ { subdir1/ }, { subdir2/ }, { subdir3/ } }")
+        ...    f.write("\\graphicspath{ { subdir1/ }, { subdir2/ }, { subdir3/ } }")
         57
         >>> image_directories.cache_clear()
         >>> image_directories(tex_file)
@@ -78,7 +78,7 @@ def image_path(image_name: str, tex_file: str) -> Optional[str]:
         >>> temp_dir = tempfile.mkdtemp()
         >>> tex_file = os.path.join(temp_dir, 'test.tex')
         >>> with open(tex_file, 'w') as f:
-        ...     f.write("\graphicspath{{./subdir1/}{./subdir2/}{./subdir3/}}")
+        ...     f.write("\\graphicspath{{./subdir1/}{./subdir2/}{./subdir3/}}")
         51
         >>> # Example image in a relative subdirectory
         >>> sub_dir = os.path.join(temp_dir, 'subdir3')

{in2lambda-0.3.2 → in2lambda-0.3.3}/in2lambda/json_convert/json_convert.py

@@ -24,6 +24,15 @@ def converter(
     """
     # Create output by copying template
 
+    # create directory to put the questions
+    os.makedirs(output_dir, exist_ok=True)
+    output_question = os.path.join(output_dir, "set")
+    os.makedirs(output_question, exist_ok=True)
+
+    # create directory to put images - should be in set
+    output_image = os.path.join(output_question, "media")
+    os.makedirs(output_image, exist_ok=True)
+
     for i in range(len(ListQuestions)):
         output = deepcopy(template)
 
@@ -39,28 +48,20 @@ def converter(
         # add parts to the question file
         if ListQuestions[i].parts:
             output["parts"][0]["content"] = ListQuestions[i].parts[0].text
-            output["parts"][0]["workedSolution"][0]["content"] = (
+            output["parts"][0]["workedSolution"]["content"] = (
                 ListQuestions[i].parts[0].worked_solution
             )
             for j in range(1, len(ListQuestions[i].parts)):
                 output["parts"].append(deepcopy(template["parts"][0]))
                 output["parts"][j]["content"] = ListQuestions[i].parts[j].text
-                output["parts"][j]["workedSolution"][0]["content"] = (
+                output["parts"][j]["orderNumber"] = j
+                output["parts"][j]["workedSolution"]["content"] = (
                     ListQuestions[i].parts[j].worked_solution
                 )
 
         # Output file
         filename = "question_" + str(i + 1)
 
-        # create directory to put the questions
-        os.makedirs(output_dir, exist_ok=True)
-        output_question = os.path.join(output_dir, filename)
-        os.makedirs(output_question, exist_ok=True)
-
-        # create directory to put image
-        output_image = os.path.join(output_question, "media")
-        os.makedirs(output_image, exist_ok=True)
-
         # write questions into directory
         with open(f"{output_question}/{filename}.json", "w") as file:
             json.dump(output, file)

in2lambda-0.3.3/in2lambda/json_convert/minimal_template.json

@@ -0,0 +1,23 @@
+{
+  "displayFinalAnswer": true,
+  "displayStructuredTutorial": true,
+  "displayWorkedSolution": true,
+  "masterContent": "Top level question here",
+  "parts": [
+    {
+      "answer": "",
+      "content": "Part text here",
+      "orderNumber": 0,
+      "responseAreas": [],
+      "tutorial": [],
+      "universalPartId": "N/A",
+      "workedSolution": {
+        "content": "Part worked solution here",
+        "id": "N/A",
+        "title": ""
+      }
+    }
+  ],
+  "publish": false,
+  "title": "Question title here"
+}

{in2lambda-0.3.2 → in2lambda-0.3.3}/in2lambda/main.py

@@ -1,7 +1,14 @@
 """The main input for in2lambda, defining both the CLT and main library function."""
 
+# This commented block makes it run the local files rather than the pip library (I think, I don't understand it. Kevin wrote it.)
+#
+# import sys
+# import os
+# sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
+
 import importlib
 import pkgutil
+import subprocess
 from typing import Optional
 
 import panflute as pf
@@ -11,6 +18,19 @@ import in2lambda.filters
 from in2lambda.api.module import Module
 
 
+def docx_to_md(docx_file: str) -> str:
+    """Converts .docx files to markdown.
+
+    Args:
+        docx_file: A file path with the file extension included.
+
+    Returns:
+        the contents of the .docx file in markdown formatting
+    """
+    md_output = subprocess.check_output(["pandoc", docx_file, "-t", "markdown"])
+    return md_output.decode("utf-8")
+
+
 def file_type(file: str) -> str:
     """Determines which pandoc file format to use for a given file.
 
@@ -52,7 +72,7 @@ def file_type(file: str) -> str:
         ):
             return "markdown"
         case "docx":
-            return "docx"  # Pandoc doesn't seem to support doc
+            return "docx"  # Pandoc doesn't seem to support .doc, and panflute doesn't like .docx.
     raise RuntimeError(f"Unsupported file extension: .{extension}")
 
 
@@ -90,15 +110,20 @@ def runner(
     # Dynamically import the correct pandoc filter depending on the subject.
     filter_module = importlib.import_module(f"in2lambda.filters.{chosen_filter}.filter")
 
-    with open(question_file, "r", encoding="utf-8") as file:
-        text = file.read()
+    if file_type(question_file) == "docx":
+        # Convert .docx to md using Pandoc and proceed
+        text = docx_to_md(question_file)
+        input_format = "markdown"
+    else:
+        with open(question_file, "r", encoding="utf-8") as file:
+            text = file.read()
+
+        input_format = file_type(question_file)
 
     # Parse the Pandoc AST using the relevant panflute filter.
     pf.run_filter(
         filter_module.pandoc_filter,
-        doc=pf.convert_text(
-            text, input_format=file_type(question_file), standalone=True
-        ),
+        doc=pf.convert_text(text, input_format=input_format, standalone=True),
         module=module,
         tex_file=question_file,
         parsing_answers=False,
@@ -106,13 +131,20 @@ def runner(
 
     # If separate answer TeX file provided, parse that as well.
     if answer_file:
-        with open(answer_file, "r", encoding="utf-8") as file:
-            answer_text = file.read()
+
+        if file_type(answer_file) == "docx":
+
+            answer_text = docx_to_md(answer_file)
+            answer_format = "markdown"
+        else:
+            with open(answer_file, "r", encoding="utf-8") as file:
+                answer_text = file.read()
+            answer_format = file_type(answer_file)
 
         pf.run_filter(
             filter_module.pandoc_filter,
             doc=pf.convert_text(
-                answer_text, input_format=file_type(answer_file), standalone=True
+                answer_text, input_format=answer_format, standalone=True
             ),
             module=module,
             tex_file=answer_file,

{in2lambda-0.3.2 → in2lambda-0.3.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "in2lambda"
-version = "0.3.2"
+version = "0.3.3"
 description = "Converts content ready for import into Lambda Feedback"
 authors = []
 license = "MIT"

in2lambda-0.3.2/in2lambda/json_convert/minimal_template.json

@@ -1,26 +0,0 @@
-{
-  "masterContent": "Top level question here",
-  "parts": [
-    {
-      "answer": "",
-      "content": "Part text here",
-      "responseArea": [],
-      "tutorial": [],
-      "universalPartId": "N/A",
-      "workedSolution": [
-        {
-          "content": "Part worked solution here",
-          "id": "N/A",
-          "title": ""
-        }
-      ]
-    }
-  ],
-  "publish": false,
-  "questionSettings": {
-    "displayFinalAnswer": true,
-    "displayStructuredTutorial": true,
-    "displayWorkedSolution": true
-  },
-  "title": "Question title here"
-}