PyKubeGrader 0.2.37__py3-none-any.whl → 0.2.39__py3-none-any.whl

{PyKubeGrader-0.2.37.dist-info → PyKubeGrader-0.2.39.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: PyKubeGrader
-Version: 0.2.37
+Version: 0.2.39
 Summary: Add a short description here!
 Home-page: https://github.com/pyscaffold/pyscaffold/
 Author: jagar2

{PyKubeGrader-0.2.37.dist-info → PyKubeGrader-0.2.39.dist-info}/RECORD

@@ -1,12 +1,13 @@
 pykubegrader/__init__.py,sha256=AoAkdfIjDDZGWLlsIRENNq06L9h46kDGBIE8vRmsCfg,311
 pykubegrader/initialize.py,sha256=Bwu1q18l18FB9lGppvt-L41D5gzr3S8t6zC0_UbrASw,3994
 pykubegrader/telemetry.py,sha256=-XiWKMlwneS4zD8-hPcMVZFY4b6gK4jHKTwhjUBw8gw,6556
-pykubegrader/utils.py,sha256=FrxuZ3gtTBTm5FQeH5c0bF9kFjA_AVtE5AYeFhzwKZ0,827
+pykubegrader/utils.py,sha256=eqQSf2xOAtqB9pWSf6RI-WwwdEowVe8yr2XIiNpc5Rc,870
 pykubegrader/validate.py,sha256=OKnItGyd-L8QPKcsE0KRuwBI_IxKiJzMLJKZiA2j3II,11184
 pykubegrader/build/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
 pykubegrader/build/api_notebook_builder.py,sha256=dlcVrGgsvxnt6GlAUN3e-FrpsPNJKXSHni1fstRCBik,20311
-pykubegrader/build/build_folder.py,sha256=5jl_TAnxfd9sqWvggJr4i3E7mrEf03cmFDotVrgTZWQ,82697
+pykubegrader/build/build_folder.py,sha256=WTdPFsV1PRJ9U_730ckcWezQfMEL2oCH4ZDoflmr30M,83138
 pykubegrader/build/clean_folder.py,sha256=dfs9NuZ-EP6q_xYQnZKH74aEafEB6hpTAZcSkY14UWI,1328
+pykubegrader/build/markdown_questions.py,sha256=OEEFoM5L4Ptax0dm8Tz-gM01akJEoDvsPNgixE1Vk1s,4675
 pykubegrader/graders/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
 pykubegrader/graders/late_assignments.py,sha256=_2-rA5RqO0BWY9WAQA_mbCxxPKTOiJOl-byD2CYWaE0,1393
 pykubegrader/log_parser/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
@@ -16,20 +17,21 @@ pykubegrader/submit/submit_assignment.py,sha256=UgJXKWw5b8-bRSFnba4iHAyXnujULHcW
 pykubegrader/tokens/tokens.py,sha256=X9f3SzrGCrAJp_BXhr6VJn5f0LxtgQ7HLPBw7zEF2BY,1198
 pykubegrader/tokens/validate_token.py,sha256=MQtgz_USvSZ9JahJ48ybjp74F5aYz64lhtvuwVc4kQw,2712
 pykubegrader/widgets/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-pykubegrader/widgets/multiple_choice.py,sha256=NjD3-uXSnibpUQ0mO3hRp_O-rynFyl0Dz6IXE4tnCRI,2078
+pykubegrader/widgets/multiple_choice.py,sha256=oH1NjL2cuQDhn-9Ds8yBNAWDHr2anGS__F8uel7IsiI,2657
+pykubegrader/widgets/question_processor.py,sha256=9mqyZVAhR65vYgGHVQZ4BVk7ksGBhNX-P3yf2Su43gI,1064
 pykubegrader/widgets/reading_question.py,sha256=y30_swHwzH8LrT8deWTnxctAAmR8BSxTlXAqMgUrAT4,3031
 pykubegrader/widgets/select_many.py,sha256=l7YQ8QT5k71j36KC1f5LmKIAX2bXpvMDGc6nqIJ1PeQ,4116
 pykubegrader/widgets/student_info.py,sha256=xhQgKehk1r5e6N_hnjAIovLdPvQju6ZqQTOiPG0aevg,3568
 pykubegrader/widgets/style.py,sha256=fVBMYy_a6Yoz21avNpiORWC3f5FD-OrVpaZ3npmunvs,1656
-pykubegrader/widgets/true_false.py,sha256=D45bjRLaAcNzsSlWPgxwTXGVZPE7PER34S30V6PjEXU,2807
+pykubegrader/widgets/true_false.py,sha256=QllIhHuJstJft_RuShkxI_fFFTaDAlzNZOFNs00HLIM,2842
 pykubegrader/widgets/types_question.py,sha256=kZdRRXyFzOtYTmGdC7XWb_2oaxqg1WSuLcQn_sTj6Qc,2300
 pykubegrader/widgets_base/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-pykubegrader/widgets_base/multi_select.py,sha256=Cl0IN21wXLZuFu-zC65aS9tD4jMfzCRJ2DPjHao5_Ak,4044
+pykubegrader/widgets_base/multi_select.py,sha256=nSK_2hDCG67Nbf00nJfabcahNnNWt8W_4Pec8tg4xAM,4182
 pykubegrader/widgets_base/reading.py,sha256=xmvN1UIXwk32v9S-JhsXwDc7axPlgpvoxSeM3II8sxY,5393
-pykubegrader/widgets_base/select.py,sha256=Fw3uFNOIWo1a3CvlzSx23bvi6bSmA3TqutuRbhD4Dp8,2525
-PyKubeGrader-0.2.37.dist-info/LICENSE.txt,sha256=YTp-Ewc8Kems8PJEE27KnBPFnZSxoWvSg7nnknzPyYw,1546
-PyKubeGrader-0.2.37.dist-info/METADATA,sha256=r05PaIWX6hTV2O04ezd46J0HI5hmutQoW0kgHARq1E8,2779
-PyKubeGrader-0.2.37.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-PyKubeGrader-0.2.37.dist-info/entry_points.txt,sha256=UPMdTT46fQwTYJWtrUwIWIbXbwyOPfNQgBFRa0frWzw,138
-PyKubeGrader-0.2.37.dist-info/top_level.txt,sha256=e550Klfze6higFxER1V62fnGOcIgiKRbsrl9CC4UdtQ,13
-PyKubeGrader-0.2.37.dist-info/RECORD,,
+pykubegrader/widgets_base/select.py,sha256=PJhBRDpAYkFnmDzvm7jxiGW1E5VcEtZBe_wEtDKs-ZQ,2662
+PyKubeGrader-0.2.39.dist-info/LICENSE.txt,sha256=YTp-Ewc8Kems8PJEE27KnBPFnZSxoWvSg7nnknzPyYw,1546
+PyKubeGrader-0.2.39.dist-info/METADATA,sha256=F69tjll_smvwuljrJ9dK4_0CFP6ECHjGORZygayRiYw,2779
+PyKubeGrader-0.2.39.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+PyKubeGrader-0.2.39.dist-info/entry_points.txt,sha256=BbLXpFZObpOXA8e3p3GcFkL-sHdUnDLUcnYmc6zx3NI,201
+PyKubeGrader-0.2.39.dist-info/top_level.txt,sha256=e550Klfze6higFxER1V62fnGOcIgiKRbsrl9CC4UdtQ,13
+PyKubeGrader-0.2.39.dist-info/RECORD,,

{PyKubeGrader-0.2.37.dist-info → PyKubeGrader-0.2.39.dist-info}/entry_points.txt

@@ -1,3 +1,4 @@
 [console_scripts]
+markdown-question = pykubegrader.build.markdown_questions:main
 otter-folder-builder = pykubegrader.build.build_folder:main
 otter-folder-cleaner = pykubegrader.build.clean_folder:main

pykubegrader/build/build_folder.py

@@ -1498,6 +1498,15 @@ def extract_TF(ipynb_file):
         return []
 
 
+def extract_question(text):
+    # Regular expression to capture the multiline title
+    match = re.search(r"###\s+(.*?)\s+####", text, re.DOTALL)
+    if match:
+        # Stripping unnecessary whitespace and asterisks
+        return match.group(1).strip().strip("**")
+    return None
+
+
 def extract_MCQ(ipynb_file):
     """
     Extracts multiple-choice questions from markdown cells within sections marked by
@@ -1552,15 +1561,18 @@ def extract_MCQ(ipynb_file):
                         1  # Increment subquestion number for each question
                     )
 
-                    # Extract question text (### heading)
-                    question_text_match = re.search(
-                        r"^###\s*\*\*(.+)\*\*", markdown_content, re.MULTILINE
-                    )
-                    question_text = (
-                        question_text_match.group(1).strip()
-                        if question_text_match
-                        else None
-                    )
+                    # # Extract question text (### heading)
+                    # question_text_match = re.search(
+                    #     r"^###\s*\*\*(.+)\*\*", markdown_content, re.MULTILINE
+                    # )
+                    # question_text = (
+                    #     question_text_match.group(1).strip()
+                    #     if question_text_match
+                    #     else None
+                    # )
+
+                    # Extract question text enable multiple lines
+                    question_text = extract_question(markdown_content)
 
                     # Extract OPTIONS (lines after #### options)
                     options_match = re.search(

pykubegrader/build/markdown_questions.py

@@ -0,0 +1,138 @@
+import argparse
+import os
+import nbformat as nbf
+
+
+class MarkdownToNotebook:
+    def __init__(self, markdown_file: str):
+        """
+        Initializes the MarkdownToNotebook converter with the Markdown file path.
+
+        Args:
+            markdown_file (str): Path to the Markdown file to convert.
+        """
+        self.markdown_file = markdown_file
+
+    def convert_and_save(self):
+        """
+        Converts the Markdown file into a Jupyter Notebook and saves it with the same name.
+        """
+        if not os.path.exists(self.markdown_file):
+            print(f"Error: File '{self.markdown_file}' does not exist.")
+            return
+
+        notebook_name = os.path.splitext(self.markdown_file)[0] + ".ipynb"
+
+        with open(self.markdown_file, "r") as f:
+            content = f.read()
+
+        # Split content into lines
+        lines = content.splitlines()
+        nb = nbf.v4.new_notebook()
+        cells = []
+        current_cell = ""
+        current_type = None
+
+        for line in lines:
+            if line.startswith("# %%"):
+                if current_cell:  # Save the previous cell
+                    if current_type == "markdown":
+                        cells.append(nbf.v4.new_markdown_cell(current_cell.strip()))
+                    elif current_type == "code":
+                        cells.append(nbf.v4.new_code_cell(current_cell.strip()))
+                    elif current_type == "raw":
+                        cells.append(nbf.v4.new_raw_cell(current_cell.strip()))
+
+                # Start a new cell
+                current_cell = ""
+                if "[markdown]" in line:
+                    current_type = "markdown"
+                elif (
+                    "# BEGIN" in line
+                    or "# END" in line
+                    or "# ASSIGNMENT CONFIG" in line
+                ):
+                    current_type = "raw"
+                else:
+                    current_type = "code"
+            else:
+                # Append lines to the current cell
+                if current_type == "markdown" and line.startswith("# "):
+                    current_cell += line[2:] + "\n"
+                else:
+                    current_cell += line + "\n"
+
+        # Save the last cell
+        if current_cell:
+            if current_type == "markdown":
+                cells.append(nbf.v4.new_markdown_cell(current_cell.strip()))
+            elif current_type == "code":
+                cells.append(nbf.v4.new_code_cell(current_cell.strip()))
+            elif current_type == "raw":
+                cell = nbf.v4.new_raw_cell(current_cell.strip())
+                cell["metadata"]["languageId"] = "raw"
+                cell["metadata"]["cell_type"] = "raw"
+                cells.append(cell)
+
+        nb["cells"] = cells
+
+        # Write the notebook
+        with open(notebook_name, "w") as f:
+            nbf.write(nb, f)
+
+        self.modify_notebook(notebook_name)
+
+        print(f"Notebook saved as: {notebook_name}")
+
+    @staticmethod
+    def modify_notebook(notebook_path: str):
+        """
+        Modifies an existing Jupyter Notebook by converting cells containing specific markers
+        ("# BEGIN T", "# END", "# ASSIGNMENT CONFIG") into raw cells.
+
+        Args:
+            notebook_path (str): Path to the existing Jupyter Notebook to modify.
+        """
+        if not os.path.exists(notebook_path):
+            print(f"Error: Notebook '{notebook_path}' does not exist.")
+            return
+
+        with open(notebook_path, "r") as f:
+            nb = nbf.read(f, as_version=4)
+
+        for cell in nb["cells"]:
+            if cell["cell_type"] == "code" and cell["source"].startswith(
+                (
+                    "# BEGIN TESTS",
+                    "# END TESTS",
+                    "# END SOLUTION",
+                    "# BEGIN QUESTION",
+                    "# ASSIGNMENT CONFIG",
+                    "# END TF",
+                    "# BEGIN TF",
+                )
+            ):
+                cell["cell_type"] = "raw"
+                if "metadata" not in cell:
+                    cell["metadata"] = {}
+                cell["metadata"] = {"vscode": {"languageId": "raw"}}
+
+        with open(notebook_path, "w") as f:
+            nbf.write(nb, f)
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        description="Convert a Markdown file with Jupyter-style cells into a Jupyter Notebook."
+    )
+    parser.add_argument(
+        "markdown_file", type=str, help="Path to the Markdown file to convert."
+    )
+
+    args = parser.parse_args()
+    converter = MarkdownToNotebook(markdown_file=args.markdown_file)
+    converter.convert_and_save()
+
+
+if __name__ == "__main__":
+    main()

pykubegrader/utils.py

@@ -15,7 +15,9 @@ def list_of_lists(options: list) -> bool:
 
 def shuffle_options(options: list[Optional[str]], seed: int) -> list[Optional[str]]:
     random.seed(seed)
-    random.shuffle(options)
+    
+    for inner_list in options:
+        random.shuffle(inner_list)
 
     return options
 

pykubegrader/widgets/multiple_choice.py

@@ -4,6 +4,7 @@ import panel as pn
 
 from ..utils import list_of_lists
 from ..widgets_base.select import SelectQuestion
+from .question_processor import process_questions_and_codes
 
 #
 # Style function
@@ -15,14 +16,22 @@ def MCQ(
     options: list[str] | list[list[str]],
     initial_vals: list[str],
 ) -> Tuple[list[pn.pane.HTML], list[pn.widgets.RadioButtonGroup]]:
-    desc_width = "350px"
 
-    desc_widgets = [
-        pn.pane.HTML(
-            f"<div style='text-align: left; width: {desc_width};'><b>{desc}</b></div>"
+    # Process descriptions through `process_questions_and_codes`
+    processed_titles, code_blocks = process_questions_and_codes(descriptions)
+
+    # Create rows for each description and its code block
+    desc_widgets = []
+    for title, code_block in zip(processed_titles, code_blocks):
+        # Create an HTML pane for the title
+        title_pane = pn.pane.HTML(
+            f"<div style='text-align: left; width: 100%;'><b>{title}</b></div>"
         )
-        for desc in descriptions
-    ]
+        # Add the title and code block in a row
+        if code_block:
+            desc_widgets.append(pn.Column(title_pane, code_block, sizing_mode="stretch_width"))
+        else:
+            desc_widgets.append(pn.Column(title_pane, sizing_mode="stretch_width"))
 
     radio_buttons = [
         pn.widgets.RadioBoxGroup(

pykubegrader/widgets/question_processor.py

@@ -0,0 +1,35 @@
+import re
+import panel as pn
+
+
+def process_questions_and_codes(titles):
+    # Ensure titles is a list
+    if isinstance(titles, str):
+        titles = [titles]
+
+    processed_titles = []
+    code_blocks = []
+
+    for title in titles:
+        # Split the title at the "```python" delimiter
+        parts = title.split("```python", maxsplit=1)
+
+        # First part is the title, stripped of leading/trailing whitespace
+        title_without_code = parts[0].strip()
+
+        # remove aberrant ** from title
+        title_without_code = title_without_code.replace("**", "")
+
+        # Second part (if exists) contains the code block; split at closing ```
+        code = parts[1].split("```", maxsplit=1)[0].strip() if len(parts) > 1 else ""
+
+        # Append processed title
+        processed_titles.append(title_without_code)
+
+        # Append code block as Markdown if it exists
+        if code:
+            code_blocks.append(pn.pane.Markdown(f"```python\n{code}\n```"))
+        else:
+            code_blocks.append(None)
+
+    return processed_titles, code_blocks

pykubegrader/widgets/true_false.py

@@ -91,4 +91,5 @@ class TFQuestion(SelectQuestion):
             options=[["True", "False"] for _ in range(len(keys))],
             descriptions=descriptions,
             points=points,
+            shuffle_answers=False,
         )

pykubegrader/widgets_base/multi_select.py

@@ -4,7 +4,7 @@ from typing import Callable, Tuple
 import panel as pn
 
 from ..telemetry import ensure_responses, score_question, update_responses
-from ..utils import shuffle_questions
+from ..utils import shuffle_questions, shuffle_options
 from ..widgets.style import drexel_colors, raw_css
 
 # Pass the custom CSS to Panel
@@ -56,6 +56,9 @@ class MultiSelectQuestion:
 
         self.initial_vals = [getattr(self, key) for key in self.keys]
 
+        # add shuffle options to multi_select.py
+        options = shuffle_options(options, seed)
+        
         description_widgets, self.widgets = style(
             descriptions, options, self.initial_vals
         )
@@ -69,12 +72,14 @@ class MultiSelectQuestion:
         question_header = pn.pane.HTML(
             f"<h2>Question {self.question_number}: {title}</h2>"
         )
+        
         question_body = pn.Column(
             *[
                 pn.Row(desc_widget, checkbox_set)
                 for desc_widget, checkbox_set in widget_pairs
             ]
         )
+    
 
         self.layout = pn.Column(question_header, question_body, self.submit_button)
 

pykubegrader/widgets_base/select.py

@@ -4,7 +4,7 @@ from typing import Callable, Tuple
 import panel as pn
 
 from ..telemetry import ensure_responses, score_question, update_responses
-from ..utils import shuffle_questions
+from ..utils import shuffle_questions, shuffle_options
 from ..widgets.style import drexel_colors
 
 # Pass custom CSS to Panel
@@ -24,6 +24,7 @@ class SelectQuestion:
         options: list,
         descriptions: list[str],
         points: int,
+        shuffle_answers: bool = True,
     ):
         responses = ensure_responses()
 
@@ -45,6 +46,9 @@ class SelectQuestion:
 
         self.initial_vals: list = [getattr(self, key) for key in self.keys]
 
+        if shuffle_answers:
+            options = shuffle_options(options, seed)
+
         desc_widgets, self.widgets = style(descriptions, options, self.initial_vals)
 
         self.submit_button = pn.widgets.Button(name="Submit", button_type="primary")