tcmal / learn-tui

A TUI (terminal user interface) for Edinburgh University's Learn.

It provides a simple and fast interface for viewing course information and downloading files. Submitting assignments and editing courses are explicitly not goals: They are complex and you probably shouldn't trust random programs with your university assignments.

This could be adapted to work with other systems using Blackboard Learn, but the supported services and authentication process are currently tied to UoE.

Usage

To use, first install as normal using cargo. Currently only Linux is supported, but other systems should work. Run with edlearn_tui.

Developing

Development is split across several crates:

• edlearn_client - Rust wrapper around the web API
• bbml - A library for rendering a subset of HTML to be displayed in ratatui applications
• edlearn_tui - The main application

To learn more about the structure of each, check the rustdocs.

License

Unless otherwise noted, content in this repository is licensed under the GNU GPL v3.0.

learn-tui's Issues

Detect links to files & handle them properly

When a page links to a file, it would be good to detect that and open the file as we do normally, since otherwise the user has to be authenticated to learn already to open it in browser.

Windows Support

Heya, the project looks awesome! Can't wait to try it out.

Just wondering if there are any plans to release binaries for Windows plaforms?

Perhaps the dependency on the xdg crate might need some change (as they don't support Windows: whitequark/rust-xdg#28). Defaulting to %localappdata% or %appdata% would probably work no problem.