QuizGenerator 0.8.0__tar.gz → 0.8.1__tar.gz

{quizgenerator-0.8.0 → quizgenerator-0.8.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: QuizGenerator
-Version: 0.8.0
+Version: 0.8.1
 Summary: Generate randomized quiz questions for Canvas LMS and PDF exams
 Project-URL: Homepage, https://github.com/OtterDen-Lab/QuizGenerator
 Project-URL: Documentation, https://github.com/OtterDen-Lab/QuizGenerator/tree/main/documentation

{quizgenerator-0.8.0 → quizgenerator-0.8.1}/QuizGenerator/contentast.py

@@ -2263,6 +2263,10 @@ class Answer(Leaf):
     unit_part = f" {self.unit}" if self.unit else ""
 
     return f"{label_part} {blank}{unit_part}".strip()
+
+  @classmethod
+  def get_entry_warning(cls) -> List[str] | None:
+    return None
   
   # Factory methods for common answer types
   @classmethod
@@ -2330,17 +2334,19 @@ class Answer(Leaf):
       0.123444... → ["0.1234"]
     """
     rounding_digits = Answer.DEFAULT_ROUNDING_DIGITS
-    decimal.getcontext().prec = max(34, rounding_digits + 10)
-
     outs = set()
 
     # Round to our standard precision first
+    decimal.getcontext().prec = max(34, rounding_digits + 10)
     q = decimal.Decimal(1).scaleb(-rounding_digits)
-    rounded_decimal = decimal.Decimal(str(value)).quantize(q, rounding=decimal.ROUND_HALF_UP)
-
-    # Normalize negative zero to positive zero
-    if rounded_decimal == 0:
-      rounded_decimal = abs(rounded_decimal)
+    if isinstance(value, str) and '/' in value:
+      f = Answer._to_fraction(value)
+      decimal_value = decimal.Decimal(f.numerator) / decimal.Decimal(f.denominator)
+    elif isinstance(value, fractions.Fraction):
+      decimal_value = decimal.Decimal(value.numerator) / decimal.Decimal(value.denominator)
+    else:
+      decimal_value = decimal.Decimal(str(value))
+    rounded_decimal = decimal_value.quantize(q, rounding=decimal.ROUND_HALF_UP)
 
     # Fixed decimal form (e.g., "1.2500")
     fixed_str = format(rounded_decimal, 'f')
@@ -2431,6 +2437,15 @@ class AnswerTypes:
 
   # Concrete type answers
   class Float(Answer):
+    @classmethod
+    def get_entry_warning(cls) -> List[str] | None:
+      digits = Answer.DEFAULT_ROUNDING_DIGITS
+      return [
+        f"Round floats to {digits} decimal places (fewer if exact, e.g., `1.25`). "
+        "No mixed numbers (e.g. use `5/4`, not `1 1/4`). "
+        "Integers as integers (e.g., `2`, not `2/1`)."
+      ]
+
     def get_for_canvas(self, single_answer=False) -> List[dict]:
       if single_answer:
         canvas_answers = [
@@ -2460,8 +2475,8 @@ class AnswerTypes:
       return canvas_answers
 
     def get_display_string(self) -> str:
-      rounded = round(self.value, Answer.DEFAULT_ROUNDING_DIGITS)
-      return f"{self.fix_negative_zero(rounded)}"
+      answer_strings = Answer.accepted_strings(self.value)
+      return answer_strings[0] if len(answer_strings) > 0 else f"{self.value}"
 
   class Int(Answer):
 
@@ -2486,6 +2501,10 @@ class AnswerTypes:
     pass
 
   class List(Answer):
+    @classmethod
+    def get_entry_warning(cls) -> List[str] | None:
+      return ["Enter lists as comma-separated values with a space after the comma (e.g., `1, 2, 3`)."]
+
     def __init__(self, order_matters=True, *args, **kwargs):
       super().__init__(*args, **kwargs)
       self.order_matters = order_matters
@@ -2523,6 +2542,13 @@ class AnswerTypes:
     """
     These are self-contained vectors that will go in a single answer block
     """
+
+    @classmethod
+    def get_entry_warning(cls) -> List[str] | None:
+      return [
+        "Enter vectors as comma-separated values with a space after the comma, "
+        "with optional parentheses (e.g., `1, 2` or `(1, 2)`)."
+      ]
   
   # Canvas export methods (from misc.Answer)
     def get_for_canvas(self, single_answer=False) -> List[dict]:
@@ -2565,6 +2591,13 @@ class AnswerTypes:
     """
     Matrix answers generate multiple blank_ids (e.g., M_0_0, M_0_1, M_1_0, M_1_1).
     """
+
+    @classmethod
+    def get_entry_warning(cls) -> List[str] | None:
+      return [
+        "For result matrices, enter `-` in any cell that does not exist.",
+        *AnswerTypes.Float.get_entry_warning()
+      ]
   
     def __init__(self, value, *args, **kwargs):
       super().__init__(value=value, *args, **kwargs)

{quizgenerator-0.8.0 → quizgenerator-0.8.1}/QuizGenerator/premade_questions/cst334/process.py

@@ -433,13 +433,7 @@ class SchedulingQuestion(ProcessQuestion, RegenerableChoiceMixin, TableQuestionM
       f"Break any ties using the job number."
     )
 
-    instructions = ca.OnlyHtml([ca.Paragraph([
-      f"Please format answer as fractions, mixed numbers, or numbers rounded to a maximum of {ca.Answer.DEFAULT_ROUNDING_DIGITS} digits after the decimal. "
-      "Examples of appropriately formatted answers would be `0`, `3/2`, `1 1/3`, `1.6667`, and `1.25`. "
-      "Note that answers that can be rounded to whole numbers should be, rather than being left in fractional form."
-    ])])
-
-    body = cls.create_fill_in_table_body(intro_text, instructions, scheduling_table)
+    body = cls.create_fill_in_table_body(intro_text, None, scheduling_table)
     body.add_element(average_block)
     return body
   

{quizgenerator-0.8.0 → quizgenerator-0.8.1}/QuizGenerator/premade_questions/cst463/math_and_data/matrix_questions.py

@@ -352,7 +352,6 @@ class MatrixMultiplication(MatrixMathQuestion):
         answers.extend(table_answers)
         body.add_element(
             ca.OnlyHtml([
-                ca.Paragraph(["Result matrix (use '-' if cell doesn't exist):"]),
                 table
             ])
         )

{quizgenerator-0.8.0 → quizgenerator-0.8.1}/QuizGenerator/question.py

@@ -382,6 +382,7 @@ class RegenerableChoiceMixin:
         del choice_info['_temp_fixed_value']
 
 class Question(abc.ABC):
+  AUTO_ENTRY_WARNINGS = True
   """
   Base class for all quiz questions with cross-format rendering support.
 
@@ -584,6 +585,10 @@ class Question(abc.ABC):
 
       can_be_numerical = self._can_be_numerical_from_answers(answers)
 
+      if self.AUTO_ENTRY_WARNINGS:
+        warnings = self._entry_warnings_from_answers(answers)
+        components.body = self._append_entry_warnings(components.body, warnings)
+
       config_params = dict(self.config_params)
       if isinstance(ctx, dict) and ctx.get("_config_params"):
         config_params.update(ctx.get("_config_params"))
@@ -723,6 +728,38 @@ class Question(abc.ABC):
         merged.append(ans)
     return merged
 
+  @classmethod
+  def _entry_warnings_from_answers(cls, answers: List[ca.Answer]) -> List[str]:
+    warnings: List[str] = []
+    seen: set[str] = set()
+    for answer in answers:
+      warning = None
+      if hasattr(answer.__class__, "get_entry_warning"):
+        warning = answer.__class__.get_entry_warning()
+      if not warning:
+        continue
+      if isinstance(warning, str):
+        warning_list = [warning]
+      else:
+        warning_list = list(warning)
+      for item in warning_list:
+        if item and item not in seen:
+          warnings.append(item)
+          seen.add(item)
+    return warnings
+
+  @classmethod
+  def _append_entry_warnings(cls, body: ca.Element, warnings: List[str]) -> ca.Element:
+    if not warnings:
+      return body
+    notes_lines = ["**Notes for answer entry**", ""]
+    notes_lines.extend(f"- {warning}" for warning in warnings)
+    warning_elements = ca.OnlyHtml([ca.Text("\n".join(notes_lines))])
+    if isinstance(body, ca.Container):
+      body.add_element(warning_elements)
+      return body
+    return ca.Section([body, warning_elements])
+
   @classmethod
   def _can_be_numerical_from_answers(cls, answers: List[ca.Answer]) -> bool:
     return (

quizgenerator-0.8.1/pyproject.toml

@@ -0,0 +1,76 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "QuizGenerator"
+version = "0.8.1"
+description = "Generate randomized quiz questions for Canvas LMS and PDF exams"
+readme = "README.md"
+license = {text = "GPL-3.0-or-later"}
+authors = [
+    {name = "Sam Ogden", email = "samuel.s.ogden@gmail.com"},
+]
+requires-python = ">=3.12"
+
+keywords = ["education", "quiz", "canvas", "lms", "assessment", "teaching", "exam", "testing"]
+
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Education",
+    "Topic :: Education :: Testing",
+    "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+]
+
+dependencies = [
+    "Jinja2==3.1.3",
+    "python-dotenv==1.0.1",
+    "PyYAML==6.0.1",
+    "requests==2.32.2",
+    "pypandoc~=1.6.3",
+    "pytablewriter~=1.2.0",
+    "pylatex>=1.4.2",
+    "matplotlib",
+    "sympy>=1.14.0",
+    "markdown>=3.9",
+    "segno>=1.6.0",
+    "cryptography>=41.0.0",
+    "graphviz>=0.21",
+    "canvasapi==3.2.0",
+    "keras>=3.12.0",
+    "tensorflow>=2.20.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/OtterDen-Lab/QuizGenerator"
+Documentation = "https://github.com/OtterDen-Lab/QuizGenerator/tree/main/documentation"
+Repository = "https://github.com/OtterDen-Lab/QuizGenerator"
+"Bug Tracker" = "https://github.com/OtterDen-Lab/QuizGenerator/issues"
+
+[project.scripts]
+quizgen = "QuizGenerator.generate:main"
+quizregen = "QuizGenerator.regenerate:main"
+
+[project.optional-dependencies]
+grading = [
+    "pyzbar>=0.1.9",
+    "pillow>=10.0.0",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["QuizGenerator"]
+
+[tool.hatch.metadata]
+allow-direct-references = true
+
+# Entry point group for custom question types (for plugin developers)
+# Users can register custom question types in their own packages using:
+# [project.entry-points."quizgenerator.questions"]
+# my_custom_question = "my_package.module:MyQuestionClass"
+#
+# Example:
+# [project.entry-points."quizgenerator.questions"]
+# advanced_scheduling = "university_questions.os:AdvancedSchedulingQuestion"
+# memory_hierarchy = "university_questions.os:MemoryHierarchyQuestion"

{quizgenerator-0.8.0 → quizgenerator-0.8.1}/uv.lock

@@ -1214,7 +1214,7 @@ wheels = [
 
 [[package]]
 name = "quizgenerator"
-version = "0.8.0"
+version = "0.8.1"
 source = { editable = "." }
 dependencies = [
     { name = "canvasapi" },