Giter VIP home page Giter VIP logo

reviz's Introduction

Reviz

Python 3 script to enable the use of text files as revision quizzes. Works on Windows, macOS and Linux.

What is this script for?

This script takes an input file (plain text file; no fancy formats) with questions specified in a simple format and tests the user with the questions. It supports auto-grading and self-grading.

Currently, only Fill-in-the-blank and Multiple-Choice Questions have been tested, but probably many other styles of questions can work :)

Preparing an Input File

You may refer to exampleInput.txt to see how an input file should look like.

Questions can be specified in the following format: <answer> |:| <question>

If it is a Multiple-Choice Question, it can be formatted this way: <answer> |:| <question> |:| <choices> (Note: "|:|" may not be necessary. Refer to the following section.)

Details of each field

(example sourced from: https://en.wikipedia.org/wiki/DNA)

1. Answer Field

Type the exact answer. Do note that auto-grader is case-sensitive. e.g. nucleic acids

2. Question Field

{} can be used to denote where a blank should be placed, e.g. DNA and ribonucleic acid (RNA) are {}; alongside proteins, lipids and complex carbohydrates (polysaccharides), they are one of the four major types of macromolecules that are essential for all known forms of life.

3. Choices Field

There are 2 ways in which choices can be formatted. For short choices, a simple way is to do the following: |:| <choice 1> :: <choice 2> :: <choice 3>

For longer choices, they can each be specified on a line. There is no limit on number of choices you may specify, although the auto-labelling will not work after 26 choices.

Complete Example

1. Fill-in-the-blank

nucleic acids |:| DNA and ribonucleic acid (RNA) are {}; alongside proteins, lipids and complex carbohydrates (polysaccharides), they are one of the four major types of macromolecules that are essential for all known forms of life.

will display as:

DNA and ribonucleic acid (RNA) are _____________; alongside proteins, lipids and complex carbohydrates (polysaccharides), they are one of the four major types of macromolecules that are essential for all known forms of life.

2. MCQ

A |:| DNA and ribonucleic acid (RNA) are {}; alongside proteins, lipids and complex carbohydrates (polysaccharides), they are one of the four major types of macromolecules that are essential for all known forms of life. |:| nucleic acids :: nucleobases :: amino acids :: nucleotides

or

A |:| DNA and ribonucleic acid (RNA) are {}; alongside proteins, lipids and complex carbohydrates (polysaccharides), they are one of the four major types of macromolecules that are essential for all known forms of life.
nucleic acids
nucleobases
amino acids
nucleotides

will both display as:

DNA and ribonucleic acid (RNA) are _____________; alongside proteins, lipids and complex carbohydrates (polysaccharides), they are one of the four major types of macromolecules that are essential for all known forms of life.
A: nucleic acids
B: nucleobases
C: amino acids
D: nucleotides

reviz's People

Contributors

wxwern avatar l-yc avatar

Forkers

lawruixi

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.