https://github.com/jvalue/made-exercise-feedback
https://github.com/jvalue/made-exercise-feedback
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/jvalue/made-exercise-feedback
- Owner: jvalue
- Created: 2023-04-08T13:19:07.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-03T09:26:33.000Z (over 1 year ago)
- Last Synced: 2025-03-11T10:59:10.970Z (about 1 year ago)
- Language: Python
- Size: 44.9 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# MADE Automatic Exercise Feedback
This repository contains code to automatically give feedback for exercise submissions for the MADE course at FAU Erlangen-Nürnberg.
# Install
Grading code is tested and supposed to run with the latest Python LTS version (3.11 at the time of writing, check https://devguide.python.org/versions/).
[Pip](https://pypi.org/project/pip/) is used for dependency management.
Use [venv](https://docs.python.org/3/library/venv.html) to manage a virtual environment for the project. If it is not already installed, install it on your machine using pip: `pip install virtualenv`
1. Create a virtual env: `python -m virtualenv env`
2. Activate the virtual env: `source env/bin/activate`
3. Install dependencies using pip (inside the virtual env): `pip install -r requirements.txt`.
# Execute
To run the automated grading, first activate the virtual env, then execute grading.py with an optional work directory as first argument.
1. `source env/bin/activate`
2. `python grading.py `
# Use with CI
To use the automated grading feedback in student repositories in MADE, use the GitHub Actions workflow in`ci/grading-feedback.yml`. It sets up a GitHub action with Python 11 and Jayvee and then executes `./run_grading.sh`.
The workflow creates badges for the exercise score. You can add them to markdown files via this pattern:
```md
```
# Notes
- The SQLAlchemy version <2 in requirements.txt is by design, see https://levelup.gitconnected.com/how-to-fix-attributeerror-optionengine-object-has-no-attribute-execute-in-pandas-eb635fbb89e4.