excel2moodle 0.6.2__tar.gz → 0.6.4__tar.gz

{excel2moodle-0.6.2 → excel2moodle-0.6.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: excel2moodle
-Version: 0.6.2
+Version: 0.6.4
 Summary: A package for converting questions from a spreadsheet, to valid moodle-xml
 Author: Jakob Bosse
 License-Expression: GPL-3.0-or-later
@@ -90,6 +90,33 @@ If You want to support my work as well, you can by me a [coffee](https://ko-fi.c
 
 # Changelogs
 
+## 0.6.4 (2025-09-02)
+Added Scripted Media Support
+
+### feature (1 change)
+
+- [Added support for scripted Media content.](https://gitlab.com/jbosse3/excel2moodle/-/commit/2021942392147d0e9740af5286f469dd6226ffa5)
+
+## 0.6.3 (2025-08-03)
+Lots of small improvements made
+
+### improvement (3 changes)
+
+- [small logging improvements and error handling](https://gitlab.com/jbosse3/excel2moodle/-/commit/149f8e923a06d9d7077fe90c7005a3e1d5d2d42f)
+- [Make variable generator rules editable](https://gitlab.com/jbosse3/excel2moodle/-/commit/80ea32d97bdec16b77100bc870a0e0272a739dd4)
+- [Variable generator only generates unique sets.](https://gitlab.com/jbosse3/excel2moodle/-/commit/d347c91bbac66de1da157fee4f76faf8d4636557)
+
+### bugfix (3 changes)
+
+- [mixed parametric and non parametric Bullets are working now](https://gitlab.com/jbosse3/excel2moodle/-/commit/f094b13dffd4b6b7ac1a03fc7e34eec6e8d1bfa7)
+- [Loglevel setting is respected in spreadsheet file](https://gitlab.com/jbosse3/excel2moodle/-/commit/d6ef89beeec94f24782a00b7564883074badf72d)
+- [Treewidget variants count updated after variable generation](https://gitlab.com/jbosse3/excel2moodle/-/commit/c48a0d093a0cce85fd3e9c3c091eef936739c02b)
+
+### feature (2 changes)
+
+- [Category ID taken from any number in its name](https://gitlab.com/jbosse3/excel2moodle/-/commit/ac7e19af5f25ac2e576b63c478e7b07153e782ef)
+- [Implemented Update Check on Startup](https://gitlab.com/jbosse3/excel2moodle/-/commit/a143edd47f566c5e731c05612f4ac21dc7728eb7)
+
 ## 0.6.2 (2025-08-02)
 Adding export options and fixing cloze points bug
 

{excel2moodle-0.6.2 → excel2moodle-0.6.4}/README.md

@@ -68,6 +68,33 @@ If You want to support my work as well, you can by me a [coffee](https://ko-fi.c
 
 # Changelogs
 
+## 0.6.4 (2025-09-02)
+Added Scripted Media Support
+
+### feature (1 change)
+
+- [Added support for scripted Media content.](https://gitlab.com/jbosse3/excel2moodle/-/commit/2021942392147d0e9740af5286f469dd6226ffa5)
+
+## 0.6.3 (2025-08-03)
+Lots of small improvements made
+
+### improvement (3 changes)
+
+- [small logging improvements and error handling](https://gitlab.com/jbosse3/excel2moodle/-/commit/149f8e923a06d9d7077fe90c7005a3e1d5d2d42f)
+- [Make variable generator rules editable](https://gitlab.com/jbosse3/excel2moodle/-/commit/80ea32d97bdec16b77100bc870a0e0272a739dd4)
+- [Variable generator only generates unique sets.](https://gitlab.com/jbosse3/excel2moodle/-/commit/d347c91bbac66de1da157fee4f76faf8d4636557)
+
+### bugfix (3 changes)
+
+- [mixed parametric and non parametric Bullets are working now](https://gitlab.com/jbosse3/excel2moodle/-/commit/f094b13dffd4b6b7ac1a03fc7e34eec6e8d1bfa7)
+- [Loglevel setting is respected in spreadsheet file](https://gitlab.com/jbosse3/excel2moodle/-/commit/d6ef89beeec94f24782a00b7564883074badf72d)
+- [Treewidget variants count updated after variable generation](https://gitlab.com/jbosse3/excel2moodle/-/commit/c48a0d093a0cce85fd3e9c3c091eef936739c02b)
+
+### feature (2 changes)
+
+- [Category ID taken from any number in its name](https://gitlab.com/jbosse3/excel2moodle/-/commit/ac7e19af5f25ac2e576b63c478e7b07153e782ef)
+- [Implemented Update Check on Startup](https://gitlab.com/jbosse3/excel2moodle/-/commit/a143edd47f566c5e731c05612f4ac21dc7728eb7)
+
 ## 0.6.2 (2025-08-02)
 Adding export options and fixing cloze points bug
 

{excel2moodle-0.6.2 → excel2moodle-0.6.4}/excel2moodle/__init__.py

@@ -45,6 +45,8 @@ if __package__ is not None:
         "documentation": "https://jbosse3.gitlab.io/excel2moodle",
         "homepage": meta["project-url"].split()[1],
         "issues": "https://gitlab.com/jbosse3/excel2moodle/issues",
+        "funding": "https://ko-fi.com/jbosse3",
+        "API_id": "jbosse3%2Fexcel2moodle",
     }
 
 

{excel2moodle-0.6.2 → excel2moodle-0.6.4}/excel2moodle/__main__.py

@@ -5,17 +5,20 @@ import signal
 import sys
 from pathlib import Path
 
+from PySide6.QtCore import QTimer
 from PySide6.QtWidgets import QApplication
 
 import excel2moodle
-from excel2moodle import e2mMetadata, mainLogger
+from excel2moodle import __version__, e2mMetadata, mainLogger
 from excel2moodle.core import dataStructure
 from excel2moodle.core.settings import Settings, Tags
+from excel2moodle.extra import updateQuery
 from excel2moodle.logger import loggerConfig
 from excel2moodle.ui import appUi as ui
 
 
 def main() -> None:
+    app = QApplication(sys.argv)
     excel2moodle.isMain = True
     settings = Settings()
     logfile = Path(settings.get(Tags.LOGFILE)).resolve()
@@ -24,12 +27,24 @@ def main() -> None:
         logfile.replace(f"{logfile}.old")
     logConfig.dictConfig(config=loggerConfig)
     signal.signal(signal.SIGINT, signal.SIG_DFL)
-    app = QApplication(sys.argv)
-    settings = Settings()
     database: dataStructure.QuestionDB = dataStructure.QuestionDB(settings)
     window = ui.MainWindow(settings, database)
     database.window = window
     window.show()
+    # Update check
+    latestTag = updateQuery.get_latest_tag(e2mMetadata.get("API_id"))
+    if latestTag is None:
+        mainLogger.warning(
+            "Couldn't check for Updates, maybe there is  no internet connection"
+        )
+    if latestTag is not None and latestTag.strip("v") != __version__:
+        mainLogger.warning(
+            "A new Update is available: %s --> %s ", __version__, latestTag
+        )
+        changelog = updateQuery.get_changelog(e2mMetadata.get("API_id"))
+        # Delay showing the update dialog slightly
+        QTimer.singleShot(100, lambda: window.showUpdateDialog(changelog, latestTag))
+
     for k, v in e2mMetadata.items():
         msg = f"{k:^14s}:  {v}"
         mainLogger.info(msg)

{excel2moodle-0.6.2 → excel2moodle-0.6.4}/excel2moodle/core/bullets.py

@@ -5,7 +5,7 @@ import lxml.etree as ET
 
 from excel2moodle.core import stringHelpers
 from excel2moodle.core.globals import TextElements
-from excel2moodle.core.question import ParametricQuestion
+from excel2moodle.core.question import ParametricQuestion, Parametrics
 from excel2moodle.logger import LogAdapterQuestionID
 
 loggerObj = logging.getLogger(__name__)
@@ -15,14 +15,13 @@ class BulletList:
     def __init__(self, rawBullets: list[str], qID: str) -> None:
         self.rawBullets: list[str] = rawBullets
         self.element: ET.Element = ET.Element("ul")
-        self.bullets: dict[str, BulletP] = {}
+        self.bullets: dict[str | int, BulletP] = {}
         self.id = qID
         self.logger = LogAdapterQuestionID(loggerObj, {"qID": self.id})
         self._setupBullets(rawBullets)
 
-    def updateBullets(
-        self, variables: dict[str, list[float]], variant: int = 1
-    ) -> None:
+    def update(self, parametrics: Parametrics, variant: int = 1) -> None:
+        variables: dict[str, list[float]] = parametrics.variables
         for var, bullet in self.bullets.items():
             bullet.update(value=variables[var][variant - 1])
 
@@ -70,7 +69,7 @@ class BulletList:
             if match is None:
                 self.logger.debug("Got a normal bulletItem")
                 num: float = float(quant.replace(",", "."))
-                bulletName: str = str(i + 1)
+                bulletName = i + 1
             else:
                 bulletName = match.group(1)
                 num: float = 0.0

{excel2moodle-0.6.2 → excel2moodle-0.6.4}/excel2moodle/core/category.py

@@ -24,8 +24,9 @@ class Category:
     ) -> None:
         """Instantiate a new Category object."""
         self.NAME = name
-        match = re.search(r"\d+$", str(self.NAME))
-        self.n: int = int(match.group(0)) if match else 99
+        match = re.search(r"\d+", str(self.NAME))
+        n = int(match.group(0)) if match else 99
+        self.n: int = n if n <= 99 and n >= 0 else 99
         self.desc = str(description)
         self.dataframe: pd.DataFrame = dataframe
         self.settings: dict[str, float | str] = settings if settings else {}
@@ -52,7 +53,7 @@ class Category:
     @property
     def questions(self) -> dict:
         if not hasattr(self, "_questions"):
-            msg = "Category question are not yet initialized"
+            msg = f"Category {self.id} doesn't contain any valid questions."
             raise ValueError(msg)
         return self._questions
 

{excel2moodle-0.6.2 → excel2moodle-0.6.4}/excel2moodle/core/dataStructure.py

@@ -105,39 +105,29 @@ class QuestionDB:
             When there is no 'seetings' worksheet in the file.
         InvalidFieldException
             When the settings are invalid
+            Or When the categories Sheet doesn't provide the necessary keys.
 
         Before raising it logges the exceptions with a meaningful message.
 
         """
         sheetPath = sheetPath if sheetPath else self.spreadsheet
         logger.info("Start Parsing the Excel Metadata Sheet\n")
-        try:
-            with Path(sheetPath).open("rb") as f:
-                settingDf = pd.read_excel(
-                    f,
-                    sheet_name="settings",
-                    index_col=0,
-                    engine="calamine",
-                )
-        except ValueError:
-            logger.exception(
-                "Did you forget to specify a 'settings' sheet in the file?"
+        with Path(sheetPath).open("rb") as f:
+            settingDf = pd.read_excel(
+                f,
+                sheet_name="settings",
+                index_col=0,
+                header=None,
+                engine="calamine",
             )
-            raise
         logger.debug("Found the settings: \n\t%s", settingDf)
         settingDf = self.harmonizeDFIndex(settingDf)
-        for tag, value in settingDf.iterrows():
-            val = value.iloc[0]
-            if pd.notna(val):
-                self.settings.set(tag, val)
+        settingsDict = Validator.dfToDict(settingDf[1])
+        Validator.listify(settingsDict)
+        for tag, value in settingsDict.items():
+            self.settings.set(tag, value)
 
-        try:
-            self._validateProjectSettings(sheetPath=sheetPath)
-        except InvalidFieldException:
-            logger.exception(
-                "Can not create the database with invalid project settings."
-            )
-            raise
+        self._validateProjectSettings(sheetPath=sheetPath)
         with Path(sheetPath).open("rb") as f:
             self.categoriesMetaData = pd.read_excel(
                 f,
@@ -145,10 +135,20 @@ class QuestionDB:
                 index_col=0,
                 engine="calamine",
             )
-            logger.info("Sucessfully read categoriesMetaData")
+        if "description" not in self.categoriesMetaData.columns:
+            msg = f"You need to specify the 'description' tag for each category in the sheet '{self.settings.get(Tags.CATEGORIESSHEET)}'."
+            raise InvalidFieldException(msg, "0000", "description")
+        logger.info("Sucessfully read categoriesMetaData")
         return self.categoriesMetaData
 
     def _validateProjectSettings(self, sheetPath: Path) -> None:
+        if Tags.LOGLEVEL in self.settings:
+            level: str = self.settings.get(Tags.LOGLEVEL)
+            if level.upper() not in ("DEBUG", "INFO", "WARNING", "ERROR"):
+                self.settings.pop(Tags.LOGLEVEL)
+                logger.warning("You specified an unsupported Loglevel: %s", level)
+        if self.window is not None:
+            self.window.logHandler.setLevel(self.settings.get(Tags.LOGLEVEL).upper())
         if Tags.IMPORTMODULE in self.settings:
             logger.warning(
                 "Appending: %s to sys.path. All names defined by it will be usable",
@@ -297,7 +297,7 @@ class QuestionDB:
         for qNum in category.dataframe.columns:
             try:
                 self.setupAndParseQuestion(category, qNum)
-            except (InvalidFieldException, QNotParsedException):
+            except (InvalidFieldException, QNotParsedException, AttributeError):
                 logger.exception(
                     "Question %s%02d couldn't be parsed. The Question Data: \n %s",
                     category.id,
@@ -379,10 +379,10 @@ class QuestionDB:
         catdict: dict[Category, list[Question]] = {}
         for q in questions:
             logger.debug(f"got a question to append {q=}")
-            cat = q.parent().getCategory()
+            cat = q.parent().category
             if cat not in catdict:
                 catdict[cat] = []
-            catdict[cat].append(q.getQuestion())
+            catdict[cat].append(q.question)
         for cat, qlist in catdict.items():
             self._appendQElements(
                 cat,
@@ -423,6 +423,8 @@ class QuestionDB:
                 else:
                     logger.warning("Keine Fragenvariante wurde gewählt.")
                 tree.append(q.getUpdatedElement(variant=variant))
+            else:
+                tree.append(q.getUpdatedElement(variant=variant))
             self._exportedQuestions.append(q)
 
     def generateExportReport(

{excel2moodle-0.6.2 → excel2moodle-0.6.4}/excel2moodle/core/parser.py

@@ -11,8 +11,9 @@ from excel2moodle.core.globals import (
     XMLTags,
     feedBElements,
 )
-from excel2moodle.core.question import Picture, Question
+from excel2moodle.core.question import ParametricQuestion, Picture, Question
 from excel2moodle.core.settings import Settings, Tags
+from excel2moodle.extra.scriptCaller import MediaCall
 from excel2moodle.logger import LogAdapterQuestionID
 
 loggerObj = logging.getLogger(__name__)
@@ -129,9 +130,13 @@ class QuestionParser:
                 )
             self.htmlRoot.append(bullets.element)
             self.question.bulletList = bullets
+            if isinstance(self.question, ParametricQuestion):
+                self.question.updateQue = [bullets]
         if self.hasPicture():
             self.htmlRoot.append(self.question.picture.htmlTag)
             textRootElem.append(self.question.picture.element)
+        if Tags.MEDIACALL in self.rawInput:
+            self.insertScriptedMedia()
         ansList = self._parseAnswers()
         if ansList is not None:
             for ele in ansList:
@@ -166,6 +171,19 @@ class QuestionParser:
         ele.append(eth.getCdatTxtElement(par))
         return ele
 
+    def insertScriptedMedia(self) -> None:
+        """Load the scripts, insert the div and call a Function."""
+        for script in self.rawInput.get(Tags.MEDIASCRIPTS):
+            ET.SubElement(
+                self.htmlRoot, "script", type="text/javascript", src=script
+            ).text = ""
+        divId = f"scriptedMedia-{self.question.id}"
+        ET.SubElement(self.htmlRoot, "div", id=divId).text = ""
+        scriptCall = MediaCall(self.rawInput.get(Tags.MEDIACALL), divId=divId)
+        self.htmlRoot.append(scriptCall.element)
+        if isinstance(self.question, ParametricQuestion):
+            self.question.updateQue.append(scriptCall)
+
     def _parseAnswers(self) -> list[ET.Element] | None:
         """Needs to be implemented in the type-specific subclasses."""
         return None

{excel2moodle-0.6.2 → excel2moodle-0.6.4}/excel2moodle/core/question.py

@@ -53,7 +53,14 @@ class QuestionData(dict):
     @overload
     def get(
         self,
-        key: Literal[Tags.BPOINTS, Tags.TRUE, Tags.FALSE, Tags.QUESTIONPART, Tags.TEXT],
+        key: Literal[
+            Tags.BPOINTS,
+            Tags.TRUE,
+            Tags.FALSE,
+            Tags.QUESTIONPART,
+            Tags.TEXT,
+            Tags.MEDIASCRIPTS,
+        ],
         default: object = None,
     ) -> list: ...
     @overload
@@ -115,6 +122,7 @@ class Question:
     }
     optionalTags: ClassVar[dict[Tags, type | UnionType]] = {
         Tags.PICTURE: int | str,
+        Tags.MEDIACALL: list,
     }
 
     def __init_subclass__(cls, **kwargs) -> None:
@@ -202,6 +210,7 @@ class ParametricQuestion(Question):
         self.rules: list[str] = []
         self.parametrics: Parametrics
         self._variant: int
+        self.updateQue: list
 
     @property
     def currentVariant(self) -> int:
@@ -214,13 +223,12 @@ class ParametricQuestion(Question):
         `Question` returns the Element.
 
         """
-        if not hasattr(self, "bulletList"):
-            msg = "Can't assemble a parametric question, without the bulletPoints variables"
+        if not hasattr(self, "updateQue"):
+            msg = "Can't assemble a parametric question, without the updateQue"
             raise QNotParsedException(msg, self.id)
 
-        self.bulletList.updateBullets(
-            variables=self.parametrics.variables, variant=variant
-        )
+        for obj in self.updateQue:
+            obj.update(parametrics=self.parametrics, variant=variant)
         self._variant = variant
         return super().getUpdatedElement(variant)
 

{excel2moodle-0.6.2 → excel2moodle-0.6.4}/excel2moodle/core/settings.py

@@ -96,9 +96,12 @@ class Tags(StrEnum):
     PCORRECFB = "partialcorrectfeedback", str, "Your answer is partially right."
     GENERALFB = "feedback", str, "You answered this question."
 
+    MEDIASCRIPTS = "mediascripts", list, None
+    MEDIACALL = "parametricmedia", str, None
+
 
 class Settings:
-    values: ClassVar[dict[str, str | float | Path]] = {}
+    values: ClassVar[dict[str, str | float | Path | list]] = {}
 
     def __contains__(self, tag: Tags) -> bool:
         return bool(tag in type(self).values)
@@ -107,6 +110,10 @@ class Settings:
     def clear(cls) -> None:
         cls.values.clear()
 
+    @classmethod
+    def pop(cls, key: str):
+        return cls.values.pop(key)
+
     @overload
     @classmethod
     def get(
@@ -160,7 +167,7 @@ class Settings:
             default = key.default
             if default is None:
                 return None
-            logger.info("Returning the default value for %s", key)
+            logger.debug("Returning the default value for %s", key)
             return default
         if key.typ() is Path:
             path: Path = Path(raw)

{excel2moodle-0.6.2 → excel2moodle-0.6.4}/excel2moodle/core/validator.py

@@ -54,31 +54,29 @@ class Validator:
             if missing is not None:
                 raise InvalidFieldException(msg, qid, missing)
 
-    def getQuestionData(self) -> QuestionData:
-        """Get the data from the spreadsheet as a dictionary."""
-        self.qdata: dict[str, int | float | list[str] | str] = {}
-        for idx, val in self.df.items():
-            if not isinstance(idx, str):
+    @staticmethod
+    def dfToDict(df: pd.Series) -> dict[str, int | float | list[str] | str]:
+        """Convert a dataframe to dictionary, preserving lists."""
+        dic: dict[str, int | float | list[str] | str] = {}
+        for var, val in df.items():
+            if not isinstance(var, str):
                 continue
             if pd.isna(val):
                 continue
-            if idx in self.qdata:
-                if isinstance(self.qdata[idx], list):
-                    self.qdata[idx].append(val)
+            if var in dic:
+                if isinstance(dic[var], list):
+                    dic[var].append(val)
                 else:
-                    existing = self.qdata[idx]
-                    self.qdata[idx] = [existing, val]
+                    existing = dic[var]
+                    dic[var] = [existing, val]
             else:
-                self.qdata[idx] = val
-        return self.formatQData()
-
-    def formatQData(self) -> QuestionData:
-        """Format the dictionary to The types for QuestionData."""
-        listTags = (Tags.BPOINTS, Tags.TRUE, Tags.FALSE, Tags.TEXT, Tags.QUESTIONPART)
-        for tag in listTags:
-            for key in self.qdata:
-                if key.startswith(tag) and not isinstance(self.qdata[key], list):
-                    self.qdata[key] = stringHelpers.getListFromStr(self.qdata[key])
+                dic[var] = val
+        return dic
+
+    def getQuestionData(self) -> QuestionData:
+        """Get the data from the spreadsheet as a dictionary."""
+        self.qdata = self.dfToDict(self.df)
+        self.listify(self.qdata)
         tol = float(self.qdata.get(Tags.TOLERANCE, 0))
         if tol < 0 or tol > 99:
             tol = settings.get(Tags.TOLERANCE)
@@ -89,6 +87,18 @@ class Validator:
             self.qdata[Tags.EQUATION] = str(self.qdata[Tags.RESULT])
         return QuestionData(self.qdata)
 
+    @staticmethod
+    def listify(dictionary: dict) -> None:
+        """Converts to list all tag values, which are supposed to be a list."""
+        for key in dictionary:
+            k: str = key.split(":")[0]
+            if k in Tags:
+                tag = Tags(k)
+                logger.info("Got the Tag %s from key: %s", tag, key)
+                if tag.typ() is list and not isinstance(dictionary[key], list):
+                    dictionary[key] = stringHelpers.getListFromStr(dictionary[key])
+                    logger.info("Converted Input to list for %s", key)
+
     def _mandatory(self) -> tuple[bool, Tags | None]:
         """Detects if all keys of mandatory are filled with values."""
         checker = pd.Series.notna(self.df)

excel2moodle-0.6.4/excel2moodle/extra/updateQuery.py

@@ -0,0 +1,48 @@
+"""This module provides functions to query the GitLab API for project information."""
+
+import json
+import sys
+import urllib.request
+
+
+def get_latest_tag(project_id: str) -> str | None:
+    """Queries the GitLab API for the latest tag of a project.
+
+    Args:
+        project_id: The URL-encoded project ID (e.g., 'jbosse3%2Fexcel2moodle').
+
+    Returns:
+        The name of the latest tag.
+
+    """
+    url = f"https://gitlab.com/api/v4/projects/{project_id}/repository/tags"
+    try:
+        with urllib.request.urlopen(url) as response:
+            if response.status == 200:
+                data = json.loads(response.read().decode())
+                if data:
+                    return data[0]["name"]
+    except urllib.error.URLError as e:
+        print(f"Error fetching latest tag: {e}", file=sys.stderr)
+    return None
+
+
+def get_changelog(project_id: str, branch: str = "master") -> str:
+    """Queries the GitLab API for the content of the CHANGELOG.md file.
+
+    Args:
+        project_id: The URL-encoded project ID (e.g., 'jbosse3%2Fexcel2moodle').
+        branch: The branch to get the file from.
+
+    Returns:
+        The content of the CHANGELOG.md file.
+
+    """
+    url = f"https://gitlab.com/api/v4/projects/{project_id}/repository/files/CHANGELOG.md/raw?ref={branch}"
+    try:
+        with urllib.request.urlopen(url) as response:
+            if response.status == 200:
+                return response.read().decode()
+    except urllib.error.URLError as e:
+        print(f"Error fetching changelog: {e}", file=sys.stderr)
+    return ""