Assignment Feedback

Prerequisites

Python

This tool is written in python (v3.11) and has thus to be run with python 3.
It has the following requirements:

Packages:

• click
• pandas
• tabulate

The packages may be installed all at once with the file requirements.txt:

pip install -r requirements.txt

or individually:

pip install click
pip install pandas
pip install tabulate

Note: Both approaches need to refer to the pip-installer associated to the python installation, that will be used to run the tool.

Usage

The CLI - Command Line Interface

> python3 assignment_feedback.py [-l <str>] [-o <directorypath>] [-c <filepath>] 
 
-l,    --lecture-marker,        string-marker to be added to output filenames, default="ssbi24"
-o,    --output-directory,      output directory for produced subdirectories and assignment feedbacks, default=""
-c,    --config,                filepath to configuration file containing all specifications of the assignments (see example: config.txt), default='config.txt'

Input

This tool requires multiple CSV-files, each associated with assignment containing its feedback and the reached points of each task (see example: example/grading_example.txt). Each line of the CSV-files are to contain these information, each split by a comma and each surrounded by quotation-marks:

• List of all group members:
  "<member_1>,<member_2>,<member_X>"
• Feedbacks for each task (3 options)
  • simply returning points reached:
    "<total_task_points_reached>"
  • returning points reached with single-line comment:
    "<total_task_points_reached>:<points_substracted> <comment>"
  • returning points reached with multiple lines of comments (split by a '|'-symbol):
    "<total_task_points_reached>:<pts_substr> <comment>|<pts_substr> <comment>"

The enumeration, the paths, and the maximum reachable points of each task need to be specified and given in a separate configuration file (see example: example/config_example.txt).

Output

This tool returns all created feedbacks for the given assignments in Markdown format (see example: example/ass1).

Example

The tool can be run like this:

python3 assignment_feedback.py -c example/config_example.txt
python3 assignment_feedback.py -o /home/user/docs/all_feedbacks -c /home/user/docs/configuration.txt

Authors

• Alexander Röhl