inginious-coding-style 1.4.0

No project description provided

INGInious Coding Style

INGInious Coding Style is a plugin for INGInious 0.7 and up that allows tutors to grade several aspect of student submissions' coding style.

INGInious Coding Style should be easy to use for both tutors and students. The plugin adds new buttons and elements to various existing menus in the application that can be used to add and view coding style grades.

Documentation

Full documentation can be found here: https://pederha.github.io/inginious-coding-style/

Installation

pip install inginious-coding-style

Configuration

INGInious Coding Style is highly configurable and provides granular control of the majority of its features. Despite this, extensive configuration is not necessary, as the plugin tries to implement sensible defaults, and therefore should just work straight out of the box.

Minimal Configuration

The following YAML snippet provides the default plugin configuration, and is a good starting point for exploring the plugin's functionality:

plugins:
-   plugin_module: inginious_coding_style
    name: "INGInious Coding Style"

Full Configuration

Below is an example of a configuration making use of all available configuration options.

plugins:
-   plugin_module: inginious_coding_style
    name: "INGInious Coding Style"
    enabled:
        # This enables all default categories + 1 custom category
        - comments
        - modularity
        - structure
        - idiomaticity
        - coolness # Our custom category
    categories:
        # This is a definition for a new category
      - id: coolness
        name: Coolness
        description: How cool the code looks B-)
      # This redefines a default category
      - id: comments
        name: Kommentering
        description: Hvor godt kommentert koden er.
    submission_query:
        header: CSG
        priority: 3000
        button: true
    weighted_mean:
        enabled: true
        weighting: 0.25
        round: true
        round_digits: 2
    task_list_bars:
        total_grade:
            enabled: true
            label: Grade
        base_grade:
            enabled: true
            label: Correctness
        style_grade:
            enabled: true
            label: Coding Style

TODO

User Features

• Make each coding style grade progress bar on /course/<courseid> a clickable element that links to the relevant coding style grades page (/submission/<submissionid>/codingstyle) for the relevant task.

Admin/Tutor Features

• Add graded_by: List[str] attribute to CodingStyleGrades to record which admin/tutor graded the submission's coding style.

Plugin Configuration

• Add ability to enable/disable grading categories on a per-course basis.
• Add ability to enable/disable plugin on a per course-basis.

Robustness

• Better exception handling for Pydantic ValidationError. If something fails to validate, we should be able to display human-readable messages both in the web interface and in the logs.
• Add an "admin/tutor only" decorator that can be applied to methods that bars student users from calling them.
• Ability to revert submission grades to their base grades if weighted_mean is disabled.
  • Would need to be a button that when clicked iterates through top submissions (user_tasks collection), then for each submission queries the submissions collection and fetches the grade stored in the submission with the corresponding _id and overwrites the grade in user_tasks.

Developer Notes

This plugin uses htmx to provide some interactivity.