README.md

StudDP

StudDP is a file downloader for Stud.IP. It uses the Stud.IP: Rest.IP plugin to download files when they changed or are not existent on the file system.

SetUp

To set it up, do the following:

git clone https://github.com/Faedrivin/StudDP
cd StudDP
cp default_config.json config.json

Modify the config.json:

{
    "username": "",
    "password": "",
    "base_address": "https://studip.uos.de/plugins.php/restipplugin",
    "local_path": "~/studip",
    "interval": 1200,
    "last_check": -1,
    "courses_selected": false,
    "courses": []
}

• username is your login name.
• password is your password.
• base_address is the addres up to the root of your Rest.IP plugin. Leave out any trailing slashes.
• local_path is your local folder where files should be downloaded to.
• interval is the checking interval in seconds (so the default is 20 minutes).
• last_check is the last timestamp when checks were performed. Leave this as -1.
• courses is your list of courses to download. You set this when running the program first. Reset this to [] if you want to change your selection.
• courses_selected tells the program if you have chosen your courses. Leave this to false, reset to true if you want to change your selection.

Run

When running for the first time, use:

./StudDP.py

To run it use:

./StudDP.py&

To stop it use:

./stop.sh

Other information

To view the log use:

tail -f ~/.studdp/info.log

To uninstall use:

rm -rf StudDP
rm -rf ~/.studdp