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

excel2moodle/core/category.py

@@ -5,6 +5,8 @@ from typing import TYPE_CHECKING
 import lxml.etree as ET
 import pandas as pd
 
+from excel2moodle.core.settings import Tags
+
 if TYPE_CHECKING:
     from excel2moodle.core.question import Question
 
@@ -19,17 +21,15 @@ class Category:
         name: str,
         description: str,
         dataframe: pd.DataFrame,
-        points: float = 0,
-        version: int = 0,
+        settings: dict[str, float | str],
     ) -> None:
         """Instantiate a new Category object."""
         self.NAME = name
-        match = re.search(r"\d+$", self.NAME)
+        match = re.search(r"\d+$", str(self.NAME))
         self.n: int = int(match.group(0)) if match else 99
         self.desc = str(description)
         self.dataframe: pd.DataFrame = dataframe
-        self.points = points
-        self.version = int(version)
+        self.settings: dict[str, float | str] = settings if settings else {}
         self.questions: dict[int, Question] = {}
         self.maxVariants: int | None = None
         loggerObj.info("initializing Category %s", self.NAME)
@@ -38,9 +38,17 @@ class Category:
     def name(self) -> str:
         return self.NAME
 
+    @property
+    def points(self) -> float:
+        return self.settings.get(Tags.POINTS)
+
+    @points.setter
+    def points(self, points: float) -> None:
+        self.settings[Tags.POINTS] = points
+
     @property
     def id(self) -> str:
-        return f"{self.version}{self.n:02d}"
+        return f"{self.n:02d}"
 
     def __hash__(self) -> int:
         return hash(self.NAME)

excel2moodle/core/dataStructure.py

@@ -105,7 +105,18 @@ class QuestionDB:
                 engine="calamine",
             )
             logger.debug("Found the settings: \n\t%s", settingDf)
-            self._setProjectSettings(settingDf, mainPath=sheetPath.parent)
+            settingDf = self.harmonizeDFIndex(settingDf)
+            for tag, value in settingDf.iterrows():
+                val = value.iloc[0]
+                if pd.notna(val):
+                    self.settings.set(tag, val)
+        try:
+            self._validateProjectSettings(sheetPath=sheetPath)
+        except InvalidFieldException:
+            logger.exception(
+                "Can not create the database with invalid project settings."
+            )
+            raise
         with Path(sheetPath).open("rb") as f:
             self.categoriesMetaData = pd.read_excel(
                 f,
@@ -113,35 +124,33 @@ class QuestionDB:
                 index_col=0,
                 engine="calamine",
             )
-            logger.info(
-                "Sucessfully read categoriesMetaData \n %s", self.categoriesMetaData
-            )
+            logger.info("Sucessfully read categoriesMetaData")
         return self.categoriesMetaData
 
-    def _setProjectSettings(
-        self, settings: pd.DataFrame, mainPath: Path | None = None
-    ) -> None:
-        settings = self.harmonizeDFIndex(settings)
-        for tag, value in settings.iterrows():
-            value = value.iloc[0]
-            if tag == Tags.TOLERANCE:
-                tol = value if value < 1 else value / 100
-                if tol > 0 and tol < 1:
-                    self.settings.set(Tags.TOLERANCE, tol)
-            else:
-                self.settings.set(tag, value)
-        if Tags.IMPORTMODULE in settings.index:
+    def _validateProjectSettings(self, sheetPath: Path) -> None:
+        if Tags.IMPORTMODULE in self.settings:
             logger.warning(
                 "Appending: %s to sys.path. All names defined by it will be usable",
-                mainPath,
+                sheetPath,
             )
-            sys.path.append(str(mainPath))
+            sys.path.append(str(sheetPath.parent))
+        if Tags.PICTURESUBFOLDER not in self.settings:
+            logger.warning("You didn't specify an image Folder. This may cause errors.")
         imgFolder = self.settings.get(Tags.SPREADSHEETPATH).parent / self.settings.get(
             Tags.PICTURESUBFOLDER
         )
