PyKubeGrader 0.1.23__py3-none-any.whl → 0.2.1__py3-none-any.whl

{PyKubeGrader-0.1.23.dist-info → PyKubeGrader-0.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyKubeGrader
-Version: 0.1.23
+Version: 0.2.1
 Summary: Add a short description here!
 Home-page: https://github.com/pyscaffold/pyscaffold/
 Author: jagar2
@@ -24,6 +24,8 @@ Requires-Dist: requests
 Requires-Dist: ruff
 Requires-Dist: setuptools
 Requires-Dist: sphinx
+Requires-Dist: types-python-dateutil
+Requires-Dist: types-pyyaml
 Requires-Dist: types-requests
 Requires-Dist: types-setuptools
 Provides-Extra: testing

{PyKubeGrader-0.1.23.dist-info → PyKubeGrader-0.2.1.dist-info}/RECORD

@@ -2,14 +2,15 @@ pykubegrader/__init__.py,sha256=AoAkdfIjDDZGWLlsIRENNq06L9h46kDGBIE8vRmsCfg,311
 pykubegrader/initialize.py,sha256=t3iSdeIcndfY8LoHBVUEZfTW6sUWHyeFLirKo4GwSQE,3328
 pykubegrader/telemetry.py,sha256=jRInaDqIpdeT7F0rxLJgO38lA-SMtmLcYE8nEAGah1Q,4922
 pykubegrader/utils.py,sha256=T3GYnLnTL9VXjTZNPr00sUgMgobQYsNTGwynMyXdvHk,696
-pykubegrader/validate.py,sha256=TEtbPOs6boyJUnoGGoe8faPdpacDLVQKEEWPr3rka1U,11026
+pykubegrader/validate.py,sha256=2KLSB3wfFZbBh1NGgmrOV073paKAgrQz4AgA6LmCIj4,11076
 pykubegrader/build/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
 pykubegrader/build/api_notebook_builder.py,sha256=FEaTj1fEsPAes7KNrPuhClEvKzLuOL3wG7Hgr7FQc-o,20083
-pykubegrader/build/build_folder.py,sha256=feP4newePStm5U6yYedoJezTtjAj-I1J4ExSGZgwpZA,66558
+pykubegrader/build/build_folder.py,sha256=e27Ni64qpgmzg4Yu94nQieyK3IflZUQ0BvEOzwMGKMU,70729
+pykubegrader/build/clean_folder.py,sha256=8N0KyL4eXRs0DCw-V_2jR9igtFs_mOFMQufdL6tD-38,1323
 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
-pykubegrader/log_parser/parse.ipynb,sha256=F3ZWi5_AOxEnSihY0VBz4jjqo0__GggjRgFvS0QCHTg,10611
+pykubegrader/log_parser/parse.ipynb,sha256=kPTo9gqhDineT7yT56P9xrQP1OKTf6Ro-iR4xlJ-or8,10610
 pykubegrader/log_parser/parse.py,sha256=uw8lxWVh0FTaWi-bVmpMBbqwTXIHlJtB9gPc1qKvm4I,7040
 pykubegrader/widgets/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
 pykubegrader/widgets/multiple_choice.py,sha256=NjD3-uXSnibpUQ0mO3hRp_O-rynFyl0Dz6IXE4tnCRI,2078
@@ -23,9 +24,9 @@ pykubegrader/widgets_base/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-
 pykubegrader/widgets_base/multi_select.py,sha256=Cl0IN21wXLZuFu-zC65aS9tD4jMfzCRJ2DPjHao5_Ak,4044
 pykubegrader/widgets_base/reading.py,sha256=_vjUPynqmJe_R4vf-7hVhGnQR726S9GL6qT8bflBXBM,5383
 pykubegrader/widgets_base/select.py,sha256=Fw3uFNOIWo1a3CvlzSx23bvi6bSmA3TqutuRbhD4Dp8,2525
-PyKubeGrader-0.1.23.dist-info/LICENSE.txt,sha256=YTp-Ewc8Kems8PJEE27KnBPFnZSxoWvSg7nnknzPyYw,1546
-PyKubeGrader-0.1.23.dist-info/METADATA,sha256=h4dCKElZvmrEDFhPykKm3cMJzdjPdCFBNXcyZ5-Fd_s,2665
-PyKubeGrader-0.1.23.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-PyKubeGrader-0.1.23.dist-info/entry_points.txt,sha256=Kd4Bh-i3hc4qlnLU1p0nc8yPw9cC5AQGOtkk2eLGnQw,78
-PyKubeGrader-0.1.23.dist-info/top_level.txt,sha256=e550Klfze6higFxER1V62fnGOcIgiKRbsrl9CC4UdtQ,13
-PyKubeGrader-0.1.23.dist-info/RECORD,,
+PyKubeGrader-0.2.1.dist-info/LICENSE.txt,sha256=YTp-Ewc8Kems8PJEE27KnBPFnZSxoWvSg7nnknzPyYw,1546
+PyKubeGrader-0.2.1.dist-info/METADATA,sha256=tY6eIv1slUtGb-qLeuoxkXxPc55sAjxqGG_f9MFf5Oo,2729
+PyKubeGrader-0.2.1.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+PyKubeGrader-0.2.1.dist-info/entry_points.txt,sha256=UPMdTT46fQwTYJWtrUwIWIbXbwyOPfNQgBFRa0frWzw,138
+PyKubeGrader-0.2.1.dist-info/top_level.txt,sha256=e550Klfze6higFxER1V62fnGOcIgiKRbsrl9CC4UdtQ,13
+PyKubeGrader-0.2.1.dist-info/RECORD,,

{PyKubeGrader-0.1.23.dist-info → PyKubeGrader-0.2.1.dist-info}/entry_points.txt

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

pykubegrader/build/build_folder.py

@@ -8,6 +8,16 @@ import shutil
 import subprocess
 import sys
 from dataclasses import dataclass, field
+from datetime import datetime
+
+import requests
+import yaml
+from dateutil import parser  # For robust datetime parsing
+
+try:
+    from pykubegrader.build.passwords import password, user
+except:  # noqa: E722
+    print("Passwords not found, cannot access database")
 
 import nbformat
 
@@ -44,8 +54,24 @@ class NotebookProcessor:
         Raises:
             OSError: If the solutions folder cannot be created due to permissions or other filesystem issues.
         """
+        if self.check_if_file_in_folder("assignment_config.yaml"):
+            # Parse the YAML content
+            with open(f"{self.root_folder}/assignment_config.yaml", "r") as file:
+                data = yaml.safe_load(file)
+                # Extract assignment details
+                assignment = data.get("assignment", {})
+                week_num = assignment.get("week")
+                self.assignment_type = assignment.get("assignment_type")
+        else:
+            self.assignment_type = self.assignment_tag.split("-")[0].lower()
+            week_num = self.assignment_tag.split("-")[-1]
+
+        self.week = f"week_{week_num}"
+
         # Define the folder to store solutions and ensure it exists
         self.solutions_folder = os.path.join(self.root_folder, "_solutions")
+        self.assignment_total_points = 0
+
         os.makedirs(
             self.solutions_folder, exist_ok=True
         )  # Create the folder if it doesn't exist
@@ -58,11 +84,6 @@ class NotebookProcessor:
             format="%(asctime)s - %(levelname)s - %(message)s",  # Log message format: timestamp, level, and message
         )
 
-        self.assignmet_type = self.assignment_tag.split("-")[0].lower()
-
-        week_num = self.assignment_tag.split("-")[-1]
-        self.week = f"week_{week_num}"
-
         # Initialize a global logger for the class
         global logger
         logger = logging.getLogger(
@@ -132,6 +153,84 @@ class NotebookProcessor:
                 self.total_point_log, json_file, indent=4
             )  # `indent=4` for pretty formatting
 
+        if self.check_if_file_in_folder("assignment_config.yaml"):
+            self.add_assignment()
+
+    def build_payload(self, yaml_content):
+        """
+        Reads YAML content for an assignment and returns Python variables.
+
+        Args:
+            yaml_content (str): The YAML file path to parse.
+
+        Returns:
+            dict: A dictionary containing the parsed assignment data.
+        """
+        # Parse the YAML content
+        with open(yaml_content, "r") as file:
+            data = yaml.safe_load(file)
+
+        # Extract assignment details
+        assignment = data.get("assignment", {})
+        week = assignment.get("week")
+        assignment_type = assignment.get("assignment_type")
+        due_date_str = assignment.get("due_date")
+
+        # Convert due_date to a datetime object if available
+        due_date = None
+        if due_date_str:
+            try:
+                due_date = parser.parse(due_date_str)  # Automatically handles timezones
+            except ValueError as e:
+                print(f"Error parsing due_date: {e}")
+
+        title = f"Week {week} - {assignment_type}"
+
+        # Return the extracted details as a dictionary
+        return {
+            "title": title,
+            "description": str(week),
+            "due_date": due_date,
+            "max_score": int(self.assignment_total_points),
+        }
+
+    def add_assignment(self):
+        """
+        Sends a POST request to add an assignment.
+        """
+        # Define the URL
+        url = "https://engr-131-api.eastus.cloudapp.azure.com/assignments"
+
+        # Build the payload
+        payload = self.build_payload(f"{self.root_folder}/assignment_config.yaml")
+
+        # Define HTTP Basic Authentication
+        auth = (user(), password())
+
+        # Define headers
+        headers = {"Content-Type": "application/json"}
+
+        # Serialize the payload with the custom JSON encoder
+        serialized_payload = json.dumps(payload, default=self.json_serial)
+
+        # Send the POST request
+        response = requests.post(
+            url, data=serialized_payload, headers=headers, auth=auth
+        )
+
+        # Print the response
+        print(f"Status Code: {response.status_code}")
+        try:
+            print(f"Response: {response.json()}")
+        except ValueError:
+            print(f"Response: {response.text}")
+
+    def check_if_file_in_folder(self, file):
+        for root, _, files in os.walk(self.root_folder):
+            if file in files:
+                return True
+        return False
+
     def _print_and_log(self, message):
         """
         Logs a message and optionally prints it to the console.
@@ -220,29 +319,42 @@ class NotebookProcessor:
         else:
             self._print_and_log(f"Notebook already in destination: {new_notebook_path}")
 
-        solution_path_1, question_path = self.multiple_choice_parser(
+        solution_path_1, question_path_1 = self.multiple_choice_parser(
             temp_notebook_path, new_notebook_path
         )
-        solution_path_2, question_path = self.true_false_parser(
+        solution_path_2, question_path_2 = self.true_false_parser(
             temp_notebook_path, new_notebook_path
         )
-        solution_path_3, question_path = self.select_many_parser(
+        solution_path_3, question_path_3 = self.select_many_parser(
             temp_notebook_path, new_notebook_path
         )
 
         if any([solution_path_1, solution_path_2, solution_path_3]) is not None:
             solution_path = solution_path_1 or solution_path_2 or solution_path_3
 
+        if any([question_path_1, question_path_2, question_path_3]) is not None:
+            question_path = question_path_1 or question_path_2 or question_path_3
+
         student_notebook, self.otter_total_points = self.free_response_parser(
             temp_notebook_path, notebook_subfolder, notebook_name
         )
 
         # If Otter does not run, move the student file to the main directory
         if student_notebook is None:
+            clean_notebook(temp_notebook_path)
             path_ = shutil.copy(temp_notebook_path, self.root_folder)
+            path_2 = shutil.move(
+                question_path,
+                os.path.join(
+                    os.path.dirname(temp_notebook_path), os.path.basename(question_path)
+                ),
+            )
             self._print_and_log(
                 f"Copied and cleaned student notebook: {path_} -> {self.root_folder}"
             )
+            self._print_and_log(
+                f"Copied Questions to: {path_2} -> {os.path.join(os.path.dirname(temp_notebook_path), os.path.basename(question_path))}"
+            )
 
         # Move the solution file to the autograder folder
         if solution_path is not None:
@@ -303,6 +415,8 @@ class NotebookProcessor:
             + self.otter_total_points
         )
 
+        self.assignment_total_points += total_points
+
         self.total_point_log.update({notebook_name: total_points})
 
     def free_response_parser(
@@ -360,11 +474,9 @@ class NotebookProcessor:
             )
 
             NotebookProcessor.add_initialization_code(
-                student_notebook, self.week, self.assignmet_type
+                student_notebook, self.week, self.assignment_type
             )
 
-            self.clean_notebook(student_notebook)
-
             NotebookProcessor.replace_temp_in_notebook(
                 student_notebook, student_notebook
             )
@@ -374,6 +486,9 @@ class NotebookProcessor:
             NotebookProcessor.replace_temp_in_notebook(
                 autograder_notebook, autograder_notebook
             )
+
+            clean_notebook(student_notebook)
+
             shutil.copy(student_notebook, self.root_folder)
             self._print_and_log(
                 f"Copied and cleaned student notebook: {student_notebook} -> {self.root_folder}"
@@ -386,10 +501,17 @@ class NotebookProcessor:
             return student_notebook, out.total_points
         else:
             NotebookProcessor.add_initialization_code(
-                temp_notebook_path, self.week, self.assignmet_type
+                temp_notebook_path, self.week, self.assignment_type
             )
             return None, 0
 
+    @staticmethod
+    def json_serial(obj):
+        """JSON serializer for objects not serializable by default."""
+        if isinstance(obj, datetime):
+            return obj.isoformat()
+        raise TypeError(f"Type {type(obj)} not serializable")
+
     @staticmethod
     def remove_assignment_config_cells(notebook_path):
         # Read the notebook
@@ -413,8 +535,8 @@ class NotebookProcessor:
         index, cell = find_first_code_cell(notebook_path)
         cell = cell["source"]
         import_text = "from pykubegrader.initialize import initialize_assignment\n"
+        import_text += f'\nresponses = initialize_assignment("{os.path.splitext(os.path.basename(notebook_path))[0]}", "{week}", "{assignment_type}" )\n'
         cell = f"{import_text}\n" + cell
-        cell += f'\nresponses = initialize_assignment("{os.path.splitext(os.path.basename(notebook_path))[0]}", "{week}", "{assignment_type}" )\n'
         replace_cell_source(notebook_path, index, cell)
 
     def multiple_choice_parser(self, temp_notebook_path, new_notebook_path):
@@ -435,15 +557,11 @@ class NotebookProcessor:
 
             data = NotebookProcessor.merge_metadata(value, data)
 
-            for data_ in data:
-                # Generate the solution file
-                self.mcq_total_points = self.generate_solution_MCQ(
-                    data_, output_file=solution_path
-                )
+            self.mcq_total_points = self.generate_solution_MCQ(
+                data, output_file=solution_path
+            )
 
-                question_path = (
-                    f"{new_notebook_path.replace(".ipynb", "")}_questions.py"
-                )
+            question_path = f"{new_notebook_path.replace(".ipynb", "")}_questions.py"
 
             generate_mcq_file(data, output_file=question_path)
 
@@ -863,13 +981,6 @@ class NotebookProcessor:
                     os.rename(old_file_path, new_file_path)
                     logging.info(f"Renamed: {old_file_path} -> {new_file_path}")
 
-    @staticmethod
-    def clean_notebook(notebook_path):
-        """
-        Cleans a Jupyter notebook to remove unwanted cells and set cell metadata.
-        """
-        clean_notebook(notebook_path)
-
 
 def extract_raw_cells(ipynb_file, heading="# BEGIN MULTIPLE CHOICE"):
     """
@@ -1444,7 +1555,7 @@ def generate_mcq_file(data_dict, output_file="mc_questions.py"):
 
     for question_dict in data_dict:
         with open(output_file, "a", encoding="utf-8") as f:
-            for i, q_value in enumerate(question_dict.values()):
+            for i, (q_key, q_value) in enumerate(question_dict.items()):
                 if i == 0:
                     # Write the MCQuestion class
                     f.write(
@@ -1460,7 +1571,7 @@ def generate_mcq_file(data_dict, output_file="mc_questions.py"):
                 break
 
             keys = []
-            for q_value in question_dict.values():
+            for i, (q_key, q_value) in enumerate(question_dict.items()):
                 # Write keys
                 keys.append(
                     f"q{q_value['question number']}-{q_value['subquestion_number']}-{q_value['name']}"
@@ -1469,20 +1580,20 @@ def generate_mcq_file(data_dict, output_file="mc_questions.py"):
             f.write(f"            keys={keys},\n")
 
             options = []
-            for q_value in question_dict.values():
+            for i, (q_key, q_value) in enumerate(question_dict.items()):
                 # Write options
                 options.append(q_value["OPTIONS"])
 
             f.write(f"            options={options},\n")
 
             descriptions = []
-            for q_value in question_dict.values():
+            for i, (q_key, q_value) in enumerate(question_dict.items()):
                 # Write descriptions
                 descriptions.append(q_value["question_text"])
             f.write(f"            descriptions={descriptions},\n")
 
             points = []
-            for q_value in question_dict.values():
+            for i, (q_key, q_value) in enumerate(question_dict.items()):
                 # Write points
                 points.append(q_value["points"])
 
@@ -1515,7 +1626,7 @@ def generate_select_many_file(data_dict, output_file="select_many_questions.py")
 
     for question_dict in data_dict:
         with open(output_file, "a", encoding="utf-8") as f:
-            for i, q_value in enumerate(question_dict.values()):
+            for i, (q_key, q_value) in enumerate(question_dict.items()):
                 if i == 0:
                     # Write the MCQuestion class
                     f.write(
@@ -1531,7 +1642,7 @@ def generate_select_many_file(data_dict, output_file="select_many_questions.py")
                 break
 
             keys = []
-            for q_value in question_dict.values():
+            for i, (q_key, q_value) in enumerate(question_dict.items()):
                 # Write keys
                 keys.append(
                     f"q{q_value['question number']}-{q_value['subquestion_number']}-{q_value['name']}"
@@ -1540,20 +1651,20 @@ def generate_select_many_file(data_dict, output_file="select_many_questions.py")
             f.write(f"            keys={keys},\n")
 
             descriptions = []
-            for q_value in question_dict.values():
+            for i, (q_key, q_value) in enumerate(question_dict.items()):
                 # Write descriptions
                 descriptions.append(q_value["question_text"])
             f.write(f"            descriptions={descriptions},\n")
 
             options = []
-            for q_value in question_dict.values():
+            for i, (q_key, q_value) in enumerate(question_dict.items()):
                 # Write options
                 options.append(q_value["OPTIONS"])
 
             f.write(f"            options={options},\n")
 
             points = []
-            for q_value in question_dict.values():
+            for i, (q_key, q_value) in enumerate(question_dict.items()):
                 # Write points
                 points.append(q_value["points"])
 
@@ -1592,7 +1703,7 @@ def generate_tf_file(data_dict, output_file="tf_questions.py"):
 
     for question_dict in data_dict:
         with open(output_file, "a", encoding="utf-8") as f:
-            for i, q_value in enumerate(question_dict.values()):
+            for i, (q_key, q_value) in enumerate(question_dict.items()):
                 if i == 0:
                     # Write the MCQuestion class
                     f.write(
@@ -1608,7 +1719,7 @@ def generate_tf_file(data_dict, output_file="tf_questions.py"):
                 break
 
             keys = []
-            for q_value in question_dict.values():
+            for i, (q_key, q_value) in enumerate(question_dict.items()):
                 # Write keys
                 keys.append(
                     f"q{q_value['question number']}-{q_value['subquestion_number']}-{q_value['name']}"
@@ -1617,13 +1728,13 @@ def generate_tf_file(data_dict, output_file="tf_questions.py"):
             f.write(f"            keys={keys},\n")
 
             descriptions = []
-            for q_value in question_dict.values():
+            for i, (q_key, q_value) in enumerate(question_dict.items()):
                 # Write descriptions
                 descriptions.append(q_value["question_text"])
             f.write(f"            descriptions={descriptions},\n")
 
             points = []
-            for q_value in question_dict.values():
+            for i, (q_key, q_value) in enumerate(question_dict.items()):
                 # Write points
                 points.append(q_value["points"])
 

pykubegrader/build/clean_folder.py

@@ -0,0 +1,45 @@
+import argparse
+import os
+import shutil
+import sys
+
+
+class FolderCleaner:
+    def __init__(self, root_folder: str):
+        """
+        Initializes the FolderCleaner with the root folder to clean.
+
+        Args:
+            root_folder (str): Path to the root folder to start cleaning.
+        """
+        self.root_folder = root_folder
+
+    def delete_dist_folders(self):
+        """
+        Recursively deletes all folders named 'dist' starting from the root folder.
+        """
+        for dirpath, dirnames, filenames in os.walk(self.root_folder, topdown=False):
+            if "dist" in dirnames:
+                dist_path = os.path.join(dirpath, "dist")
+                try:
+                    shutil.rmtree(dist_path)
+                    print(f"Deleted: {dist_path}")
+                except Exception as e:
+                    print(f"Failed to delete {dist_path}: {e}")
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        description="Recursively delete all folders named 'dist' starting from a specified root folder."
+    )
+    parser.add_argument(
+        "root_folder", type=str, help="Path to the root folder to process"
+    )
+
+    args = parser.parse_args()
+    cleaner = FolderCleaner(root_folder=args.root_folder)
+    cleaner.delete_dist_folders()
+
+
+if __name__ == "__main__":
+    sys.exit(main())

pykubegrader/log_parser/parse.ipynb

@@ -6,7 +6,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from .parse import LogParser\n",
+    "from parse import LogParser\n",
     "\n",
     "# ----------------- Example usage -----------------\n",
     "\n",

pykubegrader/validate.py

@@ -23,14 +23,16 @@ def validate_logfile(
     username: str = "student",
     password: str = "capture",
     base_url: str = "https://engr-131-api.eastus.cloudapp.azure.com",
+    key_box=None,
 ) -> None:
     login_data = {
         "username": username,
         "password": password,
     }
 
-    # Generate box from private and public keys
-    key_box = generate_keys()
+    if key_box is None:
+        # Generate box from private and public keys
+        key_box = generate_keys()
 
     decrypted_log, log_reduced = read_logfile(filepath, key_box)