kahoot-to-anki 1.0.0__tar.gz

kahoot_to_anki-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Simon Hardmeier
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice (including the next paragraph) shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

kahoot_to_anki-1.0.0/PKG-INFO

@@ -0,0 +1,16 @@
+Metadata-Version: 2.4
+Name: kahoot-to-anki
+Version: 1.0.0
+Summary: CLI tool to convert Kahoot quiz reports into Anki flashcards
+Author: Simon Hardmeier
+License-Expression: MIT
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: genanki
+Requires-Dist: pandas
+Requires-Dist: openpyxl
+Dynamic: license-file
+
+# kahoot-to-anki
+> python cli program to convert Kahoot quiz results to Anki flashcards

kahoot_to_anki-1.0.0/README.md

@@ -0,0 +1,2 @@
+# kahoot-to-anki
+> python cli program to convert Kahoot quiz results to Anki flashcards

kahoot_to_anki-1.0.0/kahoot_to_anki/__init__.py

@@ -0,0 +1 @@
+"""CLI tool to convert Kahoot quiz reports into Anki flashcards."""

kahoot_to_anki-1.0.0/kahoot_to_anki/converter.py

@@ -0,0 +1,254 @@
+# Standard library imports
+import argparse
+import logging
+import os
+import glob
+
+# Third-party library imports
+import genanki
+import pandas as pd
+
+# Configure logging settings
+logging.basicConfig(level=logging.INFO)
+
+# Constants
+DEFAULT_INPUT_DIRECTORY = "./data"
+DEFAULT_OUTPUT_DIRECTORY = "./"
+DEFAULT_DECK_TITLE = "Kahoot"
+KAHOOT_EXCEL_SHEET_NAME_RAW_DATA = "RawReportData Data"
+
+
+def main():
+    # Check command line arguments
+    inp, out, csv, title = get_commandline_arguments()
+
+    validation(inp, out)
+
+    df = get_questions(inp)
+
+    if csv:
+        df.to_csv(
+            os.path.join(out, "kahoot.csv"),
+            sep=";",
+            index=False,
+            encoding="utf-8-sig",
+        )
+
+    make_anki(df, out, title)
+
+
+def get_commandline_arguments() -> tuple:
+    """
+    Parses the command line arguments and returns a tuple with the input path, output path, CSV option, and deck title.
+
+    :return: A tuple with the input path, the output path, the csv and the title of the anki deck
+    :rtype: tuple
+    """
+    parser = argparse.ArgumentParser(description="Create Anki Deck from Kahoot answer")
+    parser.add_argument(
+        "-i",
+        "--inp",
+        default=DEFAULT_INPUT_DIRECTORY,
+        help=f"Path to the directory containing input Excel files or a single input Excel file. If a directory is "
+        f"provided, all Excel files in the directory will be processed. Default: {DEFAULT_INPUT_DIRECTORY}",
+        type=str,
+    )
+    parser.add_argument(
+        "-o",
+        "--out",
+        default=DEFAULT_OUTPUT_DIRECTORY,
+        help="Path to the directory where the Anki flashcards package will be generated. "
+        "If not specified, the package will be created in the current working directory.",
+        type=str,
+    )
+    parser.add_argument(
+        "--csv",
+        action="store_true",
+        help="Generate a CSV file with the question data.",
+    )
+    parser.add_argument(
+        "-t",
+        "--title",
+        default=DEFAULT_DECK_TITLE,
+        help="Name of the Anki deck to be created. "
+        f"If not specified, the default deck name '{DEFAULT_DECK_TITLE}' will be used.",
+        type=str,
+    )
+    args = parser.parse_args()
+
+    # return absolute paths
+    return os.path.abspath(args.inp), os.path.abspath(args.out), args.csv, args.title
+
+
+def validation(input_directory: str, output_directory: str) -> None:
+    """
+    This function validates the command line arguments, checking if the input path is a valid Excel file or directory
+    and if the output path is a valid directory.
+    The input path needs to be an Excel file or a directory that contains Excel files.
+    The output path needs to be a directory and not a file.
+
+    :param input_directory: The path of the input Excel or directory
+    :param output_directory: The path of the output directory
+    :return: None
+    :rtype: None
+    """
+    # Check if input is a file
+    if not os.path.exists(input_directory):
+        logging.error(f"Input directory {input_directory} does not exist!")
+        raise FileNotFoundError(f"Input directory {input_directory} does not exist!")
+    elif (
+        os.path.isfile(input_directory)
+        and os.path.splitext(input_directory)[-1] != ".xlsx"
+    ):
+        logging.error("Input file is not an excel file!")
+        raise ValueError("Input file is not an excel file!")
+    elif os.path.isdir(input_directory):
+        input_excels = os.path.join(input_directory, "*.xlsx")
+        if not glob.glob(input_excels):
+            logging.error("Input directory does not contain any excel files!")
+            raise FileNotFoundError("Input directory does not contain any excel files!")
+
+    # Check output directory and create when not existing
+    if not os.path.isdir(output_directory):
+        logging.error("Output is not a directory!")
+        raise ValueError("Output is not a directory!")
+    if not os.path.exists(output_directory):
+        try:
+            os.makedirs(output_directory)
+        except OSError as e:
+            logging.error(
+                "Failed to create output directory '%s': %s", output_directory, str(e)
+            )
+            raise
+
+
+def get_questions(input_directory: str) -> pd.DataFrame:
+    """
+    Extracts all the kahoot questions out of the Excel file(s)
+
+    :param input_directory: The path to the input directory or Excel file
+    :return: All the questions with the possible answers and the solution
+    :rtype: pd.DataFrame
+    """
+
+    def get_excels(path):
+        """
+        Returns a list with all Excels in the given path
+        :param path: the path to an Excel file or a directory with Excel files
+        :return: a list with all excels
+        """
+        if os.path.isfile(path):
+            yield path
+        else:
+            yield from glob.glob(os.path.join(input_directory, "*.xlsx"))
+            return [f for f in glob.glob(os.path.join(path, "*.xlsx"))]
+
+    def get_excel_data(excel_file: str) -> pd.DataFrame:
+        """
+        Returns a pd.DataFrame with the kahoot raw data
+        :param excel_file: an Excel file with Kahoot raw data
+        :return: a DataFrame with the data
+        """
+        try:
+            # read file
+            return pd.read_excel(
+                excel_file, sheet_name=KAHOOT_EXCEL_SHEET_NAME_RAW_DATA
+            )
+        except ValueError:
+            logging.warning(
+                "Skipping file '%s' as it is not a valid Excel file.", excel_file
+            )
+            return None
+        except Exception as e:
+            logging.error("Failed to read file '%s': %s", excel_file, str(e))
+            return None
+
+    def df_processing(data: pd.DataFrame) -> pd.DataFrame:
+        """
+        Processes the Kahoot question data.
+        :param data: DataFrame with Kahoot question data
+        :return: Processed DataFrame
+        """
+        # delete duplicated questions
+        data = data.drop_duplicates(subset=["Question Number"])
+
+        data = data.fillna("")
+
+        data["Possible Answers"] = data[
+            ["Answer 1", "Answer 2", "Answer 3", "Answer 4", "Answer 5", "Answer 6"]
+        ].agg("<br>".join, axis=1)
+
+        # keep only needed columns
+        data = data[["Question", "Possible Answers", "Correct Answers"]]
+
+        return data
+
+    out = pd.DataFrame(columns=["Question", "Possible Answers", "Correct Answers"])
+
+    questions_cnt = 0
+    files_cnt = 0
+
+    for file in get_excels(input_directory):
+        df = get_excel_data(file)
+        if df is None:
+            continue
+        files_cnt += 1
+
+        df = df_processing(df)
+
+        # add to out dataframe
+        out = pd.concat([out, df], axis=0, ignore_index=True)
+
+        questions_cnt += len(df)
+
+    logging.info("Read input files: %d", files_cnt)
+    logging.info("Read questions: %d", questions_cnt)
+    out = out.drop_duplicates(subset=["Question"])
+    return out
+
+
+def make_anki(df: pd.DataFrame, out: str, title: str) -> None:
+    """
+    Creates an Anki deck from the given Kahoot questions
+
+    :param df: The kahoot questions in a pd.DataFrame
+    :param out: The path to the output directory
+    :param title: The title of the Anki deck
+    :return: None
+    """
+    my_model = genanki.Model(
+        1607392319,
+        "Simple Model",
+        fields=[
+            {"name": "Question"},
+            {"name": "Answer"},
+            {"name": "selects"},
+        ],
+        templates=[
+            {
+                "name": "Card 1",
+                "qfmt": "{{Question}}<br><br>{{selects}}",
+                "afmt": '{{FrontSide}}<hr id="answer">{{Answer}}',
+            },
+        ],
+    )
+
+    my_deck = genanki.Deck(2059400110, title)
+
+    for index, row in df.iterrows():
+        my_note = genanki.Note(
+            model=my_model,
+            fields=[row["Question"], row["Correct Answers"], row["Possible Answers"]],
+        )
+        my_deck.add_note(my_note)
+
+    try:
+        genanki.Package(my_deck).write_to_file(
+            os.path.join(out, "anki.apkg"),
+        )
+    except Exception as e:
+        logging.error("Failed to write Anki package file: %s", str(e))
+
+
+if __name__ == "__main__":
+    main()

