PyKubeGrader 0.2.20__py3-none-any.whl → 0.2.22__py3-none-any.whl

{PyKubeGrader-0.2.20.dist-info → PyKubeGrader-0.2.22.dist-info}/METADATA

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

{PyKubeGrader-0.2.20.dist-info → PyKubeGrader-0.2.22.dist-info}/RECORD

@@ -4,8 +4,8 @@ pykubegrader/telemetry.py,sha256=h8PPrXWGFgPWCcrChJo2woqd_XIPMFfYcxgLJ0CWpH8,536
 pykubegrader/utils.py,sha256=T3GYnLnTL9VXjTZNPr00sUgMgobQYsNTGwynMyXdvHk,696
 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=8RTyr6nTHAzbHGPqb9zcQmenOgPdF78ylPG6IRAfl3c,79735
+pykubegrader/build/api_notebook_builder.py,sha256=IzzU_jh6SYSA2wtjtlhxa4t9WM8-JqWnWsV8e3UPwdo,20305
+pykubegrader/build/build_folder.py,sha256=y5hrxkZgqVr0MRXL3AkihaJQmtm70F4umyVT8--uYTk,81820
 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
@@ -14,7 +14,7 @@ pykubegrader/log_parser/parse.ipynb,sha256=H1CUuqiUSE-tiZV1IS7VG6HAEvoopGd6i_5QM
 pykubegrader/log_parser/parse.py,sha256=YCs_OCnoxQKsL55MjTZWXBBBsehJL8PIB9ANnC-aE44,7379
 pykubegrader/submit/submit_assignment.py,sha256=p-v31479342q0AO3lJrd8Fwk7iJQUz183OeGeiNcXOY,3405
 pykubegrader/tokens/tokens.py,sha256=DorNwdrA5N5apB3LQjVGa2ABN5C1upkgglecaLHobr0,1260
-pykubegrader/tokens/validate_token.py,sha256=zsELkJg1ll_3dWF1auuFVqh3N84vTZ8RIfk71edL360,3836
+pykubegrader/tokens/validate_token.py,sha256=q5aJ0hUsFTDgrSfAszPS5RpxwTKODAguFqkZkKjkN3k,4058
 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
@@ -27,9 +27,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.2.20.dist-info/LICENSE.txt,sha256=YTp-Ewc8Kems8PJEE27KnBPFnZSxoWvSg7nnknzPyYw,1546
-PyKubeGrader-0.2.20.dist-info/METADATA,sha256=ukDi7JVBIA2MSzOVLFkd2zqqgI_c7k-GQNLqCM3VflE,2779
-PyKubeGrader-0.2.20.dist-info/WHEEL,sha256=A3WOREP4zgxI0fKrHUG8DC8013e3dK3n7a6HDbcEIwE,91
-PyKubeGrader-0.2.20.dist-info/entry_points.txt,sha256=UPMdTT46fQwTYJWtrUwIWIbXbwyOPfNQgBFRa0frWzw,138
-PyKubeGrader-0.2.20.dist-info/top_level.txt,sha256=e550Klfze6higFxER1V62fnGOcIgiKRbsrl9CC4UdtQ,13
-PyKubeGrader-0.2.20.dist-info/RECORD,,
+PyKubeGrader-0.2.22.dist-info/LICENSE.txt,sha256=YTp-Ewc8Kems8PJEE27KnBPFnZSxoWvSg7nnknzPyYw,1546
+PyKubeGrader-0.2.22.dist-info/METADATA,sha256=dPgcV3VFD4CAMAFJ2kQR8dw3ZY9wu1qls8k5gstiKJw,2779
+PyKubeGrader-0.2.22.dist-info/WHEEL,sha256=A3WOREP4zgxI0fKrHUG8DC8013e3dK3n7a6HDbcEIwE,91
+PyKubeGrader-0.2.22.dist-info/entry_points.txt,sha256=UPMdTT46fQwTYJWtrUwIWIbXbwyOPfNQgBFRa0frWzw,138
+PyKubeGrader-0.2.22.dist-info/top_level.txt,sha256=e550Klfze6higFxER1V62fnGOcIgiKRbsrl9CC4UdtQ,13
+PyKubeGrader-0.2.22.dist-info/RECORD,,

pykubegrader/build/api_notebook_builder.py

