An open API service indexing awesome lists of open source software.

https://github.com/jarjk/rsfilc

[mirror] RozsdásFilc: an E-Kréta console client in Rust.
https://github.com/jarjk/rsfilc

cli kreta kreta-api rust

Last synced: 23 days ago
JSON representation

[mirror] RozsdásFilc: an E-Kréta console client in Rust.

Awesome Lists containing this project

README

          

# [RozsdásFilc](https://codeberg.org/jark/rsfilc): [E-Kréta](https://www.e-kreta.hu/) konzol kliens [Rust](https://rust-lang.org)ban

> [English README](README.md)

[![dependency status](https://deps.rs/repo/codeberg/jark/rsfilc/status.svg)](https://deps.rs/repo/codeberg/jark/rsfilc)

## Letöltés

- egyszerűen: szerezz egy előre megépített futtatható programot [innétről](https://codeberg.org/jark/rsfilc/releases/latest)

ha esetleg nem elérhető a platformodra([tudasd ezt velünk](https://codeberg.org/jark/rsfilc/issues/new)), nem tetszik az ötlet, vagy nem elég új:

- [Rust](https://rustup.rs)
- `cargo install --locked rsfilc`
> legújabb, kevésbé tesztelt: `cargo install --locked --git "https://codeberg.org/jark/rsfilc"`

### autókitöltés:


Bash

> Add a `~/.bashrc` **végére** :
>
> ```sh
> eval "$(rsfilc completions bash)"
> ```


Zsh

> Add a `~/.zshrc` **végére** :
>
> ```sh
> eval "$(rsfilc completions zsh)"
> ```


Fish

> Add a `~/.config/fish/config.fish` **végére**:
>
> ```fish
> rsfilc completions fish | source
> ```


PowerShell

> Add a **végére** a beállításaidnak (így találod `echo $profile` PowerShell-ben):
>
> ```powershell
> Invoke-Expression (& { (rsfilc completions powershell | Out-String) })
> ```


Elvish

> Add a `~/.elvish/rc.elv` **végére**:
>
> ```sh
> eval (rsfilc completions elvish | slurp)
> ```

## Használat

kedves kis használati utasítás: `rsfilc --help`
bejelentkezés fiókba: `rsfilc user --login `

### jól vésd eszedbe!

- ha megbotlasz, először nézz a lábad elé: `rsfilc --help`
- ha a vároteremben nagy a tömeg, nézdd mit tartalmaz zsebed, környezeti változók használatát ne feledd, állítsd be `1`-re a `NO_NET`, tegyük fel linuxon így műveled: `NO_NET=1 rsfilc timetable`
- ha attól tartasz zsebed kacatokkal tele, mondj egy hasonlót: `NO_CACHE=1 rsfilc absences`, vagy használd a `clap`-et: `rsfilc user --cache-dir`
- ha egy adott nap már nincs több órád, s te mégis mondád: `rsfilc (timetable|tt)`, megjelenik a legközelebbi órákkal tarkított napod, ha te ezt mégsem akarod: `rsfilc tt +0` avagy `rsfilc tt -- -0` a barátod

![demo](./assets/demo.gif "using rsfilc")

## Finomságok

### átnevezés

no mit is nevezhetsz át: közel bármit. pl: tanárok, tantárgyak neveit
hogyan: nédd hol van a beállítások fájl így `rsfilc --config-path` és írd át a `rename`-t ahogy tetszik
persze kíváncsi lehetsz ez hogyan megy: [tegyük fel imigyen](./assets/example-config.toml)
ha épp úgy érzed, hogy semmit nem akarsz átnevezni, alkalmazd a `NO_RENAME=1` környezeti változót (*deviszont*: ez a *cache*t nem írja felül, úgyhogy onnan maradhat még átírás)

### nem rendszerhez kötött: nincs különösebben letesztelve, de elvileg fut

- linuxon
- windowson
- macOSen
- androidon Termuxon
- mindenen amit támogat a Rust

## CLI

- [x] API alapvető használata
- [x] kért adatok alapvető megjelenítése
- [x] több fiókos rendszer
- [x] üzenetek (`html`) elfogadható megjelenítése
- [x] üzenetek (`html`) megjelenítése `w3m`-mel vagy `lynx`-el ha lehetséges
- [x] shell autókitöltések: [bash, zsh, fish, elvish, powershell]
- [x] hibajelentések: esetleg `fern`
- [ ] segítőkész hibaüüzenetek
- [x] kb minden cache-elése a valódi élmény érdekében
- [x] token
- [x] órarend
- [x] jegyek
- [x] felhasználó adatai
- [x] hiányzások
- [x] bejelentett számonkérések
- [x] üzenetek
- [x] jelszavak titkosítása mentéshez
- [ ] üzenetek küldése
- [ ] osztályátlagok
- [ ] ügyintézések lekérése
- [ ] ügyintézések indítása
- [ ] ...

## Elismerések, alternatívák, hasonló appok, dokumentáció, ...

Minden használatba vett `crate`-nek köszönet, [itt](./Cargo.toml) találtatnak.
Tessék egy pillantást vetni az [ekreta-rs]-re, mely a használt API kliens az E-Krétahoz
Autókitöltés dokumentáció leírás innen: [zoxide](https://github.com/ajeetdsouza/zoxide)
Jó kis dokumentáció:
Rengeteg dolgot tartalmazó dokumentáció, *mondjuk sose használtam...*:
Rust konzol-kliens, jó kis funkciókkal (ical export, ...) *valamiért újraírta a tag kb az egész [ekreta-rs]-t...*:
Kb 5. újraírása az eredeti alternatív GUI naplónak, Filc: &
Konzol, ami az előző appon alapul:

[ekreta-rs]: https://codeberg.org/jark/ekreta-rs