PyKubeGrader 0.1.12__py3-none-any.whl → 0.1.13__py3-none-any.whl

{PyKubeGrader-0.1.12.dist-info → PyKubeGrader-0.1.13.dist-info}/METADATA

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

{PyKubeGrader-0.1.12.dist-info → PyKubeGrader-0.1.13.dist-info}/RECORD

@@ -1,10 +1,10 @@
 pykubegrader/__init__.py,sha256=AoAkdfIjDDZGWLlsIRENNq06L9h46kDGBIE8vRmsCfg,311
-pykubegrader/initialize.py,sha256=5DiadyfFwFmqChAw8eKxryrlv0Va2ADD8JY4CJDxPAQ,1871
-pykubegrader/telemetry.py,sha256=4npUDOyGgT4_0SCXTIvHJJh6a0dlUbh1Sro1qTq1y0c,3940
+pykubegrader/initialize.py,sha256=3mz-Zv1mlmHTRNktObmOIbBRsipg16JX6wg9-_vFQe4,3043
+pykubegrader/telemetry.py,sha256=4-YdfAepiKO8y9TFoU_ktI64iFTIuKK3RcAXIz0KmP0,3972
 pykubegrader/utils.py,sha256=dKw6SyRYU3DWRgD3xER7wq-C9e1daWPkqr901LpcwiQ,642
 pykubegrader/validate.py,sha256=F0SuGGj236rFr0HFLhuF1R1whrs2vhbDrG5qu_0PojQ,10707
-pykubegrader/build/api_notebook_builder.py,sha256=G5wokv14Cr9cZQslM8_JN8e3-_z033G3IxTb9UjaJL0,19070
-pykubegrader/build/build_folder.py,sha256=yUAkxBebZMDCWEt2pF1rCjohcLxuKTW2-PJuZattqR4,64364
+pykubegrader/build/api_notebook_builder.py,sha256=DPxjBhqUmSVF3PVhvgBbZR2BaCpp6Zt9fDUFyR_CAX0,19126
+pykubegrader/build/build_folder.py,sha256=Iw20V65Eggli4noS4WaNJJcYmo185A01ofxQBtODYec,64366
 pykubegrader/widgets/__init__.py,sha256=s3ky3eJDa1RedFVdpKxmqv6mHBYpOSL9Z6qThSH9cbs,303
 pykubegrader/widgets/multiple_choice.py,sha256=NjD3-uXSnibpUQ0mO3hRp_O-rynFyl0Dz6IXE4tnCRI,2078
 pykubegrader/widgets/reading_question.py,sha256=y30_swHwzH8LrT8deWTnxctAAmR8BSxTlXAqMgUrAT4,3031
@@ -17,9 +17,9 @@ pykubegrader/widgets_base/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-
 pykubegrader/widgets_base/multi_select.py,sha256=u50IOhYxC_S_gq31VnFPLdbNajk_SUWhaqlMSJxhqVQ,3439
 pykubegrader/widgets_base/reading.py,sha256=4uTLmlPzCwxVzufFhPjM7W19uMGguRb6y4eAV3x-zAc,5314
 pykubegrader/widgets_base/select.py,sha256=h1S5StcbX8S-Wiyga4fVDhPbVvRxffwaqyVbiiuInRs,2743
-PyKubeGrader-0.1.12.dist-info/LICENSE.txt,sha256=YTp-Ewc8Kems8PJEE27KnBPFnZSxoWvSg7nnknzPyYw,1546
-PyKubeGrader-0.1.12.dist-info/METADATA,sha256=5byY9ZTimHC0GxRdmkv62YKUfj2IaCqVTpJK5vis9qA,2665
-PyKubeGrader-0.1.12.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-PyKubeGrader-0.1.12.dist-info/entry_points.txt,sha256=Kd4Bh-i3hc4qlnLU1p0nc8yPw9cC5AQGOtkk2eLGnQw,78
-PyKubeGrader-0.1.12.dist-info/top_level.txt,sha256=e550Klfze6higFxER1V62fnGOcIgiKRbsrl9CC4UdtQ,13
-PyKubeGrader-0.1.12.dist-info/RECORD,,
+PyKubeGrader-0.1.13.dist-info/LICENSE.txt,sha256=YTp-Ewc8Kems8PJEE27KnBPFnZSxoWvSg7nnknzPyYw,1546
+PyKubeGrader-0.1.13.dist-info/METADATA,sha256=GMuh1zsIM9Ft5nioXmqsLiCT9tQqdCerweyPoiq8cig,2665
+PyKubeGrader-0.1.13.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+PyKubeGrader-0.1.13.dist-info/entry_points.txt,sha256=Kd4Bh-i3hc4qlnLU1p0nc8yPw9cC5AQGOtkk2eLGnQw,78
+PyKubeGrader-0.1.13.dist-info/top_level.txt,sha256=e550Klfze6higFxER1V62fnGOcIgiKRbsrl9CC4UdtQ,13
+PyKubeGrader-0.1.13.dist-info/RECORD,,

pykubegrader/build/api_notebook_builder.py

@@ -1,12 +1,12 @@
+import ast
+import json
+import re
+import shutil
 from dataclasses import dataclass
 from pathlib import Path
 from typing import Optional
-import json
+
 import nbformat
-import json
-import re
-import shutil
-import ast
 
 
 @dataclass