@@ -14,6 +14,7 @@ class FastAPINotebookBuilder:
     notebook_path: str
     temp_notebook: Optional[str] = None
     assignment_tag: Optional[str] = ""
+    require_key: Optional[bool] = False
 
     def __post_init__(self):
         self.root_path, self.filename = FastAPINotebookBuilder.get_filename_and_root(
@@ -119,6 +120,11 @@ class FastAPINotebookBuilder:
             f"os.environ['TOTAL_POINTS_FREE_RESPONSE'] = str({self.total_points})\n"
         )
 
+        if self.require_key:
+            first_cell_header.append(
+                "from pykubegrader.tokens.validate_token import validate_token\nvalidate_token()\n"
+            )
+
         short_filename = self.filename.split(".")[0].replace("_temp", "")
         first_cell_header.extend(
             [

pykubegrader/build/build_folder.py

@@ -28,6 +28,19 @@ from .api_notebook_builder import FastAPINotebookBuilder
 from typing import Optional
 
 
+import os
+
+os.environ["JUPYTERHUB_USER"] = "jca92"
+os.environ["TOKEN"] = "token"
+os.environ["DB_URL"] = "https://engr-131-api.eastus.cloudapp.azure.com/"
+os.environ["keys_student"] = "capture"
+os.environ["user_name_student"] = "student"
+
+from pykubegrader.tokens.tokens import add_token
+
+add_token("token", duration=20)
+
+
 @dataclass
 class NotebookProcessor:
     """
@@ -46,6 +59,7 @@ class NotebookProcessor:
     solutions_folder: str = field(init=False)
     verbose: bool = False
     log: bool = True
+    require_key: bool = False
 
     def __post_init__(self):
         """
@@ -559,11 +573,22 @@ class NotebookProcessor:
             "you should see your score."
         )
 
-        # Define the Code cell
-        code_cell = nbformat.v4.new_code_cell(
-            "from pykubegrader.submit.submit_assignment import submit_assignment\n\n"
-            f'submit_assignment("week{self.week_num}-{self.assignment_type}", "{os.path.basename(notebook_path).replace(".ipynb", "")}")'
-        )
+        if self.require_key:
+            # Add an additional line for validate_token()
+            validate_token_line = "from pykubegrader.submit.submit_assignment import validate_token\nvalidate_token()\n"
+
+            # Define the Code cell
+            code_cell = nbformat.v4.new_code_cell(
+                f"{validate_token_line}\n\n"  # Add the validate_token() line
+                "from pykubegrader.submit.submit_assignment import submit_assignment\n\n"
+                f'submit_assignment("week{self.week_num}-{self.assignment_type}", "{os.path.basename(notebook_path).replace(".ipynb", "")}")'
+            )
+        else:
+            # Define the Code cell without validate_token()
+            code_cell = nbformat.v4.new_code_cell(
+                "from pykubegrader.submit.submit_assignment import submit_assignment\n\n"
+                f'submit_assignment("week{self.week_num}-{self.assignment_type}", "{os.path.basename(notebook_path).replace(".ipynb", "")}")'
+            )
 
         # Make the code cell non-editable and non-deletable
         code_cell.metadata = {"editable": False, "deletable": False}
@@ -607,7 +632,9 @@ class NotebookProcessor:
             shutil.copy("./keys/.server_public_key.bin", server_public_key)
 
             out = FastAPINotebookBuilder(
-                notebook_path=temp_notebook_path, assignment_tag=self.assignment_tag
+                notebook_path=temp_notebook_path,
+                assignment_tag=self.assignment_tag,
+                require_key=self.require_key,
             )
 
             debug_notebook = os.path.join(
@@ -632,7 +659,10 @@ class NotebookProcessor:
             )
 
             NotebookProcessor.add_initialization_code(
-                student_notebook, self.week, self.assignment_type
+                student_notebook,
+                self.week,
+                self.assignment_type,
+                require_key=self.require_key,
             )
 
             NotebookProcessor.replace_temp_in_notebook(
@@ -659,7 +689,10 @@ class NotebookProcessor:
             return student_notebook, out.total_points
         else:
             NotebookProcessor.add_initialization_code(
-                temp_notebook_path, self.week, self.assignment_type
+                temp_notebook_path,
+                self.week,
+                self.assignment_type,
+                require_key=self.require_key,
             )
             NotebookProcessor.replace_temp_no_otter(
                 temp_notebook_path, temp_notebook_path
@@ -691,11 +724,19 @@ class NotebookProcessor:
             nbformat.write(notebook, f)
 
     @staticmethod
-    def add_initialization_code(notebook_path, week, assignment_type):
+    def add_initialization_code(
+        notebook_path, week, assignment_type, require_key=False
+    ):
         # finds the first code cell
         index, cell = find_first_code_cell(notebook_path)
         cell = cell["source"]
-        import_text = "from pykubegrader.initialize import initialize_assignment\n"
+        import_text = "# You must make sure to run all cells in sequence using shift + enter or you might encounter errors\n"
+        import_text += "from pykubegrader.initialize import initialize_assignment\n"
+        if require_key:
+            import_text += (
+                "from pykubegrader.token.validate_token import validate_token\n"
+            )
+            import_text += "validate_token('type the key provided by your TA here')\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
         replace_cell_source(notebook_path, index, cell)
@@ -1740,7 +1781,9 @@ def generate_mcq_file(data_dict, output_file="mc_questions.py"):
                     )
                     f.write("    def __init__(self):\n")
                     f.write("        super().__init__(\n")
-                    f.write(f'            title=f"{q_value['question_text']}",\n')
+                    f.write(
+                        f'            title=f"Question{q_value['question number']}: {q_value['title']}",\n'
+                    )
                     f.write("            style=MCQ,\n")
                     f.write(
                         f"            question_number={q_value['question number']},\n"
@@ -1811,7 +1854,9 @@ def generate_select_many_file(data_dict, output_file="select_many_questions.py")
                     )
                     f.write("    def __init__(self):\n")
                     f.write("        super().__init__(\n")
-                    f.write(f'            title=f"{q_value['question_text']}",\n')
+                    f.write(
+                        f'            title=f"Question{q_value['question number']}: {q_value['title']}",\n'
+                    )
                     f.write("            style=MultiSelect,\n")
                     f.write(
                         f"            question_number={q_value['question number']},\n"
@@ -1888,7 +1933,9 @@ def generate_tf_file(data_dict, output_file="tf_questions.py"):
                     )
                     f.write("    def __init__(self):\n")
                     f.write("        super().__init__(\n")
-                    f.write(f'            title=f"{q_value['question_text']}",\n')
+                    f.write(
+                        f'            title=f"Question{q_value['question number']}: {q_value['title']}",\n'
+                    )
                     f.write("            style=TFStyle,\n")
                     f.write(
                         f"            question_number={q_value['question number']},\n"
@@ -2060,9 +2107,18 @@ def main():
         default="Reading-Week-X",
     )
 
+    parser.add_argument(
+        "--require-key",
+        type=bool,
+        help="Require a key to be generated for the assignment",
+        default=False,
+    )
+
     args = parser.parse_args()
     processor = NotebookProcessor(
-        root_folder=args.root_folder, assignment_tag=args.assignment_tag
+        root_folder=args.root_folder,
+        assignment_tag=args.assignment_tag,
+        require_key=args.require_key,
     )
     processor.process_notebooks()
 

pykubegrader/tokens/validate_token.py

@@ -39,7 +39,7 @@ def get_credentials():
     return {"username": username, "password": password}
 
 
-async def async_validate_token(token: str) -> None:
+async def async_validate_token(token: str = None) -> None:
     """
     Asynchronously validate a token by making a GET request to the validation endpoint.
 
@@ -52,6 +52,16 @@ async def async_validate_token(token: str) -> None:
     Returns:
         None: If the token is valid, the function will pass silently.
     """
+
+    if token is not None:
+        os.environ["TOKEN"] = token
+
+    if token is None:
+        token = os.getenv("TOKEN", None)
+
+    if token is None:
+        raise TokenValidationError("No token provided")
+
     # Fetch the endpoint URL
     base_url = os.getenv("DB_URL")
     if not base_url:
@@ -93,7 +103,7 @@ async def async_validate_token(token: str) -> None:
             raise TokenValidationError(f"An unexpected error occurred: {e}")
 
 
-def validate_token(token: str) -> None:
+def validate_token(token: str = None) -> None:
     """
     Synchronous wrapper for the `async_validate_token` function.
 
@@ -106,6 +116,7 @@ def validate_token(token: str) -> None:
     Returns:
         None: If the token is valid, the function will pass silently.
     """
+
     # Get the current event loop or create one
     try:
         loop = asyncio.get_event_loop()