excel2moodle 0.5.0__py3-none-any.whl → 0.5.1__py3-none-any.whl

excel2moodle/core/question.py

@@ -162,14 +162,14 @@ class Question:
         """Assemble the question to the valid xml Tree."""
         mainText = self._getTextElement()
         self.logger.debug("Starting assembly")
-        self._setAnswerElement(variant=variant)
-        textParts = self._assembleMainTextParts()
+        self._assembleAnswer(variant=variant)
+        textParts = self._assembleText(variant=variant)
         if hasattr(self, "picture") and self.picture.ready:
             mainText.append(self.picture.element)
             self.logger.debug("Appended Picture element to text")
         mainText.append(etHelpers.getCdatTxtElement(textParts))
 
-    def _assembleMainTextParts(self, variant=0) -> list[ET.Element]:
+    def _assembleText(self, variant=0) -> list[ET.Element]:
         """Assemble the Question Text.
 
         Intended for the cloze question, where the answers parts are part of the text.
@@ -202,7 +202,7 @@ class Question:
             return self.bulletList
         return None
 
-    def _setAnswerElement(self, variant: int = 0) -> None:
+    def _assembleAnswer(self, variant: int = 0) -> None:
         pass
 
     def _setID(self, id=0) -> None:
@@ -229,7 +229,7 @@ class ParametricQuestion(Question):
         def replaceMatch(match: Match[str]) -> str | int | float:
             key = match.group(1)
             if key in self.variables:
-                value = self.variables[key][variant]
+                value = self.variables[key][variant - 1]
                 return f"{value}".replace(".", ",\\!")
             return match.group(0)  # keep original if no match
 

excel2moodle/question_types/cloze.py

@@ -30,7 +30,7 @@ class ClozeQuestion(ParametricQuestion):
         self.questionTexts: dict[int, list[ET.Element]] = {}
         self.partsNum: int = 0
 
-    def _setAnswerElement(self, variant: int = 1) -> None:
+    def _assembleAnswer(self, variant: int = 1) -> None:
         for part, ans in self.answerVariants.items():
             result = ans[variant - 1]
             if self.answerTypes.get(part, None) == "MC":
@@ -49,8 +49,8 @@ class ClozeQuestion(ParametricQuestion):
             self.logger.debug("Appended Question Parts %s to main text", part)
             self.questionTexts[part].append(ET.Element("hr"))
 
-    def _assembleMainTextParts(self, variant=0) -> list[ET.Element]:
-        textParts = super()._assembleMainTextParts(variant=variant)
+    def _assembleText(self, variant=0) -> list[ET.Element]:
+        textParts = super()._assembleText(variant=variant)
         self.logger.debug("Appending QuestionParts to main text")
         for paragraphs in self.questionTexts.values():
             for par in paragraphs:

excel2moodle/question_types/nfm.py

@@ -30,7 +30,7 @@ class NFMQuestion(ParametricQuestion):
         super().__init__(*args, **kwargs)
         self.answerVariants: list[ET.Element]
 
-    def _setAnswerElement(self, variant: int = 1) -> None:
+    def _assembleAnswer(self, variant: int = 1) -> None:
         prevAnsElement = self.element.find(XMLTags.ANSWER)
         if prevAnsElement is not None:
             self.element.remove(prevAnsElement)

excel2moodle/ui/dialogs.py

@@ -164,16 +164,20 @@ class AboutDialog(QtWidgets.QMessageBox):
         self.setStandardButtons(QtWidgets.QMessageBox.StandardButton.Close)
 
         self.aboutMessage: str = f"""
-        <h1> About {e2mMetadata["name"]} v {e2mMetadata["version"]}</h1><br>
+        <h1> About {e2mMetadata["name"]} v{e2mMetadata["version"]}</h1><br>
         <p style="text-align:center">
 
                 <b><a href="{e2mMetadata["homepage"]}">{e2mMetadata["name"]}</a> - {e2mMetadata["description"]}</b>
         </p>
         <p style="text-align:center">
