PyKubeGrader 0.0.8__py3-none-any.whl → 0.1.0__py3-none-any.whl

{PyKubeGrader-0.0.8.dist-info → PyKubeGrader-0.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyKubeGrader
-Version: 0.0.8
+Version: 0.1.0
 Summary: Add a short description here!
 Home-page: https://github.com/pyscaffold/pyscaffold/
 Author: jagar2
@@ -13,11 +13,18 @@ Classifier: Programming Language :: Python
 Description-Content-Type: text/x-rst; charset=UTF-8
 License-File: LICENSE.txt
 Requires-Dist: importlib-metadata; python_version < "3.8"
-Requires-Dist: ipython>=8.30.0
-Requires-Dist: numpy>=2.1.3
-Requires-Dist: panel>=1.5.4
-Requires-Dist: pynacl>=1.5.0
-Requires-Dist: requests>=2.32.3
+Requires-Dist: ipython
+Requires-Dist: mypy
+Requires-Dist: numpy
+Requires-Dist: panel
+Requires-Dist: pynacl
+Requires-Dist: pytest
+Requires-Dist: requests
+Requires-Dist: ruff
+Requires-Dist: setuptools
+Requires-Dist: sphinx
+Requires-Dist: types-requests
+Requires-Dist: types-setuptools
 Provides-Extra: testing
 Requires-Dist: setuptools; extra == "testing"
 Requires-Dist: pytest; extra == "testing"

PyKubeGrader-0.1.0.dist-info/RECORD

@@ -0,0 +1,20 @@
+pykubegrader/__init__.py,sha256=AoAkdfIjDDZGWLlsIRENNq06L9h46kDGBIE8vRmsCfg,311
+pykubegrader/initialize.py,sha256=PACquuxFkvOKUx51Rv6_RVu1YnYXf9L_W3hmMY5IxMw,706
+pykubegrader/telemetry.py,sha256=eAzb54-lHFcgv0IsLFwsWr4nm_D7u-n-zOdR4cKGID4,3291
+pykubegrader/utils.py,sha256=dKw6SyRYU3DWRgD3xER7wq-C9e1daWPkqr901LpcwiQ,642
+pykubegrader/validate.py,sha256=QzdsjSS7rBzvBj_s_VHk-shjkPE-NYHQrYI3UHbq7Yo,10632
+pykubegrader/widgets/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+pykubegrader/widgets/multiple_choice.py,sha256=NjD3-uXSnibpUQ0mO3hRp_O-rynFyl0Dz6IXE4tnCRI,2078
+pykubegrader/widgets/reading_question.py,sha256=y30_swHwzH8LrT8deWTnxctAAmR8BSxTlXAqMgUrAT4,3031
+pykubegrader/widgets/select_many.py,sha256=NRRs9P3Jygl9eUVW16nxMLNlHfFDuINgsFhMyXiOsXU,3826
+pykubegrader/widgets/student_info.py,sha256=xhQgKehk1r5e6N_hnjAIovLdPvQju6ZqQTOiPG0aevg,3568
+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=o9FwOSkfjarSZuC0wgBJLSRNtnY1-q_og1k_cdyJki8,3105
+pykubegrader/widgets_base/reading.py,sha256=4uTLmlPzCwxVzufFhPjM7W19uMGguRb6y4eAV3x-zAc,5314
+pykubegrader/widgets_base/select.py,sha256=5k-LoD3fTZYUOubRiTeQcVN5YDGK28x4Qb2l1aRVKzo,2181
+PyKubeGrader-0.1.0.dist-info/LICENSE.txt,sha256=YTp-Ewc8Kems8PJEE27KnBPFnZSxoWvSg7nnknzPyYw,1546
+PyKubeGrader-0.1.0.dist-info/METADATA,sha256=t6cYjeNKJkrs5UNB5-39NgdMdfGqQ6nrKsOLiFefP6E,2640
+PyKubeGrader-0.1.0.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+PyKubeGrader-0.1.0.dist-info/top_level.txt,sha256=e550Klfze6higFxER1V62fnGOcIgiKRbsrl9CC4UdtQ,13
+PyKubeGrader-0.1.0.dist-info/RECORD,,

pykubegrader/__init__.py

@@ -1,14 +1,7 @@
-import sys
-
-if sys.version_info[:2] >= (3, 8):
-    # TODO: Import directly (no need for conditional) when `python_requires = >= 3.8`
-    from importlib.metadata import PackageNotFoundError, version  # pragma: no cover
-else:
-    from importlib_metadata import PackageNotFoundError, version  # pragma: no cover
+from importlib.metadata import PackageNotFoundError, version  # pragma: no cover
 
 try:
-    # Change here if project is renamed and does not equal the package name
-    dist_name = "PyKubeGrader"
+    dist_name = "PyKubeGrader"  # Change if project is renamed
     __version__ = version(dist_name)
 except PackageNotFoundError:  # pragma: no cover
     __version__ = "unknown"

pykubegrader/initialize.py

@@ -0,0 +1,28 @@
+import json
+
+import panel as pn
+from IPython import get_ipython
+
+from .telemetry import telemetry, update_responses
+
+
+def initialize_assignment(name: str) -> None:
+    ipython = get_ipython()
+    if ipython is None:
+        print("Setup unsuccessful. Are you in a Jupyter environment?")
+        return
+
+    try:
+        ipython.events.register("pre_run_cell", telemetry)
+    except TypeError as e:
+        print(f"Failed to register telemetry: {e}")
+
+    pn.extension()
+
+    try:
+        update_responses(key="assignment", value=name)
+    except (TypeError, json.JSONDecodeError) as e:
+        print(f"Failed to initialize assignment: {e}")
+        return
+
+    print("Assignment successfully initialized")

pykubegrader/telemetry.py

@@ -10,12 +10,12 @@ from IPython.core.interactiveshell import ExecutionInfo
 from requests import Response
 from requests.auth import HTTPBasicAuth
 
+# Set logging config (`force` is important)
 logging.basicConfig(filename=".output.log", level=logging.INFO, force=True)
 
-
-def telemetry(info: ExecutionInfo) -> None:
-    cell_content = info.raw_cell
-    log_encrypted(f"code run: {cell_content}")
+#
+# Local functions
+#
 
 
 def encrypt_to_b64(message: str) -> str:
@@ -34,17 +34,6 @@ def encrypt_to_b64(message: str) -> str:
     return encrypted_b64
 
 
-def log_encrypted(message: str) -> None:
-    encrypted_b64 = encrypt_to_b64(message)
-    logging.info(f"Encrypted Output: {encrypted_b64}")
-
-
-def log_variable(value, info_type) -> None:
-    timestamp = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
-    message = f"{info_type}, {value}, {timestamp}"
-    log_encrypted(message)
-
-
 def ensure_responses() -> dict:
     with open(".responses.json", "a") as _:
         pass
@@ -61,6 +50,22 @@ def ensure_responses() -> dict:
     return data
 
 
+def log_encrypted(message: str) -> None:
+    encrypted_b64 = encrypt_to_b64(message)
+    logging.info(f"Encrypted Output: {encrypted_b64}")
+
+
+def log_variable(value, info_type) -> None:
+    timestamp = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
+    message = f"{info_type}, {value}, {timestamp}"
+    log_encrypted(message)
+
+
+def telemetry(info: ExecutionInfo) -> None:
+    cell_content = info.raw_cell
+    log_encrypted(f"code run: {cell_content}")
+
+
 def update_responses(key: str, value) -> dict:
     data = ensure_responses()
     data[key] = value
@@ -84,6 +89,11 @@ def update_responses(key: str, value) -> dict:
     return data
 
 
+#
+# API request functions
+#
+
+
 def score_question(
     student_email: str,
     term: str,

pykubegrader/validate.py

@@ -139,7 +139,7 @@ def validate_logfile(
                 return entry
         return ""
 
-    def get_len_of_entries(data, question_number) -> int:
+    def get_entries_len(data: list[str], question_number: int) -> int:
         """function to get the unique entries by length
 
         Args:
@@ -180,7 +180,7 @@ def validate_logfile(
         # Collect entries for each question in a list.
         entries = [
             entry
-            for j in range(1, get_len_of_entries(data, i))
+            for j in range(1, get_entries_len(data, i))
             if (entry := get_last_entry(data, f"q{i}_{j}")) != ""
         ]
 
@@ -246,7 +246,7 @@ def validate_logfile(
         print("Writing to results.json")
         json.dump(result_structure, file, indent=4)
 
-    login_(login_data, login_url)
+    verify_login(login_data, login_url)
 
     # The file to be uploaded. Ensure the path is correct.
     file_path = "results.json"
@@ -281,15 +281,9 @@ def validate_logfile(
     submission_message(response)
 
 
-def login_(login_data, login_url):
-    login_response = requests.post(
-        login_url, auth=HTTPBasicAuth(login_data["username"], login_data["password"])
-    )
-
-    if login_response.status_code == 200:
-        print("Login successful")
-    else:
-        Exception("Login failed")
+#
+# Helper functions
+#
 
 
 def submission_message(response) -> None:
@@ -309,3 +303,14 @@ def submission_message(response) -> None:
         pass
     else:
         print("results.json was not present")
+
+
+def verify_login(login_data, login_url):
+    login_response = requests.post(
+        login_url, auth=HTTPBasicAuth(login_data["username"], login_data["password"])
+    )
+
+    if login_response.status_code == 200:
+        print("Login successful")
+    else:
+        Exception("Login failed")

pykubegrader/widgets/__init__.py

@@ -0,0 +1 @@
+

pykubegrader/{mc_widget.py → widgets/multiple_choice.py}

@@ -2,8 +2,12 @@ from typing import Tuple
 
 import panel as pn
 
-from .misc import list_of_lists
-from .select_base import SelectQuestion
+from ..utils import list_of_lists
+from ..widgets_base.select import SelectQuestion
+
+#
+# Style function
+#
 
 
 def MCQ(
@@ -35,6 +39,11 @@ def MCQ(
     return desc_widgets, radio_buttons
 
 
+#
+# Question class
+#
+
+
 class MCQuestion(SelectQuestion):
     def __init__(
         self,

pykubegrader/{reading_widget.py → widgets/reading_question.py}

@@ -1,4 +1,4 @@
-from .reading_base import ReadingPython
+from ..widgets_base.reading import ReadingPython
 
 
 class ReadingPythonQuestion(ReadingPython):

pykubegrader/{select_many_widget.py → widgets/select_many.py}

@@ -1,6 +1,10 @@
 import panel as pn
 
-from .multi_select_base import MultiSelectQuestion
+from ..widgets_base.multi_select import MultiSelectQuestion
+
+#
+# Style function
+#
 
 
 def MultiSelect(
@@ -42,6 +46,11 @@ def MultiSelect(
     return desc_widgets, checkboxes
 
 
+#
+# Question class
+#
+
+
 class SelectMany(MultiSelectQuestion):
     def __init__(
         self,

pykubegrader/{info_widget.py → widgets/student_info.py}

@@ -5,7 +5,11 @@ import socket
 import numpy as np
 import panel as pn
 
-from .telemetry import ensure_responses, update_responses
+from ..telemetry import ensure_responses, update_responses
+
+#
+# Constants
+#
 
 EMAIL_PATTERN = re.compile(r"[a-z]+\d+@drexel\.edu")
 
@@ -20,6 +24,10 @@ KEYS = [
     "seed",
 ]
 
+#
+# Form class
+#
+
 
 class StudentInfoForm:
     def __init__(self, **kwargs) -> None:

pykubegrader/{types_widget.py → widgets/types_question.py}

@@ -2,8 +2,12 @@ from typing import Tuple
 
 import panel as pn
 
-from .misc import list_of_lists
-from .select_base import SelectQuestion
+from ..utils import list_of_lists
+from ..widgets_base.select import SelectQuestion
+
+#
+# Style function
+#
 
 
 def MultipleChoice(
@@ -31,6 +35,11 @@ def MultipleChoice(
     return desc_widgets, dropdowns
 
 
+#
+# Question class
+#
+
+
 class TypesQuestion(SelectQuestion):
     def __init__(
         self,

pykubegrader/widgets_base/__init__.py

@@ -0,0 +1 @@
+

pykubegrader/{multi_select_base.py → widgets_base/multi_select.py}

@@ -2,8 +2,8 @@ from typing import Callable, Tuple
 
 import panel as pn
 
-from .misc import shuffle_questions
-from .telemetry import ensure_responses, update_responses
+from ..telemetry import ensure_responses, update_responses
+from ..utils import shuffle_questions
 
 
 class MultiSelectQuestion:

pykubegrader/{reading_base.py → widgets_base/reading.py}

@@ -3,8 +3,8 @@ from typing import Optional
 
 import panel as pn
 
-from .misc import shuffle_options
-from .telemetry import ensure_responses, update_responses
+from ..telemetry import ensure_responses, update_responses
+from ..utils import shuffle_options
 
 
 class ReadingPython:

pykubegrader/{select_base.py → widgets_base/select.py}

@@ -2,8 +2,8 @@ from typing import Callable, Tuple
 
 import panel as pn
 
-from .misc import shuffle_questions
-from .telemetry import ensure_responses, update_responses
+from ..telemetry import ensure_responses, update_responses
+from ..utils import shuffle_questions
 
 
 class SelectQuestion:
@@ -49,7 +49,10 @@ class SelectQuestion:
 
         self.layout = pn.Column(
             f"# Question {self.question_number}: {title}",
-            *(pn.Column(desc_widget, pn.Row(dropdown)) for desc_widget, dropdown in widget_pairs),
+            *(
+                pn.Column(desc_widget, pn.Row(dropdown))
+                for desc_widget, dropdown in widget_pairs
+            ),
             self.submit_button,
         )
 

PyKubeGrader-0.0.8.dist-info/RECORD

@@ -1,19 +0,0 @@
-pykubegrader/__init__.py,sha256=JHme-EVdE2QbS9_Q2qdHiy5bEsyeQDbZ8aP2OfoSyiw,583
-pykubegrader/info_widget.py,sha256=x73heTqmqJQ9XkaE3eW4eLXTGJlmmTdGEkGtbIcY7uY,3532
-pykubegrader/mc_widget.py,sha256=_qmJ4ZvU-KXamS726LqnCgecRg29hDd7w5WOerkLvuA,2022
-pykubegrader/misc.py,sha256=dKw6SyRYU3DWRgD3xER7wq-C9e1daWPkqr901LpcwiQ,642
-pykubegrader/multi_select_base.py,sha256=GJQ-xFJTErar94cFwTxsSmLKPPmywJRUQELhAbv-uFs,3102
-pykubegrader/reading_base.py,sha256=vSoyThl2vFbnbgB_LDc-DDRPWCM2xGbazEptDjNn4uA,5311
-pykubegrader/reading_widget.py,sha256=e8lXSzGI9dHCxW7fIvwJUU6j8qWQgHnKR06ke2W1k7w,3022
-pykubegrader/select_base.py,sha256=Z-oAsNRBraqx3_T_hkSDq_quwQsZn8d8PRakI-_LUdQ,2132
-pykubegrader/select_many_widget.py,sha256=Rmb9Es42qzSdPfhU6ypcKnw_30PwuARX2UKVwgwbQhg,3772
-pykubegrader/telemetry.py,sha256=3GhItJ9dw18XcFutfQEk4z-DllCVtKXCKKLesf_jxzQ,3194
-pykubegrader/types_widget.py,sha256=FOrnR2x1eNM-pcFNIC8JnQdylgSUSUzuACmiIRuFTbQ,2244
-pykubegrader/validate.py,sha256=guEj0yeu9A_-Ig6S8diOfaNEWxud3k7t4tI-i4Steak,10585
-pykubegrader/seed/__init__.py,sha256=7Tnb4qTHPIKLirU1IJQbiiQ9FBbeGs-H5clpFS0dPEo,79
-pykubegrader/seed/hash_seed.py,sha256=tTSyYaMqgALZTNqc74IRjGN0Ii6gs4vYtRb9FavkfAM,651
-PyKubeGrader-0.0.8.dist-info/LICENSE.txt,sha256=YTp-Ewc8Kems8PJEE27KnBPFnZSxoWvSg7nnknzPyYw,1546
-PyKubeGrader-0.0.8.dist-info/METADATA,sha256=xv-9tAM6NhMoAUQ6AUK0Qh6C9f4LpBdg7X2R-T6PLb0,2505
-PyKubeGrader-0.0.8.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-PyKubeGrader-0.0.8.dist-info/top_level.txt,sha256=e550Klfze6higFxER1V62fnGOcIgiKRbsrl9CC4UdtQ,13
-PyKubeGrader-0.0.8.dist-info/RECORD,,

pykubegrader/seed/__init__.py

@@ -1,5 +0,0 @@
-# Auto-generated __init__.py
-
-from . import hash_seed
-
-__all__ = ['hash_seed']

pykubegrader/seed/hash_seed.py

@@ -1,25 +0,0 @@
-import hashlib
-
-def hash_to_seed(input_string):
-    """
-    Hash a string into a small integer seed less than 500.
-    
-    Parameters:
-        input_string (str): The string to hash.
-    
-    Returns:
-        int: A seed value (0 <= seed < 500).
-    """
-    # Ensure the input is a string
-    input_string = str(input_string)
-    
-    # Create a SHA-256 hash of the string
-    hash_object = hashlib.sha256(input_string.encode())
-    
-    # Convert the hash to an integer
-    large_number = int.from_bytes(hash_object.digest(), 'big')
-    
-    # Reduce the number to a value less than 500
-    small_seed = large_number % 500
-    
-    return small_seed