Skip to content

Latest commit

 

History

History
142 lines (100 loc) · 4.97 KB

README.md

File metadata and controls

142 lines (100 loc) · 4.97 KB
Raw

🎓 moodle-to-vikwikiquiz

Lines of code Build status Code quality Type hinting used Code style: Black

Recent activity Commits since latest release PRs welcome

📖 About

A CLI for converting graded Moodle quizzes saved as HTML files to a vik.viki quiz wikitext.

📥 Installation

✨ Easy

  1. Install pipx

  2. If using Linux: follow these steps.

  3. Run the following command in the terminal:

    pipx install moodle-to-vikwikiquiz

🛠️ Executable zipapp

  1. Download the .pyz file of the latest release from here.

  2. Run the following commands in the terminal:

    chmod +x moodle-to-vikwikiquiz_x.x.x.pyz
./moodle-to-vikwikiquiz_x.x.x.pyz [parameters]

🧑‍💻 Usage

moodle-to-vikwikiquiz [--verbose|-v] [--new|-n] [--recursive|-r] source_path

Parameters:

  • --new: Create a new quiz on vik.wiki by automatically opening an edit page for the new article.
  • --recursive: Import HTML files from the current directory recursively.
  • source_path: The absolute or relative path of the file or directory where the Moodle quiz HTML files are located. These HTML files should contain the Review page of the quizzes.

Always check and correct the output before submitting it to the wiki! This includes uploading all images and adding their filenames to the quiz manually.

📋 Features

  • Imports multiple HTML files at once (recursively, if desired)
  • Supports true or false, single and multiple choice questions
  • Opens an existing article or creates a new one on vik.wiki with the edit summary pre-filled
  • Formats LaTeX equations as wikitext
  • Adds the only remaining correct answer automatically if it can be determined from the grade
  • Asks for correct answers if it can't be determined from a graded question
  • Deduplicates questions with the same text
  • Prepares illustrations for batch upload
    • If they are unavailable: creates placeholders for them
  • Copies the generated wikitext to the clipboard

⏫ Updating

Run the following command in the terminal:

pipx upgrade-all

If you want this to run automatically, create a cron job:

  1. Open the crontab file:

    crontab -e

  2. Add this line to the beginning of the file:

    PATH=~/.local/bin

    If there is already a line beginning with PATH=, add :~/.local/bin to the end of it.

  3. Add the following line to the end of the file:

    @daily		pipx upgrade-all

    You may replace @daily with @weekly or @monthly.

🧑‍💻 Development

⌨️ Developing

After you make changes to the Python codebase, please check whether the supported minimum Python version has changed. Run the following command in the terminal:

vermin --backport argparse --backport enum --backport typing_extensions --eval-annotations .

If it has changed, update pyproject.toml accordingly.

🏗️ Building

  • Wheels (.whl):

    1. Install build: 
      python3 -m pip install --upgrade pip
pip install build
    2. Create the wheels: 
      python3 -m build

  • zipapp (.pyz):

    1. Install pipx
    2. Install shiv: 
      pipx install shiv
    3. Create the executable: 
      shiv --entry-point moodle_to_vikwikiquiz.main:main --output-file moodle-to-vikwikiquiz.pyz --reproducible .

📜 License

This project is licensed under the GNU General Public License v3.0. See the license file (or the GPL-3.0 license tab on GitHub) for its full text.