@@ -76,7 +76,9 @@ class FastAPINotebookBuilder:
             )
             updated_cell_source.extend(["earned_points += score\n"])
             updated_cell_source.extend(
-                [f'log_variable(f"{{score}}, {{max_score}}", question_id)\n']
+                [
+                    f'log_variable(f"{{score}}, {{max_score}}", question_id, "{self.filename.split(".")[0]}")\n'
+                ]
             )
             updated_cell_source.extend(
                 ["os.environ['EARNED_POINTS'] = str(earned_points)\n"]
@@ -202,7 +204,7 @@ class FastAPINotebookBuilder:
             "    ensure_responses,\n",
             "    log_variable,\n",
             "    score_question,\n",
-            "    submit_question_new,\n",
+            "    submit_question,\n",
             "    telemetry,\n",
             "    update_responses,\n",
             ")\n",

pykubegrader/build/build_folder.py

@@ -8,7 +8,9 @@ import shutil
 import subprocess
 import sys
 from dataclasses import dataclass, field
+
 import nbformat
+
 from .api_notebook_builder import FastAPINotebookBuilder
 
 

pykubegrader/initialize.py

@@ -1,65 +1,106 @@
-import json
 import os
-from typing import Optional
+import shutil
+from pathlib import Path
 
 import panel as pn
-from IPython import get_ipython
 import requests
-from .telemetry import telemetry, update_responses, ensure_responses
+from IPython import get_ipython
+
+from .telemetry import ensure_responses, telemetry, update_responses
 
 
 def initialize_assignment(
     name: str,
-    verbose: Optional[bool] = False,
-    url: Optional[str] = "https://engr-131-api.eastus.cloudapp.azure.com/",
-) -> None:
+    url: str = "https://engr-131-api.eastus.cloudapp.azure.com/",
+    verbose: bool = False,
+) -> dict:
+    """
+    Initialize an assignment in a Jupyter environment.
+
+    Args:
+        name (str): The name of the assignment.
+        url (str): The URL of the API server.
+        verbose (bool): Whether to print detailed initialization information.
+
+    Returns:
+        dict: The responses dictionary after initialization.
+
+    Raises:
+        Exception: If the environment is unsupported or initialization fails.
+    """
+
     ipython = get_ipython()
     if ipython is None:
-        print("Setup unsuccessful. Are you in a Jupyter environment?")
-        return
+        raise Exception("Setup unsuccessful. Are you in a Jupyter environment?")
 
     try:
+        move_dotfiles()
         ipython.events.register("pre_run_cell", telemetry)
-    except TypeError as e:
-        print(f"Failed to register telemetry: {e}")
-        return
+    except Exception as e:
+        raise Exception(f"Failed to register telemetry: {e}")
 
     jhub_user = os.getenv("JUPYTERHUB_USER")
     if jhub_user is None:
-        print("Setup unsuccessful. Are you on JupyterHub?")
-        return
+        raise Exception("Setup unsuccessful. Are you on JupyterHub?")
 
     try:
         seed = hash(jhub_user) % 1000
         update_responses(key="seed", value=seed)
+
         update_responses(key="assignment", value=name)
         update_responses(key="jhub_user", value=jhub_user)
 
-    except (TypeError, json.JSONDecodeError) as e:
-        print(f"Failed to initialize assignment: {e}")
-        return
-
-    # extract responses
-    responses = ensure_responses()
+        responses = ensure_responses()
+        # TODO: Add more checks here?
+        assert isinstance(responses.get("seed"), int), "Seed not set"
 
-    # TODO: Add more checks here??
-    assert isinstance(responses.get("seed"), int), "valid seed not found in responses"
+        pn.extension(silent=True)
 
-    pn.extension(silent=True)
+        # Check connection to API server
+        params = {"jhub_user": responses["jhub_user"]}
+        response = requests.get(url, params=params)
+        if verbose:
+            print(f"status code: {response.status_code}")
+            data = response.json()
+            for k, v in data.items():
+                print(f"{k}: {v}")
+    except Exception as e:
+        raise Exception(f"Failed to initialize assignment: {e}")
 
+    print("Assignment successfully initialized")
     if verbose:
-        print("Assignment successfully initialized")
         print(f"Assignment: {name}")
         print(f"Username: {jhub_user}")
 
-    # Checks connectivity to the API
-    params = {"jhub_user": responses["jhub_user"]}
-    response = requests.get(url, params=params)
-    if verbose:
-        print(f"status code: {response.status_code}")
-        data = response.json()
-        for k, v in data.items():
-            print(f"{k}: {v}")
-
-    print("Assignment successfully initialized")
     return responses
+
+
+#
+# Helper functions
+#
+
+
+def move_dotfiles():
+    """
+    Move essential dotfiles from a fixed source directory to the current working directory.
+
+    Raises:
+        FileNotFoundError: If a source file is missing.
+        Exception: If copying fails for any other reason.
+    """
+    source_dir = Path("/opt/dotfiles")
+    target_dir = Path.cwd()
+
+    files_to_copy = [".client_private_key.bin", ".server_public_key.bin"]
+
+    for file_name in files_to_copy:
+        source_file = source_dir / file_name
+        target_file = target_dir / file_name
+
+        if not source_file.exists():
+            raise FileNotFoundError(f"Key file not found: {source_file}")
+
+        try:
+            shutil.copy2(source_file, target_file)
+        except Exception as e:
+            raise Exception(f"Failed to copy {source_file} to {target_file}: {e}")

pykubegrader/telemetry.py

@@ -56,9 +56,9 @@ def log_encrypted(message: str) -> None:
     logging.info(f"Encrypted Output: {encrypted_b64}")
 
 
-def log_variable(value, info_type) -> None:
+def log_variable(assignment_name, value, info_type) -> None:
     timestamp = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
-    message = f"{info_type}, {value}, {timestamp}"
+    message = f"{info_type}, {value}, {timestamp}, {assignment_name}"
     log_encrypted(message)
 
 
@@ -119,7 +119,7 @@ def score_question(
     return res
 
 
-def submit_question_new(
+def submit_question(
     student_email: str,
     term: str,
     assignment: str,