QuizGenerator 0.8.1__py3-none-any.whl → 0.10.0__py3-none-any.whl

{quizgenerator-0.8.1.dist-info → quizgenerator-0.10.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: QuizGenerator
-Version: 0.8.1
+Version: 0.10.0
 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
@@ -19,9 +19,7 @@ Classifier: Topic :: Education :: Testing
 Requires-Python: >=3.12
 Requires-Dist: canvasapi==3.2.0
 Requires-Dist: cryptography>=41.0.0
-Requires-Dist: graphviz>=0.21
 Requires-Dist: jinja2==3.1.3
-Requires-Dist: keras>=3.12.0
 Requires-Dist: markdown>=3.9
 Requires-Dist: matplotlib
 Requires-Dist: pylatex>=1.4.2
@@ -32,7 +30,10 @@ Requires-Dist: pyyaml==6.0.1
 Requires-Dist: requests==2.32.2
 Requires-Dist: segno>=1.6.0
 Requires-Dist: sympy>=1.14.0
-Requires-Dist: tensorflow>=2.20.0
+Provides-Extra: cst463
+Requires-Dist: graphviz>=0.21; extra == 'cst463'
+Requires-Dist: keras>=3.12.0; extra == 'cst463'
+Requires-Dist: tensorflow>=2.20.0; extra == 'cst463'
 Provides-Extra: grading
 Requires-Dist: pillow>=10.0.0; extra == 'grading'
 Requires-Dist: pyzbar>=0.1.9; extra == 'grading'
@@ -60,18 +61,24 @@ pip install QuizGenerator
 ### System Requirements
 
 - Python 3.12+
-- LaTeX distribution with `latexmk` (for PDF generation)
-- Optional: [Typst](https://typst.app/) (alternative to LaTeX)
+- [Typst](https://typst.app/) (default PDF renderer)
+- Optional: LaTeX distribution with `latexmk` (if using `--latex`)
+- Recommended: [Pandoc](https://pandoc.org/) (for markdown conversion)
 
 ### Optional Dependencies
 
 ```bash
 # For QR code grading support
 pip install QuizGenerator[grading]
+
+# For CST463 machine learning questions
+pip install QuizGenerator[cst463]
 ```
 
 ## Quick Start
 
+Need a 2‑minute setup? See `documentation/quickstart.md`.
+
 ### 1. Create a quiz configuration (YAML)
 
 ```yaml
@@ -94,7 +101,7 @@ questions:
 ### 2. Generate PDFs
 
 ```bash
-python -m generate_quiz --quiz_yaml my_quiz.yaml --num_pdfs 3
+quizgen --yaml my_quiz.yaml --num_pdfs 3
 ```
 
 PDFs will be created in the `out/` directory.
@@ -106,8 +113,8 @@ PDFs will be created in the `out/` directory.
 # CANVAS_API_URL=https://canvas.instructure.com
 # CANVAS_API_KEY=your_api_key_here
 
-python -m generate_quiz \
-  --quiz_yaml my_quiz.yaml \
+quizgen \
+  --yaml my_quiz.yaml \
   --num_canvas 5 \
   --course_id 12345
 ```
@@ -150,26 +157,29 @@ All questions follow the same three‑method flow:
 
 ```python
 class MyQuestion(Question):
-    def _build_context(self, *, rng_seed=None, **kwargs):
+    @classmethod
+    def _build_context(cls, *, rng_seed=None, **kwargs):
         context = super()._build_context(rng_seed=rng_seed, **kwargs)
-        rng = context["rng"]
+        rng = context.rng
         context["value"] = rng.randint(1, 10)
         return context
 
-    def _build_body(self, context):
+    @classmethod
+    def _build_body(cls, context):
         body = ca.Section()
         body.add_element(ca.Paragraph([f"Value: {context['value']}"]))
         body.add_element(ca.AnswerTypes.Int(context["value"], label="Value"))
         return body
 
-    def _build_explanation(self, context):
+    @classmethod
+    def _build_explanation(cls, context):
         explanation = ca.Section()
         explanation.add_element(ca.Paragraph([f"Answer: {context['value']}"]))
         return explanation
 ```
 
 Notes:
-- Always use `context["rng"]` for deterministic randomness.
+- Always use `context.rng` (or `context["rng"]`) for deterministic randomness.
 - Avoid `refresh()`; it is no longer part of the API.
 
 ## Built-in Question Types
@@ -191,10 +201,9 @@ Notes:
 
 ## Documentation
 
-- [Getting Started Guide](documentation/getting_started.md) (coming soon)
+- [Getting Started Guide](documentation/getting_started.md)
 - [Custom Questions Guide](documentation/custom_questions.md)
-- [YAML Configuration Reference](documentation/yaml_config_guide.md) (coming soon)
-- [PyPI Release Plan](documentation/pypi_release_plan.md)
+- [YAML Configuration Reference](documentation/yaml_config_guide.md)
 
 ## Canvas Setup
 
@@ -213,25 +222,28 @@ CANVAS_API_KEY_prod=your_prod_api_key
 2. Use `--prod` flag for production Canvas instance:
 
 ```bash
-python -m generate_quiz --prod --num_canvas 5 --course_id 12345
+quizgen --prod --num_canvas 5 --course_id 12345
 ```
 
 ## Advanced Features
 
 ### Typst Support
 
-Use Typst instead of LaTeX for faster compilation:
+Typst is the default for faster compilation. Use `--latex` to force LaTeX:
 
 ```bash
-python -m generate_quiz --typst --num_pdfs 3
+quizgen --latex --num_pdfs 3
 ```
 
+Experimental: `--typst_measurement` uses Typst to measure question height for tighter layout.
+It can change pagination and ordering, so use with care on finalized exams.
+
 ### Deterministic Generation
 
 Use seeds for reproducible quizzes:
 
 ```bash
-python -m generate_quiz --seed 42 --num_pdfs 3
+quizgen --seed 42 --num_pdfs 3
 ```
 
 ### QR Code Regeneration
@@ -255,7 +267,7 @@ QuizGenerator/
 │   └── canvas/           # Canvas LMS integration
 ├── example_files/        # Example quiz configurations
 ├── documentation/        # User guides
-└── generate_quiz.py     # CLI entry point
+└── quizgen             # CLI entry point
 ```
 
 ## Contributing

{quizgenerator-0.8.1.dist-info → quizgenerator-0.10.0.dist-info}/RECORD

@@ -1,21 +1,23 @@
+QuizGenerator/README.md,sha256=4n16gKyhIAKRBX4VKlpfcK0pyUYJ6Ht08MUsnwgxrZo,145
 QuizGenerator/__init__.py,sha256=8EV-k90A3PNC8Cm2-ZquwNyVyvnwW1gs6u-nGictyhs,840
 QuizGenerator/__main__.py,sha256=Dd9w4R0Unm3RiXztvR4Y_g9-lkWp6FHg-4VN50JbKxU,151
 QuizGenerator/constants.py,sha256=AO-UWwsWPLb1k2JW6KP8rl9fxTcdT0rW-6XC6zfnDOs,4386
-QuizGenerator/contentast.py,sha256=uTql3nvNg8DZnPxOg7S31vXbifSNfb3rFK5c_ihLsbg,87615
-QuizGenerator/generate.py,sha256=dqF-WWmWxyJmPHl0gTYr3gNNxyF877fvXYaMvYA3uA8,15790
+QuizGenerator/contentast.py,sha256=NY6Y9gWbdinXaVGdgwN61UBF2nz_L2urqr-IPfR6tV0,88475
+QuizGenerator/generate.py,sha256=qKYT-7HLUS1WSViDDSuJOIb5RwsTT3BuoUUZkoqSSus,17363
+QuizGenerator/logging.yaml,sha256=VJCdh26D8e_PNUs4McvvP1ojz9EVjQNifJzfhEk1Mbo,1114
 QuizGenerator/misc.py,sha256=MXrguUhhdrWSV4Hqdl4G21ktowODu1AcKy6-5mvy3aI,454
-QuizGenerator/mixins.py,sha256=B9Ee52wUCeclmBTgonasHNo0WHvVOcnILsz0iecrf78,15705
+QuizGenerator/mixins.py,sha256=zXj2U94qNbIEusbwTnzRM1Z_zSybpvozWhveq-t5q2Q,15771
 QuizGenerator/performance.py,sha256=CM3zLarJXN5Hfrl4-6JRBqD03j4BU1B2QW699HAr1Ds,7002
-QuizGenerator/qrcode_generator.py,sha256=S3mzZDk2UiHiw6ipSCpWPMhbKvSRR1P5ordZJUTo6ug,10776
-QuizGenerator/question.py,sha256=QsLKFEM8LzLkH1_5MOwMFRuqtTkEd7-a_eoaTKcttpU,33602
+QuizGenerator/qrcode_generator.py,sha256=VMbAXFxJ_3KryqrgynCUPR5myeiu5CoroBfwwBsinCc,13386
+QuizGenerator/question.py,sha256=BSopEaosCkJZ76etMv3Ue1zjzJpho-WnqS_8cQlZeac,38199
 QuizGenerator/quiz.py,sha256=CEWy7FB7BZiK33s_wYs6MqGKDetc6htUaqvP3--2HzI,21621
-QuizGenerator/regenerate.py,sha256=ZAs1mtERmO8JXza2tBqJpd-uJs9V7gS1jJ9A9gSb8jo,19764
+QuizGenerator/regenerate.py,sha256=cDYZ9LwOSkX9P7W72O0c6RI8ORzS-DFnYhAdC5-7UrI,20375
 QuizGenerator/typst_utils.py,sha256=JGQn_u5bEHd8HAtjAHuZoVJwLkx-Rd4ZCBWffwFZa3o,3136
 QuizGenerator/canvas/__init__.py,sha256=TwFP_zgxPIlWtkvIqQ6mcvBNTL9swIH_rJl7DGKcvkQ,286
-QuizGenerator/canvas/canvas_interface.py,sha256=StMcdXgLvTA1EayQ44m_le2GXGQpDQnduYXVeUYsqW0,24618
+QuizGenerator/canvas/canvas_interface.py,sha256=5PS7sZeIwRuOGK9gXmfgP4eUYtgCqZ1JKD-S4mNvsbk,24798
 QuizGenerator/canvas/classes.py,sha256=v_tQ8t_JJplU9sv2p4YctX45Fwed1nQ2HC1oC9BnDNw,7594
 QuizGenerator/premade_questions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-QuizGenerator/premade_questions/basic.py,sha256=F_Qsu14b2xERyibCAMP1NPgnmi1h2G2DDkKJoU_RS8g,3284
+QuizGenerator/premade_questions/basic.py,sha256=u6Viv__5HYWjLOknYt_jsBJTej5-cPd9FM1xsuwUQcQ,4613
 QuizGenerator/premade_questions/cst334/__init__.py,sha256=BTz-Os1XbwIRKqAilf2UIva2NlY0DbA_XbSIggO2Tdk,36
 QuizGenerator/premade_questions/cst334/languages.py,sha256=ctemEAMkI8C6ASMIf59EHAW1ndFWi7hXzdEt-zOByUE,14114
 QuizGenerator/premade_questions/cst334/math_questions.py,sha256=aUYbQxneL5MXE7Xo3tZX9-xcg71CXwvG3rrxcoh0l7A,8638
@@ -25,26 +27,26 @@ QuizGenerator/premade_questions/cst334/persistence_questions.py,sha256=9mgsX-3oW
 QuizGenerator/premade_questions/cst334/process.py,sha256=0SqXkvdxaEJZXJA8fBqheh7F0PL8I6xgO5a8u2s2po4,37238
 QuizGenerator/premade_questions/cst463/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 QuizGenerator/premade_questions/cst463/gradient_descent/__init__.py,sha256=sH2CUV6zK9FT3jWTn453ys6_JTrUKRtZnU8hK6RmImU,240
-QuizGenerator/premade_questions/cst463/gradient_descent/gradient_calculation.py,sha256=laBeC0tMc2EaLzCotGHQNzePPPOKS1EGgQirigNyi9M,13479
-QuizGenerator/premade_questions/cst463/gradient_descent/gradient_descent_questions.py,sha256=_2HlC0sqfGy__Qyzbw0PwMD_OkQiiQukl72LQFyPYx0,10939
-QuizGenerator/premade_questions/cst463/gradient_descent/loss_calculations.py,sha256=8GtJX1DNNox-AgMvABFkRgmHB-lvrxMZKzv-3Ils_Jg,22380
+QuizGenerator/premade_questions/cst463/gradient_descent/gradient_calculation.py,sha256=y_R26wUt7AIZVUoe3e_qpzkPdwMyo3mZjxLI504-YQw,13840
+QuizGenerator/premade_questions/cst463/gradient_descent/gradient_descent_questions.py,sha256=OssybIkHx4l8ryHGT9rqHUecta9qpItK4QYVHuuQLeo,11525
+QuizGenerator/premade_questions/cst463/gradient_descent/loss_calculations.py,sha256=PMuEAUJmN12t4ffHF0FoSbQNCLDfW5BKozWNHvoC6GU,24276
 QuizGenerator/premade_questions/cst463/gradient_descent/misc.py,sha256=0R-nFeD3zsqJyde5CXWrF6Npjmpx6_HbzfCbThLi3os,2657
 QuizGenerator/premade_questions/cst463/math_and_data/__init__.py,sha256=EbIaUrx7_aK9j3Gd8Mk08h9GocTq_0OoNu2trfNwaU8,202
 QuizGenerator/premade_questions/cst463/math_and_data/matrix_questions.py,sha256=4DLdo_8XDS_xtPA8R-wH4K0cKnMn4r5727Vszz8keTc,15565
 QuizGenerator/premade_questions/cst463/math_and_data/vector_questions.py,sha256=VXQCLQEeNKxRDPn_fGW5nAPX-0betrZ8mURh0ElbNz0,12668
 QuizGenerator/premade_questions/cst463/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-QuizGenerator/premade_questions/cst463/models/attention.py,sha256=iECxOoR0LEJAH_d7ZE3MoLOkdYVbGOKo4Dwf8Pww0tM,5443
-QuizGenerator/premade_questions/cst463/models/cnns.py,sha256=_HSjgClNBBid5t52CDQfPUMdKOHFOXjy7VQ3sW-zW-Y,6030
+QuizGenerator/premade_questions/cst463/models/attention.py,sha256=hb0sLVddxSKr4-bsIpAUyxITfcNaAGT-FppwwXXu52I,5430
+QuizGenerator/premade_questions/cst463/models/cnns.py,sha256=p3hvQEsTsI2urPrZ-MZ63eIq0Dm6aarrLATVIiECc2A,6017
 QuizGenerator/premade_questions/cst463/models/matrices.py,sha256=21eNXUcIjFNZTGH18oH-x3MbCa4buNGQGer3a5yL85c,1938
-QuizGenerator/premade_questions/cst463/models/rnns.py,sha256=5fKQuWnpSAoznZVJuCY4nICQ5KzB04Cz17hpccYiiVc,6673
-QuizGenerator/premade_questions/cst463/models/text.py,sha256=BnW6qIB8pnQiFRyXxtX9cdsIfmjw99p6TI0WqI0AQzk,6605
-QuizGenerator/premade_questions/cst463/models/weight_counting.py,sha256=sFnEvSs7ZwR4RZPltiMEElKJgoxHTaY427_g8Abi2uk,6912
+QuizGenerator/premade_questions/cst463/models/rnns.py,sha256=9pPzkrNviKD479NVgVvkoMhXtaLX0m17IIGpYKXXAwk,6660
+QuizGenerator/premade_questions/cst463/models/text.py,sha256=j6ClSF4AztgFWyvuhjBCW5mKvQL1AdizfhpF3iCjtt4,6592
+QuizGenerator/premade_questions/cst463/models/weight_counting.py,sha256=NriO0cukIw3HKYkm62p4PPm1qdH9wmDepEfoBzrmxR4,7402
 QuizGenerator/premade_questions/cst463/neural-network-basics/__init__.py,sha256=pmyCezO-20AFEQC6MR7KnAsaU9TcgZYsGQOMVkRZ-U8,149
-QuizGenerator/premade_questions/cst463/neural-network-basics/neural_network_questions.py,sha256=bit_HfAG4K6yh9SZZw_HAPhFUVFkOBdZ2odwt-Cdvmo,42868
+QuizGenerator/premade_questions/cst463/neural-network-basics/neural_network_questions.py,sha256=j2f5LFmme-2rSgJzcb8nZJ1_hnZaL-S4lXSnIbpoH_E,43010
 QuizGenerator/premade_questions/cst463/tensorflow-intro/__init__.py,sha256=G1gEHtG4KakYgi8ZXSYYhX6bQRtnm2tZVGx36d63Nmo,173
-QuizGenerator/premade_questions/cst463/tensorflow-intro/tensorflow_questions.py,sha256=jZRbEqb65BAtliv_V9VR4kvpwOt-o10ApN7RmOIg3XI,30464
-quizgenerator-0.8.1.dist-info/METADATA,sha256=Ef_TPUm2UKYIXnBMiaip6SaAyRjMD4G1MNdVejagfRw,8113
-quizgenerator-0.8.1.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-quizgenerator-0.8.1.dist-info/entry_points.txt,sha256=aOIdRdw26xY8HkxOoKHBnUPe2mwGv5Ti3U1zojb6zxQ,98
-quizgenerator-0.8.1.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-quizgenerator-0.8.1.dist-info/RECORD,,
+QuizGenerator/premade_questions/cst463/tensorflow-intro/tensorflow_questions.py,sha256=t0ghv6o8AsZaIwVHFu07Ozebwuv6Rf18D3g_-Jz4O74,31309
+quizgenerator-0.10.0.dist-info/METADATA,sha256=zxcZ0akBMSH9jjA-sdpO55tZUlN4pfeSpIqFs9m864M,8483
+quizgenerator-0.10.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+quizgenerator-0.10.0.dist-info/entry_points.txt,sha256=aOIdRdw26xY8HkxOoKHBnUPe2mwGv5Ti3U1zojb6zxQ,98
+quizgenerator-0.10.0.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+quizgenerator-0.10.0.dist-info/RECORD,,