mattia/moodlefuse
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
moodlefuse/README.md
Mattia Mascarello 8c0f5b55f9
Added badge
2023-05-01 11:47:05 +02:00

1.6 KiB
Raw Blame History

moodlefuse - FUSE filesystem for Moodle

CodeFactor

This is a FUSE filesystem for Moodle. It allows you to mount your Moodle site as a filesystem and access your Moodle files as if they were local files.

It is a concept that has been around for a while, but I have not found any implementations that I could get to work, or that were not abandoned. This is my attempt at creating one.

Installation

First, you need to create a .env file with the following variables:

SITE=https://moodle.example.com
MOODLE_USERNAME=yourusername
PASSWORD=yourpassword
MOUNT=/path/to/mountpoint

Then, just run the python script with the requirements installed. You can use a virtual environment if you want.

pip install -r requirements.txt
python moodlefuse.py

This only works on Linux, as it uses FUSE. I have not tested it on Mac, but it could work there too.

Requirements

  • Python 3.6 or newer
  • fusepy - FUSE bindings for Python
  • requests - HTTP library for Python
  • python-dotenv - Python library for reading .env files

Features

  • Read-only filesystem to read your Moodle files and announcements
  • In-memory file caching mechanism
  • Automatic html-to-markdown conversion for announcements

Future enhancements

  • Forum viewing support
  • Persistent tree cache (currently it is built at every mount)
  • Better error handling
  • Better logging
  • Better documentation

Demo

Demo