Moodl-rs is a utility tool designed to create offline versions of your university courses available on Moodle. It streamlines the process of downloading, organizing, and accessing course materials in an offline format, giving you the flexibility to not use the new Moodle UI.
- Store course content in an sqlite database
- Fetch and parse course material including PDFs, PPTXs, etc.
- Download and organize course materials offline
- Convert course page to a markdown file
- Tracking courses with ease
- Configuration via a TOML file
- Ensure that sqlite is installed on your system. It is included in the flake if you’re using nix.
- You will need to have Rust’s
cargoinstalled to run the application for now. If there’s enough interest precompiled binaries will become available.
A precompiled windows binary is available as a v0.1-beta release meant to run as a standalone application from the command line.
cd path\to\your\moodl-rs.exe
moodl-rs.exe- Clone the repository to your local system.
- Navigate to the project directory in the terminal.
- Run the following command to start Moodl-rs:
cargo runUpon first initialization, a config.toml file will be placed in \~/.config/moodl-rs, and the database will be stored at \~/.local/share/moodl-rs.
Follow the on-screen instructions to initialize user information, set your Moodle URL, API token, and select the courses you want to track:
Choose a command to run:
[i] Init - Initialize user information
Ensure 'config.toml' has your Moodle Mobile Service Key and URL.
[f] Fetch - Fetch course material
This will populate 'moodl-rs.db' with all course material
[D] Download - Downloads all course materials(.pdfs, .pptxs, etc.)
Default location is ~/ on linux/mac and typically C:\Users\<YourUserName> on windows
Set the path for each course in 'config.toml' to save materials elsewhere
[p] Parse - Parse the course page to a markdown file
Default location is ~/ on linux/mac and typically C:\Users\<YourUserName> on windows
Set the path for each course in 'config.toml' to save markdown elsewhere
[d] Default - Run fetch, download, parse sequentially
i
Would you like to configure your moodle url and API token now?
You will only have to do this once.
[y] Yes, configure now
[n] No, skip and configure manually
...
Track the course TEST_COURSE_1?
[y] Yes, track it
[n] No, skip it
n
Track the course TEST_COURSE_2?
[y] Yes, track it
[n] No, skip it
y
Track the course TEST_COURSE_3?
[y] Yes, track it
[n] No, skip it
nConfigure Moodl-rs through the config.toml file located at ~/.config/moodl-rs/config.toml. Initially, it should resemble the following structure:
## config.toml
## This holds the default configuration for moodl-rs
## Update this with your own information
## API
## The base_url and token are required before starting
## initilization will fetch your userid
[api]
base_url = "your.site.com"
token = "12345x7rb2n3456zo1i6ai8nquh5j18c"
userid = 123456
## Courses
## The id and shortname will be updated with your new courselist
## once you initialize the database, then the path can be updated
[[courses]]
id = 1
shortname = "ONE"
## Course path will automatically be prefixed with ~/
path = "course-path-one"
[[courses]]
id = 2
shortname = "TWO"
## Course path will automatically be prefixed with ~/
path = "course-path-two"Once set up, you can run various commands to fetch, download, and parse selected course materials:
Choose a command to run:
[i] Init - Initialize user information
Ensure 'config.toml' has your Moodle Mobile Service Key and URL.
[f] Fetch - Fetch course material
This will populate 'moodl-rs.db' with all course material
[D] Download - Downloads all course materials(.pdfs, .pptxs, etc.)
Default location is ~/ on linux/mac and typically C:\Users\<YourUserName> on windows
Set the path for each course in 'config.toml' to save materials elsewhere
[p] Parse - Parse the course page to a markdown file
Default location is ~/ on linux/mac and typically C:\Users\<YourUserName> on windows
Set the path for each course in 'config.toml' to save markdown elsewhere
[d] Default - Run fetch, download, parse sequentiallyNow you can run the default command to fetch, download, and parse all your selected course materials.
The default location is \~/ on Linux/Mac and typically C:\\Users\\<YourUserName> on Windows. You can change the save path for each course in the config.toml file.
Re-run the initialization command and follow the prompts to add or remove courses from the tracking list.
We welcome contributions! Feel free to fork the repository and submit a pull request with your changes.
The API token can be obtained from your Moodle website. Log into your account and navigate to your user preferences, which is usually accessible through your profile or settings page. From there, go to “Security keys” and find the “Moodle Mobile additional features service” section to get your token. Keep this token secure and do not share it with others.
The base URL is the web address of your Moodle website, where you access your courses online. It often looks like “urcourses.uregina.ca” or a similar format, depending on your institution. You should enter this URL without any additional paths or parameters into the `base_url` field in the `config.toml` file.
You don’t need to worry about the user ID while setting up Moodl-rs. During the initial setup and configuration process, the user ID will be automatically fetched and updated in the `config.toml` file. Ensure that the base URL and token are correctly configured, and the application will take care of the rest.