solon/README.md

Solen (ŠOL Enhanced)

An enhanced version of the ŠkolaOnLine (ŠOL) online school system.

It aims to provide more readable data than the web version and remove some of the annoyances of the mobile app. It is intended to be and Android app in the future, but so far it is only for Linux (not tested anywhere else).

Insiration was taken from @JakubAndrysek's skola-online-stahovani-znamek project.

Features

• Shows the schedule for the current week
• Shows all grades and their weighted average
• Works offline (if the internet has been accessed at least once before)

Installation

Clone the repo

HTTPS: git clone https://github.com/mnjx/solen SSH: git clone git@github.com:mnjx/solen.git

Navigate into the repo directory

cd solen

Install (superuser privileges required)

sudo make install

Run the program

Location	Command
From the repo folder:	make run
From anywhere on the computer:	solen

Usage

Upon startup, the user os prompted to enter their ŠkolaOnLine credentials. If the login proccess is successfull, the preconfigured functions in /bin/solen will execute. By default, the functions are: showing the schedule for this week, showing the schedule for today and tomorrow and showing the grades. You can edit that file if you want to change what is being displayed. Alternatively, you can edit the src/main.py and then do the install step (sudo make install). There are optional command-line arguments for filtering what should be displayed.

Here they are:

Optional argument	Description
-t, --today-tomorrow	show the schedule for today and tomorrow
-w, --week	show the schedule for this week
-g, --grades	show the grades
-u, --username	provide the username for login
-p, --password	provide the password for login
-l, --local	only show the local data without attempting to connect to the internet
-d, --delete-local-files	deletes all locally stored user data, including schedules, grades and login credentials
-b, --backup PASSPHRASE DESTINATION	securly backs up all local user data into a .tar.gz archive