PyKubeGrader 0.0.8__tar.gz → 0.1.0__tar.gz

{pykubegrader-0.0.8 → pykubegrader-0.1.0}/.github/workflows/main.yml

@@ -49,7 +49,7 @@ jobs:
 
       - name: Publish to PyPI
         if: |
-          contains(github.event.head_commit.message, '#patch') || 
+          contains(github.event.head_commit.message, '#patch') ||
           contains(github.event.head_commit.message, '#minor') ||
           contains(github.event.head_commit.message, '#major')
         env:
@@ -60,6 +60,8 @@ jobs:
           twine upload dist/*
 
       - name: Deploy to GitHub Pages
+        env:
+          HOME: "${{ github.workspace }}/../" # Because self-hosted runner is root
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GH_TOKEN }}

{pykubegrader-0.0.8 → pykubegrader-0.1.0}/.gitignore

@@ -52,3 +52,6 @@ MANIFEST
 .venv*/
 .conda*/
 .python-version
+
+.mypy_cache/
+.ruff_cache/

{pykubegrader-0.0.8 → pykubegrader-0.1.0}/.readthedocs.yml

@@ -24,4 +24,4 @@ build:
 python:
   install:
     - requirements: docs/requirements.txt
-    - {path: ., method: pip}
+    - { path: ., method: pip }

{pykubegrader-0.0.8/src/PyKubeGrader.egg-info → pykubegrader-0.1.0}/PKG-INFO

@@ -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.0.8 → pykubegrader-0.1.0}/docs/conf.py

@@ -28,10 +28,8 @@ sys.path.insert(0, os.path.join(__location__, "../src"))
 # setup.py install" in the RTD Advanced Settings.
 # Additionally it helps us to avoid running apidoc manually
 
-try:  # for Sphinx >= 1.7
-    from sphinx.ext import apidoc
-except ImportError:
-    from sphinx import apidoc
+
+from sphinx.ext import apidoc
 
 output_dir = os.path.join(__location__, "api")
 module_dir = os.path.join(__location__, "../src/pykubegrader")
@@ -252,7 +250,7 @@ htmlhelp_basename = "PyKubeGrader-doc"
 
 # -- Options for LaTeX output ------------------------------------------------
 
-latex_elements = {
+latex_elements: dict[str, str] = {
     # The paper size ("letterpaper" or "a4paper").
     # "papersize": "letterpaper",
     # The font size ("10pt", "11pt" or "12pt").

{pykubegrader-0.0.8 → pykubegrader-0.1.0}/setup.cfg

@@ -23,11 +23,18 @@ package_dir =
 	=src
 install_requires = 
 	importlib-metadata; python_version<"3.8"
-	ipython>=8.30.0
-	numpy>=2.1.3
-	panel>=1.5.4
-	pynacl>=1.5.0
-	requests>=2.32.3
+	ipython
+	mypy
+	numpy
+	panel
+	pynacl
+	pytest
+	requests
+	ruff
+	setuptools
+	sphinx
+	types-requests
+	types-setuptools
 
 [options.packages.find]
 where = src

{pykubegrader-0.0.8 → pykubegrader-0.1.0}/setup.py

@@ -1,10 +1,10 @@
 """
-    Setup file for PyKubeGrader.
-    Use setup.cfg to configure your project.
+Setup file for PyKubeGrader.
+Use setup.cfg to configure your project.
 
-    This file was generated with PyScaffold 4.6.
-    PyScaffold helps you to put up the scaffold of your new Python project.
-    Learn more under: https://pyscaffold.org/
+This file was generated with PyScaffold 4.6.
+PyScaffold helps you to put up the scaffold of your new Python project.
+Learn more under: https://pyscaffold.org/
 """
 
 from setuptools import setup

{pykubegrader-0.0.8 → pykubegrader-0.1.0/src/PyKubeGrader.egg-info}/PKG-INFO

@@ -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.0.8 → pykubegrader-0.1.0}/src/PyKubeGrader.egg-info/SOURCES.txt

@@ -5,13 +5,11 @@ AUTHORS.rst
 CHANGELOG.rst
 CONTRIBUTING.rst
 LICENSE.txt
-README.md
 README.rst
 pyproject.toml
 setup.cfg
 setup.py
 tox.ini
-uv.lock
 .github/workflows/main.yml
 docs/Makefile
 docs/authors.rst
@@ -22,7 +20,6 @@ docs/index.rst
 docs/license.rst
 docs/readme.rst
 docs/requirements.txt
-docs/_static/.gitignore
 docs/_static/Drexel_blue_Logo_square_Dark.png
 docs/_static/Drexel_blue_Logo_square_Light.png
 docs/_static/custom.css
@@ -33,18 +30,19 @@ src/PyKubeGrader.egg-info/not-zip-safe
 src/PyKubeGrader.egg-info/requires.txt
 src/PyKubeGrader.egg-info/top_level.txt
 src/pykubegrader/__init__.py
-src/pykubegrader/info_widget.py
-src/pykubegrader/mc_widget.py
-src/pykubegrader/misc.py
-src/pykubegrader/multi_select_base.py
-src/pykubegrader/reading_base.py
-src/pykubegrader/reading_widget.py
-src/pykubegrader/select_base.py
-src/pykubegrader/select_many_widget.py
+src/pykubegrader/initialize.py
 src/pykubegrader/telemetry.py
-src/pykubegrader/types_widget.py
+src/pykubegrader/utils.py
 src/pykubegrader/validate.py
-src/pykubegrader/seed/__init__.py
-src/pykubegrader/seed/hash_seed.py
+src/pykubegrader/widgets/__init__.py
+src/pykubegrader/widgets/multiple_choice.py
+src/pykubegrader/widgets/reading_question.py
+src/pykubegrader/widgets/select_many.py
+src/pykubegrader/widgets/student_info.py
+src/pykubegrader/widgets/types_question.py
+src/pykubegrader/widgets_base/__init__.py
+src/pykubegrader/widgets_base/multi_select.py
+src/pykubegrader/widgets_base/reading.py
+src/pykubegrader/widgets_base/select.py
 tests/conftest.py
 tests/import_test.py

pykubegrader-0.1.0/src/PyKubeGrader.egg-info/requires.txt

@@ -0,0 +1,20 @@
+ipython
+mypy
+numpy
+panel
+pynacl
+pytest
+requests
+ruff
+setuptools
+sphinx
+types-requests
+types-setuptools
+
+[:python_version < "3.8"]
+importlib-metadata
+
+[testing]
+setuptools
+pytest
+pytest-cov

pykubegrader-0.1.0/src/pykubegrader/__init__.py

@@ -0,0 +1,9 @@
+from importlib.metadata import PackageNotFoundError, version  # pragma: no cover
+
+try:
+    dist_name = "PyKubeGrader"  # Change if project is renamed
+    __version__ = version(dist_name)
+except PackageNotFoundError:  # pragma: no cover
+    __version__ = "unknown"
+finally:
+    del version, PackageNotFoundError

pykubegrader-0.1.0/src/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-0.0.8 → pykubegrader-0.1.0}/src/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-0.0.8 → pykubegrader-0.1.0}/src/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-0.1.0/src/pykubegrader/widgets/__init__.py