-        if Tags.PICTURESUBFOLDER not in settings.index:
-            logger.warning("You didn't specify an image Folder. This may cause errors.")
-        self.settings.set(Tags.PICTUREFOLDER, imgFolder.resolve())
+        catSheet = self.settings.get(Tags.CATEGORIESSHEET)
+        if catSheet not in pd.ExcelFile(sheetPath, engine="calamine").sheet_names:
+            msg = f"The specified categories sheet: '{catSheet}' doesn't exist."
+            raise InvalidFieldException(msg, "00000", Tags.CATEGORIESSHEET)
+        try:
+            imgFolder.resolve(strict=True)
+        except FileNotFoundError:
+            msg = f"Img Path: {imgFolder} could not be found"
+            raise InvalidFieldException(msg, "00000", Tags.PICTURESUBFOLDER)
+        else:
+            self.settings.set(Tags.PICTUREFOLDER, imgFolder.resolve())
+            logger.info("Set up the project settings")
 
     def initAllCategories(self, sheetPath: Path | None = None) -> None:
         """Read all category sheets and initialize all Categories."""
@@ -228,29 +237,26 @@ class QuestionDB:
 
         :emits: categoryReady(self) Signal.
         """
-        categoryDf = self.harmonizeDFIndex(categoryDf)
-        points = (
-            self.categoriesMetaData["points"].loc[categoryName]
-            if "points" in self.categoriesMetaData
-            and not pd.isna(self.categoriesMetaData["points"]).loc[categoryName]
-            else self.settings.get(Tags.POINTS)
-        )
-        version = (
-            self.categoriesMetaData["version"].loc[categoryName]
-            if "version" in self.categoriesMetaData
-            and not pd.isna(self.categoriesMetaData["version"].loc[categoryName])
-            else self.settings.get(Tags.VERSION)
-        )
+        categoryDf: pd.DataFrame = self.harmonizeDFIndex(categoryDf)
+        categorySettings: dict[str, float | int | str] = self.harmonizeDFIndex(
+            self.categoriesMetaData.loc[categoryName]
+        ).to_dict()
+        nanSettings: list[str] = [
+            k for k, v in categorySettings.items() if pd.isna(v) or k not in Tags
+        ]
+        for na in nanSettings:
+            categorySettings.pop(na)
         category = Category(
             categoryName,
             self.categoriesMetaData["description"].loc[categoryName],
             dataframe=categoryDf,
-            points=points,
-            version=version,
+            settings=categorySettings,
         )
         if hasattr(self, "categories"):
             self.categories[categoryName] = category
             self.signals.categoryReady.emit(category)
+        else:
+            logger.warning("Can't append initialized category to the database")
         logger.debug("Category %s is initialized", categoryName)
         return category
 
@@ -280,7 +286,7 @@ class QuestionDB:
         self.signals.categoryQuestionsReady.emit(category)
 
     @classmethod
-    def setupAndParseQuestion(cls, category: Category, qNumber: int) -> None:
+    def setupAndParseQuestion(cls, category: Category, qNumber: int) -> Question | None:
         """Check if the Question Data is valid. Then parse it.
 
         The Question data is accessed from  `category.dataframe` via its number
@@ -316,7 +322,7 @@ class QuestionDB:
         question = QuestionTypeMapping[qtype].create(category, validData)
         if question.isParsed:
             locallogger.info("Question already parsed")
-            return
+            return None
         if isinstance(question, NFQuestion):
             cls.nfParser.setup(question)
             locallogger.debug("setup a new NF parser ")
@@ -337,6 +343,7 @@ class QuestionDB:
             msg = "couldn't setup Parser"
             raise QNotParsedException(msg, question.id)
         category.questions[qNumber] = question