kahoot_to_anki-1.0.0/kahoot_to_anki.egg-info/PKG-INFO

@@ -0,0 +1,16 @@
+Metadata-Version: 2.4
+Name: kahoot-to-anki
+Version: 1.0.0
+Summary: CLI tool to convert Kahoot quiz reports into Anki flashcards
+Author: Simon Hardmeier
+License-Expression: MIT
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: genanki
+Requires-Dist: pandas
+Requires-Dist: openpyxl
+Dynamic: license-file
+
+# kahoot-to-anki
+> python cli program to convert Kahoot quiz results to Anki flashcards

kahoot_to_anki-1.0.0/kahoot_to_anki.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+LICENSE
+README.md
+pyproject.toml
+kahoot_to_anki/__init__.py
+kahoot_to_anki/converter.py
+kahoot_to_anki.egg-info/PKG-INFO
+kahoot_to_anki.egg-info/SOURCES.txt
+kahoot_to_anki.egg-info/dependency_links.txt
+kahoot_to_anki.egg-info/entry_points.txt
+kahoot_to_anki.egg-info/requires.txt
+kahoot_to_anki.egg-info/top_level.txt
+tests/__init__.py
+tests/test_project.py

kahoot_to_anki-1.0.0/kahoot_to_anki.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

kahoot_to_anki-1.0.0/kahoot_to_anki.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+kahoot-to-anki = kahoot_to_anki.converter:main