@@ -0,0 +1 @@
+

pykubegrader-0.0.8/src/pykubegrader/mc_widget.py → pykubegrader-0.1.0/src/pykubegrader/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-0.0.8/src/pykubegrader/reading_widget.py → pykubegrader-0.1.0/src/pykubegrader/widgets/reading_question.py

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

pykubegrader-0.0.8/src/pykubegrader/select_many_widget.py → pykubegrader-0.1.0/src/pykubegrader/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-0.0.8/src/pykubegrader/info_widget.py → pykubegrader-0.1.0/src/pykubegrader/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-0.0.8/src/pykubegrader/types_widget.py → pykubegrader-0.1.0/src/pykubegrader/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-0.1.0/src/pykubegrader/widgets_base/__init__.py

@@ -0,0 +1 @@
+

pykubegrader-0.0.8/src/pykubegrader/multi_select_base.py → pykubegrader-0.1.0/src/pykubegrader/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-0.0.8/src/pykubegrader/reading_base.py → pykubegrader-0.1.0/src/pykubegrader/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-0.0.8/src/pykubegrader/select_base.py → pykubegrader-0.1.0/src/pykubegrader/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.1.0/tests/conftest.py

@@ -0,0 +1,10 @@
+"""
+Dummy conftest.py for pykubegrader.
+
+If you don't know what this is for, just leave it empty.
+Read more about conftest.py under:
+- https://docs.pytest.org/en/stable/fixture.html
+- https://docs.pytest.org/en/stable/writing_plugins.html
+"""
+
+import pytest  # noqa: F401

pykubegrader-0.0.8/README.md

@@ -1,3 +0,0 @@
-# pygrader-utils
-
-To be documented…

pykubegrader-0.0.8/docs/_static/.gitignore

@@ -1 +0,0 @@
-# Empty directory

pykubegrader-0.0.8/src/PyKubeGrader.egg-info/requires.txt

@@ -1,13 +0,0 @@
-ipython>=8.30.0
-numpy>=2.1.3
-panel>=1.5.4
-pynacl>=1.5.0
-requests>=2.32.3
-
-[:python_version < "3.8"]
-importlib-metadata
-
-[testing]
-setuptools
-pytest
-pytest-cov

pykubegrader-0.0.8/src/pykubegrader/__init__.py

@@ -1,16 +0,0 @@
-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
-
-try:
-    # Change here if project is renamed and does not equal the package name
-    dist_name = "PyKubeGrader"
-    __version__ = version(dist_name)
-except PackageNotFoundError:  # pragma: no cover
-    __version__ = "unknown"
-finally:
-    del version, PackageNotFoundError

pykubegrader-0.0.8/src/pykubegrader/seed/__init__.py

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

pykubegrader-0.0.8/src/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

pykubegrader-0.0.8/tests/conftest.py

@@ -1,10 +0,0 @@
-"""
-    Dummy conftest.py for pykubegrader.
-
-    If you don't know what this is for, just leave it empty.
-    Read more about conftest.py under:
-    - https://docs.pytest.org/en/stable/fixture.html
-    - https://docs.pytest.org/en/stable/writing_plugins.html
-"""
-
-import pytest