Notice

Data from http://inferno.dekanat.informatik.tu-darmstadt.de (course -> regulation, course -> credit points) is only accessible from inside TU Darmstadt network, e.g., VPN.

RUN

• Install mechanicalsoup, bs4, pystache, sqlite_dbm and mypy as dependencies:

  $ pip3 install --user -q mechanicalsoup pystache mypy sqlite_dbm

• Download data from tucan and inferno into a directory called 'cache', and create html+js+css files in a directory called 'gh-pages'.

  $ TUID_USER=xxyyxxxx TUID_PASS=xxxxxxxxxxxx sh make.sh

• Now copy the contents of gh-pages to a directory that is served by a webserver, for example via cp or rsync:

  $ cp -v -r gh-pages/* ~/.public_html/beautiful-tucan/

Docker

Alternatively, it is also possible to perform build and run using Docker:

docker build -t beautiful-tucan -f Dockerfile .
docker run --rm -e TUID_USER=<TU_USER> -e TUID_PASS=<TU_PASSWORD> -v <OUTPUT_PATH>:/dist beautiful-tucan

moment.js

If you want to use moment.js to generate ical files instead of just string manipulation, run before doing anything:

$ npm install
$ npm run init

Or use the npm.Dockerfile.

docker build -t beautiful-tucan -f npm.Dockerfile .
docker run --rm -e TUID_USER=<TU_USER> -e TUID_PASS=<TU_PASSWORD> -v <OUTPUT_PATH>:/dist beautiful-tucan

LICENCE

This code is based on tucan-crawler by davidgengenbach, which is GPL licenced. Because our code is based on GPL licenced code, this code is also GPL licenced.

Dependencies:

• mechanicalsoup is MIT licenced.
• pystache is MIT licenced.
• python / mypy is Python Software Foundation License (PSF).

Connection Error

Inferno is only accesible from TU Darmstadt network.

I connect with socks proxy over ssh to the c-pool's clientssh3 server. (Use the real address of clientssh3 instead of c3 in the following:)

ssh -D8888 -q -N c3

You need pysocks for compatibilty.

pip3 install pysocks

Then you can run beautiful tucan over the proxy from inside the university network

env all_proxy=socks4://localhost:8888 TUID_USER=xxyyxxxx TUID_PASS=xxxxxxxxxxxx sh make.sh