kahoot_to_anki-1.0.0/kahoot_to_anki.egg-info/requires.txt

@@ -0,0 +1,3 @@
+genanki
+pandas
+openpyxl

kahoot_to_anki-1.0.0/kahoot_to_anki.egg-info/top_level.txt

@@ -0,0 +1,3 @@
+dist
+kahoot_to_anki
+tests

kahoot_to_anki-1.0.0/pyproject.toml

@@ -0,0 +1,23 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "kahoot-to-anki"
+version = "1.0.0"
+description = "CLI tool to convert Kahoot quiz reports into Anki flashcards"
+authors = [{ name = "Simon Hardmeier" }]
+license = "MIT"
+readme = "README.md"
+requires-python = ">=3.8"
+dependencies = [
+    "genanki",
+    "pandas",
+    "openpyxl"
+]
+
+[project.scripts]
+kahoot-to-anki = "kahoot_to_anki.converter:main"
+
+[tool.setuptools.packages.find]
+where = ["."]

kahoot_to_anki-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

kahoot_to_anki-1.0.0/tests/test_project.py

@@ -0,0 +1,226 @@
+# Standard library imports
+import shutil
+import os
+
+# Third-party library imports
+import numpy as np
+import pandas as pd
+import pytest
+
+# Local application/library imports
+import converter
+
+
+def generate_test_data():
+    # Create multiple lists
+    question_number = [
+        "Question 1",
+        "Question 1",
+        "Question 1",
+        "Question 2",
+        "Question 2",
+        "Question 2",
+    ]
+    question = [
+        "How is a code block indicated in Python?",
+        "How is a code block indicated in Python?",
+        "How is a code block indicated in Python?",
+        "Which of the following concepts is not a part of Python?",
+        "Which of the following concepts is not a part of Python?",
+        "Which of the following concepts is not a part of Python?",
+    ]
+    answer_1 = [
+        "Brackets",
+        "Brackets",
+        "Brackets",
+        "Pointers",
+        "Pointers",
+        "Pointers",
+    ]
+    answer_2 = [
+        "Indentation",
+        "Indentation",
+        "Indentation",
+        "Loops",
+        "Loops",
+        "Loops",
+    ]
+    answer_3 = [
+        "Key",
+        "Key",
+        "Key",
+        "Dynamic Typing",
+        "Dynamic Typing",
+        "Dynamic Typing",
+    ]
+    answer_4 = [
+        np.nan,
+        np.nan,
+        np.nan,
+        np.nan,
+        np.nan,
+        np.nan,
+    ]
+    answer_5 = [
+        np.nan,
+        np.nan,
+        np.nan,
+        np.nan,
+        np.nan,
+        np.nan,
+    ]
+    answer_6 = [
+        np.nan,
+        np.nan,
+        np.nan,
+        np.nan,
+        np.nan,
+        np.nan,
+    ]
+    correct_answers = [
+        "Indentation",
+        "Indentation",
+        "Indentation",
+        "Pointers",
+        "Pointers",
+        "Pointers",
+    ]
+    time_to_answer = [
+        "10",
+        "10",
+        "10",
+        "10",
+        "10",
+        "10",
+    ]
+    player = [
+        "Harry",
+        "Hermione ",
+        "Ron",
+        "Harry",
+        "Hermione ",
+        "Ron",
+    ]
+    answer = [
+        "Indentation",
+        "Indentation",
+        "Brackets",
+        "Dynamic Typing",
+        "Pointers",
+        "Dynamic Typing",
+    ]
+    correct_incorrect = [
+        True,
+        True,
+        False,
+        False,
+        True,
+        False,
+    ]
+    columns = [
+        "Question Number",
+        "Question",
+        "Answer 1",
+        "Answer 2",
+        "Answer 3",
+        "Answer 4",
+        "Answer 5",
+        "Answer 6",
+        "Correct Answers",
+        "Time Allotted to Answer (seconds)",
+        "Player",
+        "Answer",
+        "Correct / Incorrect",
+    ]
+
+    # Create DataFrame from multiple lists
+    df = pd.DataFrame(
+        list(
+            zip(
+                question_number,
+                question,
+                answer_1,
+                answer_2,
+                answer_3,
+                answer_4,
+                answer_5,
+                answer_6,
+                correct_answers,
+                time_to_answer,
+                player,
+                answer,
+                correct_incorrect,
+            )
+        ),
+        columns=columns,
+    )
+    return df
+
+
+@pytest.fixture(scope="session", autouse=True)
+def setup_and_teardown():
+    test_data_dir = "test_data"
+    test_data_dir_empty = "test_data_empty"
+    input_file_name = "input.xlsx"
+    empty_file_name = "empty.xlsx"
+
+    input_file_path = os.path.join(test_data_dir, input_file_name)
+    empty_file_path = os.path.join(test_data_dir, empty_file_name)
+
+    df = generate_test_data()
+
+    os.makedirs(test_data_dir, exist_ok=True)
+    df.to_excel(input_file_path, sheet_name="RawReportData Data", index=False)
+
+    os.makedirs(test_data_dir_empty, exist_ok=True)
+
+    # create empty excel
+    df_empty = pd.DataFrame()
+    df_empty.to_excel(empty_file_path)
+
+    # Yield to allow the test to run
+    yield
+
+    # Teardown: Cleanup the created files
+    if os.path.exists(test_data_dir):
+        shutil.rmtree(test_data_dir)
+    if os.path.exists(test_data_dir_empty):
+        shutil.rmtree(test_data_dir_empty)
+
+
+def test_validation_wrong_output():
+    with pytest.raises(ValueError):
+        assert converter.validation("test_data/", "test_data/input.xlsx")
+
+
+def test_validation_wrong_input_file():
+    with pytest.raises(FileNotFoundError):
+        assert converter.validation("test_data/in.txt", "test_data/")
+
+
+def test_validation_empty_input_directory():
+    with pytest.raises(FileNotFoundError):
+        assert converter.validation("test_data_empty/", "./output")
+
+
+def test_validation():
+    assert converter.validation('./test_data/', "./test_data/") is None
+
+
+def test_get_questions_wrong_excel():
+    assert converter.get_questions("test_data/empty.xlsx").shape[0] == 0
+
+
+def test_get_questions_file():
+    assert converter.get_questions("test_data/input.xlsx").shape[0] == 2
+
+
+def test_get_questions_directory():
+    assert converter.get_questions("test_data/").shape[0] == 2
+
+
+def test_make_anki():
+    df = converter.get_questions("test_data/input.xlsx")
+    converter.make_anki(df, "test_data/", "test")
+    # Check if output file exists
+    assert os.path.exists("test_data/anki.apkg") is True