PyKubeGrader 0.2.19__tar.gz → 0.2.21__tar.gz

{pykubegrader-0.2.19/src/PyKubeGrader.egg-info → pykubegrader-0.2.21}/PKG-INFO

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

{pykubegrader-0.2.19 → pykubegrader-0.2.21/src/PyKubeGrader.egg-info}/PKG-INFO

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

{pykubegrader-0.2.19 → pykubegrader-0.2.21}/src/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.submit.submit_assignment import validate_token\nvalidate_token()\n"
+            )
+
         short_filename = self.filename.split(".")[0].replace("_temp", "")
         first_cell_header.extend(
             [

{pykubegrader-0.2.19 → pykubegrader-0.2.21}/src/pykubegrader/build/build_folder.py

@@ -46,6 +46,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 +560,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 +619,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 +646,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 +676,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 +711,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 +1768,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 +1841,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 +1920,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 +2094,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-0.2.21/src/pykubegrader/tokens/validate_token.py

@@ -0,0 +1,138 @@
+import os
+import base64
+import httpx
+import asyncio
+import nest_asyncio
+
+# Apply nest_asyncio for environments like Jupyter
+nest_asyncio.apply()
+
+
+class TokenValidationError(Exception):
+    """
+    Custom exception raised when the token validation fails.
+    """
+
+    def __init__(self, message=None):
+        """
+        Initialize the exception with an optional message.
+
+        Args:
+            message (str, optional): The error message to display. Defaults to None.
+        """
+        super().__init__(message)
+
+
+def get_credentials():
+    """
+    Fetch the username and password from environment variables.
+
+    Returns:
+        dict: A dictionary containing 'username' and 'password'.
+    """
+    username = os.getenv("user_name_student")
+    password = os.getenv("keys_student")
+    if not username or not password:
+        raise ValueError(
+            "Environment variables 'user_name_student' or 'keys_student' are not set."
+        )
+    return {"username": username, "password": password}
+
+
+async def async_validate_token(token: str) -> None:
+    """
+    Asynchronously validate a token by making a GET request to the validation endpoint.
+
+    Args:
+        token (str): The token to validate.
+
+    Raises:
+        TokenValidationError: If the token is invalid or if there is an error in the validation process.
+
+    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:
+        raise ValueError("Environment variable 'DB_URL' is not set.")
+    endpoint = f"{base_url}validate-token/{token}"
+
+    # Get credentials
+    credentials = get_credentials()
+    username = credentials["username"]
+    password = credentials["password"]
+
+    # Encode credentials for Basic Authentication
+    auth_header = (
+        f"Basic {base64.b64encode(f'{username}:{password}'.encode()).decode()}"
+    )
+
+    # Make the GET request
+    async with httpx.AsyncClient() as client:
+        try:
+            response = await client.get(
+                endpoint, headers={"Authorization": auth_header}, timeout=10
+            )
+
+            if response.status_code == 200:
+                # If the response is 200, the token is valid
+                return  # Pass silently
+            elif response.status_code == 404:
+                # If the response is 404, the token is invalid
+                detail = response.json().get("detail", "Token not found")
+                raise TokenValidationError(detail)
+            else:
+                # Handle unexpected status codes
+                raise TokenValidationError(
+                    f"Unexpected response code: {response.status_code}"
+                )
+        except httpx.RequestError as e:
+            raise TokenValidationError(f"Request failed: {e}")
+        except Exception as e:
+            raise TokenValidationError(f"An unexpected error occurred: {e}")
+
+
+def validate_token(token: str) -> None:
+    """
+    Synchronous wrapper for the `async_validate_token` function.
+
+    Args:
+        token (str): The token to validate.
+
+    Raises:
+        TokenValidationError: If the token is invalid or if there is an error in the validation process.
+
+    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()
+    except RuntimeError:
+        loop = asyncio.new_event_loop()
+        asyncio.set_event_loop(loop)
+
+    # Run the async function in the event loop
+    loop.run_until_complete(async_validate_token(token))
+
+
+# Example usage
+if __name__ == "__main__":
+    token = "test"
+    try:
+        validate_token(token)
+        print("Token is valid.")
+    except TokenValidationError as e:
+        print(f"Token validation failed: {e}")

pykubegrader-0.2.19/src/pykubegrader/tokens/validate_token.py

@@ -1,71 +0,0 @@
-import requests
-import os
-
-class TokenValidationError(Exception):
-    """
-    Custom exception raised when the token validation fails.
-    """
-
-    def __init__(self, message=None):
-        """
-        Initialize the exception with an optional message.
-
-        Args:
-            message (str, optional): The error message to display. Defaults to None.
-        """
-        super().__init__(message)
-
-
-def validate_token(token = None):
-    """
-    Validate a token by making a GET request to the validation endpoint.
-
-    Args:
-        token (str): The token to validate.
-
-    Raises:
-        TokenValidationError: If the token is invalid or if there is an error in the validation process.
-
-    Returns:
-        None: If the token is valid, the function will pass silently.
-    """
-    # sets the token in the environment variable
-    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")
-
-    # Define the validation endpoint
-    endpoint = f"https://engr-131-api.eastus.cloudapp.azure.com/validate-token/{token}"
-
-    try:
-        response = requests.get(endpoint, timeout=10)
-
-        if response.status_code == 200:
-            # If the response is 200, the token is valid
-            return  # Pass silently
-        elif response.status_code == 404:
-            # If the response is 404, the token is invalid
-            raise TokenValidationError(response.json().get("detail", "Token not found"))
-        else:
-            # Handle unexpected status codes
-            raise TokenValidationError(
-                f"Unexpected response code: {response.status_code}"
-            )
-    except requests.RequestException as e:
-        # Raise an exception for connection errors or timeout
-        raise TokenValidationError(f"Request failed: {e}")
-
-
-# Example usage
-if __name__ == "__main__":
-    token = "test"
-    try:
-        validate_token(token)
-        print("Token is valid.")
-    except TokenValidationError as e:
-        print(f"Token validation failed: {e}")