rsfilc

Crates.iorsfilc
lib.rsrsfilc
version0.8.14
sourcesrc
created_at2024-04-09 07:11:28.544554
updated_at2024-06-12 17:05:31.533613
descriptionA Kréta API and console client: cli and todo!("TUI"), written entirely in Rust from the ground up.
homepage
repositoryhttps://codeberg.org/jark/rsfilc
max_upload_size
id1202003
size1,259,564
(JeromeSchmied)

documentation

README

RozsdásFilc: E-Kréta console client in Rust

E-Kréta is an awful Hungarian electronic school administration system

Magyar leírás

dependency status

IMPORTANT!

When upgrading from v0.5.21, credentials have to be recreated. It's necessary, as from v0.5.22, encoding is used for storing passwords.

  1. You have to manually find and delete them. A user called Alice would find credentials under:
    • linux: /home/alice/.config/rsfilc/credentials.toml
    • windows: C:\Users\Alice\AppData\Roaming\rsfilc\credentials.toml
    • mac: /Users/Alice/Library/Application Support/rsfilc/credentials.toml
  2. recreate all users with rsfilc user --create

Installation

  • Rust

  • cargo install --locked rsfilc

    for latest, beta builds: cargo install --locked --git "https://codeberg.org/jark/rsfilc"

Dependencies

optional, recommended

  • lynx: for enjoyable (html) message previews
  • w3m: for enjoyable (html) message previews

Shell completions:

Bash

Add this to the end of your config file (usually ~/.bashrc):

eval "$(rsfilc completions bash)"
Zsh

Add this to the end of your config file (usually ~/.zshrc):

eval "$(rsfilc completions zsh)"

For completions to work, the above line must be added after compcompletions is called. You may have to rebuild your completions cache by running rm ~/.zcompdump*; compcompletions.

Fish

Add this to the end of your config file (usually ~/.config/fish/config.fish):

rsfilc completions fish | source
PowerShell

Add this to the end of your config file (find it by running echo $profile in PowerShell):

Invoke-Expression (& { (rsfilc completions powershell | Out-String) })
Elvish

Add this to the end of your config file (usually ~/.elvish/rc.elv):

eval (rsfilc completions elvish | slurp)

Note RsFilc only supports elvish v0.18.0 and above.

Usage

rsfilc --help

demo

Features

cross-platform: not tested thoroughly but should run on

  • linux
  • windows
  • macOS
  • android via Termux
  • everything else that Rust supports

API

  • Kréta API URL fetching (no clue what they do)

  • school fetching from reFilc API

  • user info fetch (json)

    • token
    • basic information
    • evaluations/grades
    • timetable
    • messages
      • attachments
    • announced test
    • absences

  • usable user info (in structs)

    • token
    • basic information
    • evaluations/grades
    • timetable
    • messages
      • attachments
    • announced test
    • absences

CLI

  • basic usage of API
  • filtering what to show
  • multi-user feature
  • somehow rendering html that messages return
  • render html messages with w3m or lynx if possible
  • shell completions: [bash, zsh, fish, elvish, powershell]
  • logger: fern maybe
  • helpful crashes
  • caching everything so that life remains enjoyable
    • token
    • timetable
    • evals
    • user info
    • absences
    • announced tests
    • messages
    • note messages
  • encoding passwords
  • sending messages
  • class averages
  • fetching administrational processes
  • starting new administrational processes

TUI

  • multiple pages

    • evaluations
    • timetable
    • ...

  • beautifully displaying data

    • timetable in nice table
    • plotting evaluations
    • ...

Acknowledgements

Commit count: 0

cargo fmt