in2lambda 0.3.2__py3-none-any.whl → 0.3.3__py3-none-any.whl

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/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/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/json_convert/minimal_template.json

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

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.dist-info → in2lambda-0.3.3.dist-info}/METADATA

@@ -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.dist-info → in2lambda-0.3.3.dist-info}/RECORD

@@ -1,10 +1,13 @@
 in2lambda/__init__.py,sha256=VvbVGkrakfqTIqnYUuv95_LFxitkMODRYr161R9128U,492
 in2lambda/api/__init__.py,sha256=uh1WA1JIIYmjaWXms3JR5LOlnizv-ozW4ijBHQxi9QA,103
-in2lambda/api/module.py,sha256=YDV2NWejxg3duEzVjn6er05OiCGBihI7fUDJP16RuD0,5046
+in2lambda/api/module.py,sha256=frAU0m6dJceXiVlGKiny_1UJGowwO0Q6p6RAlKjKqME,5173
 in2lambda/api/part.py,sha256=Y-W0sd5mJQifA8V8nZNTYk_HPhxhRQq5mUCdlYKioXw,204
 in2lambda/api/question.py,sha256=is-Bmx85GFAV7Jf8mblP2ZtkDgfbRcVbMhh9Tmy2hmk,6173
 in2lambda/example_questions.tex,sha256=kvcuUUoQXTJYqrAlUMfibzGsL9qFgqbKS57JIg1YhkA,9491
 in2lambda/example_solutions.tex,sha256=0idJQV9Q8VhMO_dB5RYzYkZzyEMSA594sqnPdl4wlLA,22164
+in2lambda/figures/O2_potential.png,sha256=AxDizIID24J20wqVUAneGIN_WWr6Vfra3xoBdkgJbK0,64855
+in2lambda/figures/activated_complex.png,sha256=6AQuS6lftVMX0GkAR5WpOQnSgzvhNA3Pb2c2iteUieE,265793
+in2lambda/figures/rocket-momentum.png,sha256=EXsR7k_WehhSBfnsh4fssCTEKHpu6q3lCa4csHAFGHI,397693
 in2lambda/filters/PartPartSolSol/__init__.py,sha256=YJCnCoGJfXt7jrMdgcsEfkI7Su9WK-VOvUwwefQ8zog,124
 in2lambda/filters/PartPartSolSol/example.tex,sha256=TK4JyjYj_wFfi9bkV8uKfXdFIBYPsvgMng5x1XdE_oU,667
 in2lambda/filters/PartPartSolSol/filter.py,sha256=vttP0_RNjLuLu2GSUudzv2qk-AQHuRb172JAwf_0mmA,2383
@@ -18,18 +21,18 @@ in2lambda/filters/PartsSepSol/__init__.py,sha256=yAIUC3oJVob1R7Rrvn0sXGpK_-pXfF4
 in2lambda/filters/PartsSepSol/example.tex,sha256=w7mJIcWCqKzJE_sJG4bg0J-V9kXSfe6doKWXgTd1nF8,687
 in2lambda/filters/PartsSepSol/filter.py,sha256=9cV6HhSqOQGTk5bIS36pgBbB-5UWO3mPI2s8l9ZsNeE,3206
 in2lambda/filters/__init__.py,sha256=tla_1d85db2MAT-fgc5sNoScuYZJeTgKedzFn3NXT2c,69
-in2lambda/filters/markdown.py,sha256=FhbGHziVCHirhssCpMnSkyC0alMsOIxnInxvLMdaNek,7153
+in2lambda/filters/markdown.py,sha256=6c0Q89CCtVhJ5F7of-eueUs9WqXXhMZNFq0uZr-ZxMQ,7156
 in2lambda/json_convert/__init__.py,sha256=2X3SLn6H449zXFprtZZU7M20elsOJ09mQr7EDnv04ow,87
-in2lambda/json_convert/json_convert.py,sha256=VPigakcUYvZCm2PPRm0umrA0BIvEOFNfwl-NLfcr4lM,3625
-in2lambda/json_convert/minimal_template.json,sha256=ctwpbvOqIs_okToSCRkRB3z5CRn1GNbrUegu6PuLngM,551
+in2lambda/json_convert/json_convert.py,sha256=3C8Aa0RU1zRUXDvpvL6wV16jcGTuwVI0A1NfDcQg8fg,3662
+in2lambda/json_convert/minimal_template.json,sha256=o83cZbhabXqeJiTCkLqdhijrJiiAfv1_I6HLT_QunZ8,516
 in2lambda/katex_convert/__init__.py,sha256=D0X21-NQXNrWwu_klZeCaQaqtV9vHfFv1PlrtuVAHlI,96
 in2lambda/katex_convert/delete_list.txt,sha256=Ywx8ltUbrvSxGaQVoTSXfXAe4FfPSCuRchkSCICYjHU,1753
 in2lambda/katex_convert/katex_convert.py,sha256=3UUw84432lOBnPLJwAw68MMyFPrD6ijxyYR-qVhJhnw,4909
 in2lambda/katex_convert/replace_list.txt,sha256=y5ciG4orj64eqEKsOVaQ95Zx7Xx0y4Awa4JIS27HVSw,611
-in2lambda/main.py,sha256=RSoHtn9e1y34xHxScwjMUshrP5RAuGJayqX_WXveajA,6006
+in2lambda/main.py,sha256=IifSQfMn1ARYlrvowYYcYLGo6b5sMOxxz-nnELk56_k,7068
 in2lambda/py.typed,sha256=gN7aphE6U0Jj-OffDD7hw1OkRs9gg6OPOrVpN5eAnCA,56
-in2lambda-0.3.2.dist-info/LICENSE,sha256=vEyoprnh_ic_ZQ-woDohxEIE8GJOyXqbYZ-5cH42FG4,1072
-in2lambda-0.3.2.dist-info/METADATA,sha256=7DjyXejaoAtbgGr2kItJ-1I_5xHiNv_y8BKrOcODtCE,1833
-in2lambda-0.3.2.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-in2lambda-0.3.2.dist-info/entry_points.txt,sha256=xhkZ_lmsx7SgdhjJC-DvkFFqu-Ff-wD4Poir55bdUSM,48
-in2lambda-0.3.2.dist-info/RECORD,,
+in2lambda-0.3.3.dist-info/LICENSE,sha256=vEyoprnh_ic_ZQ-woDohxEIE8GJOyXqbYZ-5cH42FG4,1072
+in2lambda-0.3.3.dist-info/METADATA,sha256=ROh8P1bkW2CWV73U1g6zrvEhvtz5Pc_iceFsqp2e5wI,1833
+in2lambda-0.3.3.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+in2lambda-0.3.3.dist-info/entry_points.txt,sha256=xhkZ_lmsx7SgdhjJC-DvkFFqu-Ff-wD4Poir55bdUSM,48
+in2lambda-0.3.3.dist-info/RECORD,,