+        return question
 
     def appendQuestions(
         self, questions: list[QuestionItem], file: Path | None = None

excel2moodle/core/parser.py

@@ -50,7 +50,12 @@ class QuestionParser:
         f = self.settings.get(Tags.PICTUREFOLDER)
         svgFolder = (f / self.question.katName).resolve()
         if not hasattr(self.question, "picture"):
-            self.question.picture = Picture(picKey, svgFolder, self.question.id)
+            self.question.picture = Picture(
+                picKey,
+                svgFolder,
+                self.question.id,
+                width=self.rawInput.get(Tags.PICTUREWIDTH),
+            )
         return bool(self.question.picture.ready)
 
     def setMainText(self) -> None:

excel2moodle/core/question.py

@@ -25,6 +25,14 @@ settings = Settings()
 
 
 class QuestionData(dict):
+    @property
+    def categoryFallbacks(self) -> dict[str, float | str]:
+        return self._categoryFallbacks
+
+    @categoryFallbacks.setter
+    def categoryFallbacks(self, fallbacks: dict) -> None:
+        self._categoryFallbacks: dict[str, float | str] = fallbacks
+
     @overload
     def get(
         self,
@@ -39,7 +47,6 @@ class QuestionData(dict):
     def get(
         self,
         key: Literal[
-            Tags.VERSION,
             Tags.NUMBER,
             Tags.PICTUREWIDTH,
             Tags.ANSPICWIDTH,
@@ -58,14 +65,26 @@ class QuestionData(dict):
     def get(self, key: Literal[Tags.RESULT]) -> float | str: ...
 
     def get(self, key: Tags, default=None):
+        """Get the value for `key` with correct type.
+
+        If `key == Tags.TOLERANCE` the tolerance is checked to be a perc. fraction
+        """
         if key in self:
             val = self[key]
-            try:
-                typed = key.typ()(val)
-            except ValueError:
-                return None
-            return typed
-        return settings.get(key)
+        elif key in self.categoryFallbacks:
+            val = self.categoryFallbacks.get(key)
+        else:
+            val = settings.get(key)
+        try:
+            typed = key.typ()(val)
+        except (TypeError, ValueError):
+            return None
+        if key == Tags.TOLERANCE:
+            loggerObj.debug("Verifying Tolerance")
+            if typed <= 0 or typed >= 100:
+                typed = settings.get(Tags.TOLERANCE)
+            return typed if typed < 1 else typed / 100
+        return typed
 
 
 class Question:
@@ -105,13 +124,12 @@ class Question:
         category: Category,
         rawData: QuestionData,
         parent=None,
-        points: float = 0,
     ) -> None:
         self.rawData: QuestionData = rawData
+        self.rawData.categoryFallbacks = category.settings
         self.category = category
         self.katName = self.category.name
         self.moodleType = QUESTION_TYPES[self.qtype]
-        self.points = points if points != 0 else self.category.points
         self.element: ET.Element = None
         self.isParsed: bool = False
         self.picture: Picture
@@ -122,6 +140,10 @@ class Question:
         self.logger = LogAdapterQuestionID(loggerObj, {"qID": self.id})
         self.logger.debug("Sucess initializing")
 
+    @property
+    def points(self) -> float:
+        return self.rawData.get(Tags.POINTS)
+
     @property
     def name(self) -> str:
         return self.rawData.get(Tags.NAME)
@@ -140,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.
@@ -180,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:
@@ -207,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
 
@@ -242,6 +264,7 @@ class Picture:
 
     def getImgId(self, imgKey: str) -> bool:
         """Get the image ID and width based on the given key.
+
         The key should either be the full ID (as the question) or only the question Num.
         If only the number is given, the category.id is prepended.
         The width should be specified by `ID:width:XX`. where xx is the px value.
@@ -262,12 +285,13 @@ class Picture:
         if imgKey in ("false", "nan", False) or len(num) == 0:
             return False
         imgID: int = int(num[0])
-        if imgID < 10:
-            picID = f"{self.questionId[:3]}{imgID:02d}"
+        if imgID < 100:
+            picID = f"{self.questionId[:2]}{imgID:02d}"
         elif imgID < 10000:
-            picID = f"{self.questionId[:1]}{imgID:04d}"
-        elif imgID <= 100000:
-            picID = str(imgID)
+            picID = f"{imgID:04d}"
+        else:
+            msg = f"The imgKey {imgKey} is invalid, it should be a 4 digit question ID with an optional suffix"
+            raise QNotParsedException(msg, self.questionId)
         if len(app) > 0 and app[0]:
             self.picID = f"{picID}{app[0]}"
         else:
@@ -280,7 +304,7 @@ class Picture:
             return base64.b64encode(img.read()).decode("utf-8")
 
     def _getImg(self) -> bool:
-        suffixes = ["png", "svg", "jpeg", "jpg"]
+        suffixes = ["png", "svg", "jpeg", "jpg", "JPG", "jxl"]
         paths = [
             path
             for suf in suffixes

excel2moodle/core/settings.py

@@ -22,7 +22,7 @@ class Tags(StrEnum):
         typ: type,
         default: str | float | Path | bool | None,
         place: str = "project",
-    ):
+    ) -> object:
         """Define new settings class."""
         obj = str.__new__(cls, key)
         obj._value_ = key
@@ -84,17 +84,19 @@ class Tags(StrEnum):
     ANSTYPE = "answertype", str, None
     QUESTIONPART = "part", list, None
     PARTTYPE = "parttype", str, None
-    VERSION = "version", int, 1
     POINTS = "points", float, 1.0
     PICTUREWIDTH = "imgwidth", int, 500
     ANSPICWIDTH = "answerimgwidth", int, 120
-    WRONGSIGNPERCENT = "wrongsignpercentage", int, 50
+    WRONGSIGNPERCENT = "wrongsignpercent", int, 50
     FIRSTRESULT = "firstresult", float, 0
 
 
 class Settings:
     values: ClassVar[dict[str, str | float | Path]] = {}
 
+    def __contains__(self, tag: Tags) -> bool:
+        return bool(tag in type(self).values)
+
     @classmethod
     def clear(cls) -> None:
         cls.values.clear()
@@ -112,7 +114,6 @@ class Settings:
         key: Literal[
             Tags.QUESTIONVARIANT,
             Tags.TOLERANCE,
-            Tags.VERSION,
             Tags.PICTUREWIDTH,
             Tags.ANSPICWIDTH,
             Tags.WRONGSIGNPERCENT,
@@ -192,6 +193,6 @@ class Settings:
                     type(value),
                 )
                 return
-            logger.info("Saved  %s = %s, type %s", key, value, tag.typ())
+            logger.info("Saved  %s = %s: %s", key, value, tag.typ().__name__)
         else:
             logger.warning("got invalid local Setting %s = %s", key, value)

excel2moodle/logger.py

@@ -88,11 +88,26 @@ class LogWindowHandler(logging.Handler):
             "CRITICAL": "pink",
         }
 
+    def handle(self, record) -> bool:
+        info = record.exc_info
+        if record.exc_info:
+            excType, excVal, excTraceB = record.exc_info
+            exc_info_msg = f"[{excType.__name__}]: <b>{excVal}</b>"
+            record.exc_text = exc_info_msg
+            record.exc_info = None
+        try:
+            super().handle(record)
+        finally:
+            record.exc_info = info
+            record.exc_text = None
+        return True
+
     def emit(self, record: logging.LogRecord) -> None:
         """Emit the signal, with a new logging message."""
         log_message = self.format(record)
+        msg = log_message.replace("\n", "<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;")
         color = self.logLevelColors.get(record.levelname, "black")
-        prettyMessage = f'<span style="color:{color};">{log_message}</span>'
+        prettyMessage = f'<span style="color:{color};">{msg}</span>'
         self.emitter.signal.emit(prettyMessage)
 
 

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/mc.py

@@ -104,13 +104,13 @@ class MCQuestionParser(QuestionParser):
         if self.answerType == "picture":
             f = self.settings.get(Tags.PICTUREFOLDER)
             imgFolder = (f / self.question.katName).resolve()
-            w = self.settings.get(Tags.ANSPICWIDTH)
+            width = self.rawInput.get(Tags.ANSPICWIDTH)
             self.trueImgs: list[Picture] = [
-                Picture(t, imgFolder, self.question.id, width=w)
+                Picture(t, imgFolder, self.question.id, width=width)
                 for t in self.rawInput.get(Tags.TRUE)
             ]
             self.falseImgs: list[Picture] = [
-                Picture(t, imgFolder, self.question.id, width=w)
+                Picture(t, imgFolder, self.question.id, width=width)
                 for t in self.rawInput.get(Tags.FALSE)
             ]
             trueAnsList: list[str] = [pic.htmlTag for pic in self.trueImgs if pic.ready]

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/appUi.py

@@ -108,7 +108,6 @@ class MainWindow(QtWidgets.QMainWindow):
         If successful it prints out a list of all exported Questions
         """
         self.ui.treeWidget.clear()
-        self.testDB.readCategoriesMetadata()
         process = ParseAllThread(self.testDB, self)
         self.threadPool.start(process)
 
@@ -259,6 +258,7 @@ class ParseAllThread(QRunnable):
 
     @QtCore.Slot()
     def run(self) -> None:
+        self.testDB.readCategoriesMetadata()
         self.testDB.asyncInitAllCategories(self.mainApp.excelPath)
         self.mainApp.setStatus("[OK] Tabellen wurde eingelesen")
         self.testDB.parseAllQuestions()

excel2moodle/ui/dialogs.py

@@ -90,28 +90,39 @@ class QuestionPreview:
         self.ui.graphicsView.setScene(self.picScene)
         self.setText()
         self.setAnswers()
-        if hasattr(self, "picItem"):
+        if hasattr(self, "picItem") and self.picItem.scene() == self.picScene:
+            logger.debug("removing Previous picture")
             self.picScene.removeItem(self.picItem)
+            del self.picItem
         self.setPicture()
 
     def setPicture(self) -> None:
         if hasattr(self.question, "picture") and self.question.picture.ready:
             path = self.question.picture.path
             if path.suffix == ".svg":
-                self.picItem = QGraphicsSvgItem(str(self.question.picture.path))
+                self.picItem = QGraphicsSvgItem(str(path))
             else:
-                pic = QtGui.QPixmap(self.question.picture.path)
-                aspRat = pic.height() // pic.width()
-                width = 400
-                scaleHeight = aspRat * width
-                self.picItem = QtWidgets.QGraphicsPixmapItem(
-                    pic.scaled(
-                        width, scaleHeight, QtGui.Qt.AspectRatioMode.KeepAspectRatio
-                    )
-                )
+                pic = QtGui.QPixmap(str(path))
+                self.picItem = QtWidgets.QGraphicsPixmapItem(pic)
+                if pic.isNull():
+                    logger.warning("Picture null")
+            scale = self._getImgFittingScale()
+            self.picItem.setScale(scale)
             self.picScene.addItem(self.picItem)
-        # else:
-        #     self.ui.graphicsView.setFixedHeight(1)
+
+    def _getImgFittingScale(self) -> float:
+        view_size = self.ui.graphicsView.viewport().size()
+        view_width = view_size.width()
+        view_height = view_size.height()
+        if isinstance(self.picItem, QtWidgets.QGraphicsPixmapItem):
+            original_size = self.picItem.pixmap().size()
+        elif isinstance(self.picItem, QGraphicsSvgItem):
+            original_size = self.picItem.renderer().defaultSize()
+        else:
+            return 1  # Unknown item type
+        scale_x = view_width / original_size.width()
+        scale_y = view_height / original_size.height()
+        return min(scale_x, scale_y)
 
     def setText(self) -> None:
         t = []
@@ -153,24 +164,28 @@ 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"]}.
         <br>
         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.4.4.dist-info → excel2moodle-0.5.1.dist-info}/RECORD

@@ -1,38 +1,38 @@
 excel2moodle/__init__.py,sha256=mnb-RWgmWIPSBk4S65a_jP6rxntAkTeYxN0ObUJalbQ,1801
 excel2moodle/__main__.py,sha256=sG4ygwfVFskLQorBn-v98SvasNcPmwl_vLYpruT5Hk8,1175
-excel2moodle/logger.py,sha256=S9tvSwsOx2xta_AhGKHPNgi5FaiycyUDtkzHlIlNAX8,3193
+excel2moodle/logger.py,sha256=fq8ZOkCI1wj38v8IyrZsUlpt16onlSH_phqbVvYUwBQ,3725
 excel2moodle/core/__init__.py,sha256=87BwhtZse72Tk17Ib-V9X2k9wkhmtVnEj2ZmJ9JBAnI,63
-excel2moodle/core/category.py,sha256=TzntDhEURshxWuI6qc_K_t5bSTLXn6s0n_RA56Basg8,1885
-excel2moodle/core/dataStructure.py,sha256=lmquDdRyMqKxHjbcMOJ83BRs1otXqG9vhNFVfQsljwE,15578
+excel2moodle/core/category.py,sha256=wLzpbweQbzaItdbp2NCPI_Zmk94fy1EDOwEEN8zPvkU,2123
+excel2moodle/core/dataStructure.py,sha256=sDdum2I0EZRuXTgbVSsLX4aBINfzkmNXBCHzUVBhxH8,16022
 excel2moodle/core/etHelpers.py,sha256=G37qplp8tPJxqHNCBrf2Wo0jJZ0aDbxE9slQavqYqd8,2293
 excel2moodle/core/exceptions.py,sha256=9xfsaIcm6Yej6QAZga0d3DK3jLQejdfgJARuAaG-uZY,739
 excel2moodle/core/globals.py,sha256=Zm1wcrzQTRnhjrkwgBvo7VjKCFdPMjh-VLSSI5_QCO8,2837
 excel2moodle/core/numericMultiQ.py,sha256=vr-gYogu2sf2a_Bhvhnu1ZSZFZXM32MfhJesjTkoOQM,2618
-excel2moodle/core/parser.py,sha256=Ec8bQ0CiiZCIdzQovfH2rce406wmyRmvhpDrCPeQfGU,8112
-excel2moodle/core/question.py,sha256=nJDs8SPDRYP6xG4rvo8Bbh1734eQ96DZxVXb7yrT8LM,10802
-excel2moodle/core/settings.py,sha256=JhcgZcOrgFC7P4h9fSXZAApEl_9dE643r5arFpU1HXQ,5808
+excel2moodle/core/parser.py,sha256=y0BXXt5j-4gRZO8otmEZ1Rmb0DW7hziesUoZ2kVpo9Y,8235
+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/mc.py,sha256=rHKIKSNeHyto84bI9B3wMKzNJuluplsCmYM4k2HW3wQ,5213
+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=NXlBcjxHBeUzpU8rvqwN3wxad8AUgpMjXidwwVdC9GM,10863
-excel2moodle/ui/dialogs.py,sha256=JbQ1y55wbzWVTY0nxdGrUm81AdOIY3PXKgET03Hc6Ys,6760
+excel2moodle/ui/appUi.py,sha256=88WODtEWqX1oQJebbPhlQChKM5N_9BH0ZuOpKVYrKm0,10863
+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.4.4.dist-info/licenses/LICENSE,sha256=ywQqe6Sitymkf2lV2NRcx_aGsaC-KbSl_EfEsRXmNRw,35135
-excel2moodle-0.4.4.dist-info/METADATA,sha256=NnGjQn0V6gBHcWuIjnleEqTeeFK5zVS0bDpwB6240SE,2951
-excel2moodle-0.4.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-excel2moodle-0.4.4.dist-info/entry_points.txt,sha256=myfMLDThuGgWHMJDPPfILiZqo_7D3fhmDdJGqWOAjPw,60
-excel2moodle-0.4.4.dist-info/top_level.txt,sha256=5V1xRUQ9o7UmOCmNoWCZPAuy5nXp3Qbzyqch8fUGT_c,13
-excel2moodle-0.4.4.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.4.4.dist-info/METADATA

@@ -1,63 +0,0 @@
-Metadata-Version: 2.4
-Name: excel2moodle
-Version: 0.4.4
-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