-            A <b>
-            <a href="{e2mMetadata["documentation"]}">documentation</a></b>
-            is also available.
+            If you need help you can find some <a href="https://gitlab.com/jbosse3/excel2moodle/-/example/"> examples.</a>
             </br>
+            A Documentation can be viewed by clicking "F1",
+            or onto the documentation button.
+            </br>
+        </p>
+        <p style="text-align:center">
+        To see whats new in version {e2mMetadata["version"]} see the <a href="https://gitlab.com/jbosse3/excel2moodle#changelogs"> changelogs.</a>
         </p>
         <p style="text-align:center">
         This project is maintained by {e2mMetadata["author"]}.
@@ -181,7 +185,7 @@ class AboutDialog(QtWidgets.QMessageBox):
         Development takes place at <a href="{e2mMetadata["homepage"]}"> GitLab: {e2mMetadata["homepage"]}</a>
         contributions are very welcome
         </br>
-        If you encounter any issues please report them under the repositories issues page.
+        If you encounter any issues please report them under the <a href="https://gitlab.com/jbosse3/excel2moodle/-/issues/"> repositories issues page </a>.
         </br>
         </p>
         <p style="text-align:center">

excel2moodle-0.5.1.dist-info/METADATA

@@ -0,0 +1,106 @@
+Metadata-Version: 2.4
+Name: excel2moodle
+Version: 0.5.1
+Summary: A package for converting questions from a spreadsheet, to valid moodle-xml
+Author: Jakob Bosse
+License-Expression: GPL-3.0-or-later
+Project-URL: Repository, https://gitlab.com/jbosse3/excel2moodle.git
+Project-URL: Documentation, https://jbosse3.gitlab.io/excel2moodle
+Keywords: moodle,XML,teaching,question,converter,open educational Ressource
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pyside6>=6.8.0
+Requires-Dist: pandas>=2.1.3
+Requires-Dist: lxml>=5.4.0
+Requires-Dist: asteval>=1.0.6
+Requires-Dist: python-calamine>=0.3.2
+Dynamic: license-file
+
+# excel 2 Moodle
+![Logo](excel2moodleLogo.png "Logo excel2moodle"){width=35%}
+
+This Python program helps to create Moodle questions in less time.
+The idea is to write the questions data into a spreadsheet file, from which the program generates the moodle compliant xml Files. 
+All questions or a selection of questions can be exported into one xml file to be imported into moodle.
+
+## Concept
+The concept is, to store the different questions into categories of similar types and difficulties of questions, for each of which, a separated sheet in the Spreadsheet document should be created.
+
+A `settings` sheet contains global settings to be used for all questions and categories.
+Another sheet stores metadata for the different categories of questions.
+And each category lives inside a separate sheet inside the spreadsheet document. 
+
+## Getting Started
+
+### Installation
+To get started with excel2moodle first have a look at the [installation](https://jbosse3.gitlab.io/excel2moodle/howto.html#excel2moodle-unter-windows-installieren)
+If you already have python and uv installed, it is as easy as running `uv tool install excel2moodle`.
+
+### [ Documentation ](https://jbosse3.gitlab.io/excel2moodle/index.html)
+Once excel2moodle is installed you can checkout the [example question sheet](https://gitlab.com/jbosse3/excel2moodle/-/tree/master/example?ref_type=heads) 
+in the repository.
+
+Some steps are already documented as [ tutorials ](https://jbosse3.gitlab.io/excel2moodle/howto.html)
+you can follow along.
+
+And please have a look into the [**user Reference**](https://jbosse3.gitlab.io/excel2moodle/userReference.html)
+of the documentation. 
+That part explains each part of defining a question.
+
+
+## Functionality
+* Equation Verification:
+    + this tool helps you to validate the correct equation for the parametrized Questions.
+* Question Preview:
+    + This helps you when selecting the correct questions for the export.
+* Export Options:
+    + you can export the questions preserving the categories in moodle
+
+### Question Types
+* Generate multiple Choice Questions:
+    + The answers can be pictures or normal text
+* Generate Numeric Questions
+* Generate parametrized numeric Questions
+* Generate parametrized cloze Questions
+
+
+![MainWindow](mainWindow.png "Logo excel2moodle"){width=80%}
+
+## Licensing and authorship
+excel2moodle is lincensed under the latest [GNU GPL license](https://gitlab.com/jbosse3/excel2moodle/-/blob/master/LICENSE)
+Initial development was made by Richard Lorenz, and later taken over by Jakob Bosse
+
+## Supporting
+A special thanks goes to the [Civil Engineering Departement of the Fachhochschule Potsdam](https://www.fh-potsdam.de/en/study-further-education/departments/civil-engineering-department) 
+where i was employed as a student associate to work on this project.
+
+If You want to support my work as well, you can by me a [coffee](https://ko-fi.com/jbosse3)
+
+# Changelogs
+
+## 0.5.1 (2025-06-24)
+Minor docs improvement and question variant bugfix
+
+### bugfix (1 change)
+
+- [Bullet points variant didn't get updated](https://gitlab.com/jbosse3/excel2moodle/-/commit/7b4ad9e9c8a4216167ae019859ebaa8def81d57f)
+
+## 0.5.0 (2025-06-20)
+settings handling improved
+
+### feature (2 changes)
+
+- [Pixmaps and vector graphics scaled to fit in preview](https://gitlab.com/jbosse3/excel2moodle/-/commit/00a6ef13fb2a0046d7641e24af6cf6f08642390e)
+- [feature: category Settings implemented](https://gitlab.com/jbosse3/excel2moodle/-/commit/d673cc3f5ba06051aa37bc17a3ef0161121cb730)
+
+### improvement (1 change)
+
+- [Tolerance is harmonized by questionData.get()](https://gitlab.com/jbosse3/excel2moodle/-/commit/8d1724f4877e1584cc531b6b3f278bdea68b5831)
+
+### Settings Errors are logged (1 change)
+
+- [Log Errors in settings Sheet](https://gitlab.com/jbosse3/excel2moodle/-/commit/07e58f957c69ea818db1c5679cf89e287817ced3)
+

{excel2moodle-0.5.0.dist-info → excel2moodle-0.5.1.dist-info}/RECORD

@@ -9,30 +9,30 @@ excel2moodle/core/exceptions.py,sha256=9xfsaIcm6Yej6QAZga0d3DK3jLQejdfgJARuAaG-u
 excel2moodle/core/globals.py,sha256=Zm1wcrzQTRnhjrkwgBvo7VjKCFdPMjh-VLSSI5_QCO8,2837
 excel2moodle/core/numericMultiQ.py,sha256=vr-gYogu2sf2a_Bhvhnu1ZSZFZXM32MfhJesjTkoOQM,2618
 excel2moodle/core/parser.py,sha256=y0BXXt5j-4gRZO8otmEZ1Rmb0DW7hziesUoZ2kVpo9Y,8235
-excel2moodle/core/question.py,sha256=BSbLE_EpSOWma1B06ssZ5Y-B2GTNJZ6GXdBB6oSQQPo,11709
+excel2moodle/core/question.py,sha256=vtrYq0J5D7PivkVo4eMUx_5l5jCyunmjThij38QopyY,11706
 excel2moodle/core/settings.py,sha256=27D-P44rYk-DMrwI1dNpxHcznpFQf1W3XZrOc8e6rX4,5855
 excel2moodle/core/stringHelpers.py,sha256=OzFZ6Eu3PeBLKb61K-aeVfUZmVuBerr9KfyOsuNRd7Y,2403
 excel2moodle/core/validator.py,sha256=ssgkyUwrR-0AGPX1cUqvRwZsGja13J7HQ2W72ltqN-Y,4683
 excel2moodle/extra/__init__.py,sha256=PM-id60HD21A3IcGC_fCYFihS8osBGZMIJCcN-ZRsIM,293
 excel2moodle/extra/equationVerification.py,sha256=GLJl1r90d8AAiNy0H2hooZrg3D6aEwNfifYKAe3aGxM,3921
 excel2moodle/question_types/__init__.py,sha256=81mss0g7SVtnlb-WkydE28G_dEAAf6oT1uB8lpK2-II,1041
-excel2moodle/question_types/cloze.py,sha256=hgyv244PChnl7FbxcAMQiC4yzBhV6J3Bg4PHgZQyRmQ,7677
+excel2moodle/question_types/cloze.py,sha256=N-0fDSWfpxYN0YZmPQPEaNHpxqW1OOC32WNseYmy6zM,7657
 excel2moodle/question_types/mc.py,sha256=2kn6dPjFVg97H8SlUBFbcPjzDk84vgDGCMOtSABseu0,5225
 excel2moodle/question_types/nf.py,sha256=bMP4IXrhnXmAI0NmjEc7DtX4xGaUbxzLicE2LjeaUho,1150
-excel2moodle/question_types/nfm.py,sha256=VYrQmCsEZqfn0x_coBsDw3XvrUA4sy_yj0WS7Nsffqw,4950
+excel2moodle/question_types/nfm.py,sha256=03-aihk9HtzRCgpCGz_5WOR4JOqdJlkafyKprgLrosI,4948
 excel2moodle/ui/UI_equationChecker.py,sha256=evQDlqCHeooJcAnYjhFCyjlPhfknr7ULGKQwMmqQeJ4,8947
 excel2moodle/ui/UI_exportSettingsDialog.py,sha256=71xxXEqtewN0ReMfJ5t4gbrX_Bf0VEuxJ_DIV7ZtH94,6045
 excel2moodle/ui/UI_mainWindow.py,sha256=asWUmKIYqufKUvRuCuA1JoMyv4qfRXyoR70F0331lww,19291
 excel2moodle/ui/UI_variantDialog.py,sha256=snVaF3_YAc7NWjMRg7NzbjL_PzNbOpt4eiqElkE46io,5414
 excel2moodle/ui/__init__.py,sha256=4EdGtpzwH3rgw4xW9E5x9kdPQYwKbo9rehHRZTNxCrQ,44
 excel2moodle/ui/appUi.py,sha256=88WODtEWqX1oQJebbPhlQChKM5N_9BH0ZuOpKVYrKm0,10863
-excel2moodle/ui/dialogs.py,sha256=Gt6Bj1iCweC7CPP9VBi961ht799frMuxn0VNWvQARaM,7303
+excel2moodle/ui/dialogs.py,sha256=0h6aD4tguph1P07dorkn1A5B7_Z5SJZQ2_8xBYWK6MU,7689
 excel2moodle/ui/equationChecker.py,sha256=ANpN7S0llkp6pGL1sKHII1Jc8YUvgDR458UnGVnZZOo,2702
 excel2moodle/ui/treewidget.py,sha256=az64swVj1yQUsioeaZys32AauvQDdC4EKcqdbbWgL6s,2489
 excel2moodle/ui/windowDoc.py,sha256=WvzHj6F4JvHP82WlTsyFeOXW024Xq3BUqtp--T4twuI,661
-excel2moodle-0.5.0.dist-info/licenses/LICENSE,sha256=ywQqe6Sitymkf2lV2NRcx_aGsaC-KbSl_EfEsRXmNRw,35135
-excel2moodle-0.5.0.dist-info/METADATA,sha256=Dc3PVham-yIk0fVJAZBU_2D59TVMNkxwYs23TyUvWJo,2951
-excel2moodle-0.5.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-excel2moodle-0.5.0.dist-info/entry_points.txt,sha256=myfMLDThuGgWHMJDPPfILiZqo_7D3fhmDdJGqWOAjPw,60
-excel2moodle-0.5.0.dist-info/top_level.txt,sha256=5V1xRUQ9o7UmOCmNoWCZPAuy5nXp3Qbzyqch8fUGT_c,13
-excel2moodle-0.5.0.dist-info/RECORD,,
+excel2moodle-0.5.1.dist-info/licenses/LICENSE,sha256=ywQqe6Sitymkf2lV2NRcx_aGsaC-KbSl_EfEsRXmNRw,35135
+excel2moodle-0.5.1.dist-info/METADATA,sha256=H0kM9fFOx63yWYuKrq6ffdZglqWWCxdrxpKNdop3C0E,4614
+excel2moodle-0.5.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+excel2moodle-0.5.1.dist-info/entry_points.txt,sha256=myfMLDThuGgWHMJDPPfILiZqo_7D3fhmDdJGqWOAjPw,60
+excel2moodle-0.5.1.dist-info/top_level.txt,sha256=5V1xRUQ9o7UmOCmNoWCZPAuy5nXp3Qbzyqch8fUGT_c,13
+excel2moodle-0.5.1.dist-info/RECORD,,

excel2moodle-0.5.0.dist-info/METADATA

@@ -1,63 +0,0 @@
-Metadata-Version: 2.4
-Name: excel2moodle
-Version: 0.5.0
-Summary: A package for converting questions from a spreadsheet, to valid moodle-xml
-Author: Jakob Bosse
-License-Expression: GPL-3.0-or-later
-Project-URL: Repository, https://gitlab.com/jbosse3/excel2moodle.git
-Project-URL: Documentation, https://jbosse3.gitlab.io/excel2moodle
-Keywords: moodle,XML,teaching,question,converter,open educational Ressource
-Classifier: Programming Language :: Python :: 3
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: pyside6>=6.8.0
-Requires-Dist: pandas>=2.1.3
-Requires-Dist: lxml>=5.4.0
-Requires-Dist: asteval>=1.0.6
-Requires-Dist: python-calamine>=0.3.2
-Dynamic: license-file
-
-# excel 2 Moodle
-[Deutsche README](https://gitlab.com/jbosse3/excel2moodle/-/blob/master/README.de.md)
-
-![Logo](excel2moodleLogo.png "Logo excel2moodle"){width=50%}
-
-This Python program helps to create Moodle questions in less time.
-The aim is to put alle the information for the questions into a spreadsheet file, and then parse it, to generate Moodle compliant XML-Files.
-
-Furthermore this program lets you create a single XML-File with a selection of questions, that then can be imported to a Moodle-Test.
-
-## Concept
-The concept is, to store the different questions into categories of similar types and difficulties of questions, for each of which, a separated sheet in the Spreadsheet document should be created.
-
-There Should be a sheet called "Kategorien", where an overview over the different categories is stored.
-This sheet stores The names and descriptions, for all categories. The name have to be the same as the actual sheet names with the questions.
-Furthermore the points used for grading, are set in the "Kategorien" sheet
-
-
-## Development State
-This program is still quite rough, with very litte robustness against faulty user input inside the Spreadsheet.
-
-## Functionality
-* Parse multiple Choice Questions, each into one XML file
-* Parse Numeric Questions, each into one XML file
-* create single XML File from a selection of questions
-
-## Development Goals
-* [X] creating an example spreadsheet
-* [X] Export function, to create numerical Question version from a matrix of variables and corresponding correct Answers:
-  * similar to the calculated question Type, but with the benefit, of serving all students the same exact question
-* [.] making it more robust:
-  * [X] Adding Error Messages when exporting
-  * [X] Creating logging
-  * [ ] Logging Errors to File
-  * [ ] making it Image File-Type agnostic
-* [ ] Creating a Settings Menu
-  * [ ] Making keys in spreadsheet selectable in the Settings
-  * [ ] Setting image folder
-
-## Licensing and authorship
-excel2moodle is lincensed under the latest [GNU GPL license](https://gitlab.com/jbosse3/excel2moodle/-/blob/master/LICENSE)
-Initial development was made by Richard Lorenz, and later taken over by Jakob Bosse