edlearn_client

Crates.ioedlearn_client
lib.rsedlearn_client
version0.2.0
sourcesrc
created_at2024-02-10 00:40:26.372604
updated_at2024-02-28 12:41:12.281087
descriptionA client for Edinburgh Uni's Learn API
homepagehttps://git.tardisproject.uk/tcmal/learn-tui
repositoryhttps://github.com/tcmal/learn-tui
max_upload_size
id1134537
size26,034
Aria (tcmal)

documentation

https://docs.rs/edlearn_client

README

asciicast

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.

Commit count: 0

cargo fmt