odweta/solon
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Wed Jun 21 15:43:39 CEST 2023

Browse Source
This commit is contained in:
mnjx
2023-06-21 17:52:01 +02:00
parent 66297ecc0c bed32387c5
commit 1a31682c83
12 changed files with 290 additions and 159 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+20 -8
View File
@@ -1,4 +1,4 @@
# SOL Enhanced
# Solen (ŠOL Enhanced)
An enhanced version of the ŠkolaOnLine (ŠOL) online school system.
@@ -11,15 +11,15 @@ Insiration was taken from [@JakubAndrysek](https://github.com/JakubAndrysek)'s [
# Features
+ Shows the schedule for the current week
+ Shows all grades and their arithmetic average (not accounting for weight)
+ Works offline (when the internet has been accessed at least once before)
+ Shows the schedule for the current week
+ Shows all grades and their weighted average
+ Works offline (when the internet has been accessed at least once before)
# Installation
**Clone the repo**
`git clone https://github.com/mnjx/sol-enhanced.git`
`git clone https://github.com/mnjx/sol-enhanced`
**Navigate into the repo directory**
@@ -31,8 +31,9 @@ Insiration was taken from [@JakubAndrysek](https://github.com/JakubAndrysek)'s [
**Run the program**
From the repo folder: `make run`
From anywhere on the computer: `solen`
| ------------------------------ | ---------- |
| From the repo folder: | `make run` |
| From anywhere on the computer: | `solen` |
# Usage
@@ -42,4 +43,15 @@ 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`).
An option for command-line arguments will be added in the future.
There are optional command-line arguments for filtering what should be displayed.
Here they are:
| ----------------------------------- | --------------------------------------------------------------------------------------- |
| -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 |