https://github.com/simonschiller/tutorbot
Command line tool for programming tutors at the University of Applied Sciences in Hagenberg
https://github.com/simonschiller/tutorbot
command-line-tool kotlin university
Last synced: 29 days ago
JSON representation
Command line tool for programming tutors at the University of Applied Sciences in Hagenberg
- Host: GitHub
- URL: https://github.com/simonschiller/tutorbot
- Owner: simonschiller
- License: mit
- Created: 2020-04-24T13:58:06.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2021-01-25T15:24:11.000Z (over 5 years ago)
- Last Synced: 2025-01-15T10:58:13.386Z (over 1 year ago)
- Topics: command-line-tool, kotlin, university
- Language: Kotlin
- Size: 1.59 MB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/simonschiller/tutorbot/actions)
[](https://github.com/simonschiller/tutorbot/releases)
[](https://github.com/simonschiller/tutorbot/blob/master/LICENSE)
# Tutorbot
Tutorbot is a simple command line tool that helps programming tutors at the University of Applied Sciences in Hagenberg by automating repetitive tasks.
### Features
Tutorbot comes with a range of different features, it can support you by:
* downloading (and extracting) all submissions for a certain exercise
* checking submissions for plagiarism
* downloading all reviews for a certain exercise
* sending feedback emails to students
### Configuration
Tutorbot requires different user inputs, some of them are likely repetitive. To avoid repeating them every time, these inputs can be stored in a configuration file. Currently the configuration file supports the following values:
```properties
# Moodle username
username=Sxxxxxxxxxx
# Download location for submissions
location.submissions=/foo/bar/submissions
# Download location for reviews
location.reviews=/foo/bar/reviews
# Java language version used by JPlag for plagiarism detection (default is Java 1.9)
plagiarism.language.java.version=java19
```
For Tutorbot to detect this file, it should be located in the same directory as the `tutorbot.jar` and should be called `tutorbot.properties`. It is also possible to configure those parameters using environment variables:
| Environment variable | Description |
| --- | --- |
| `TUTORBOT_USERNAME` | Moodle username |
| `TUTORBOT_LOCATION_SUBMISSIONS` | Download location for submissions |
| `TUTORBOT_LOCATION_REVIEWS` | Download location for reviews |
| `TUTORBOT_PLAGIARISM_LANGUAGE_JAVA_VERSION` | Java language version used by JPlag for plagiarism detection (default is Java 1.9) |
Values from the properties file will take precedence over values from environment variables if both are specified.
### Buildling this project
Tutorbot is built using Gradle. You don't need to install anything, as the Gradle wrapper is included in the repository. To build the project, simply execute `./gradlew jar`, the resulting JAR file will be located under `/build/libs/tutorbot.jar`. Please note that a JDK with version 11 or higher is required to build and run this tool, this limitation comes from JPlag.