From a84509b9bcdf00a4e290a40ae61aaf903b2acc10 Mon Sep 17 00:00:00 2001 From: edufour Date: Fri, 19 Jan 2024 19:11:09 +0000 Subject: [PATCH] Add contact info to gather archive data --- README.md | 85 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 43 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index 59addba..f44a87a 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,43 @@ -# MoodleScraper -A simple tool to download as many files from moodle as possible. -This was designed for me to easily build an archive of my courses at EPFL. It is still in development and was not built for other moodles. - -## Requirements -This script was written in python 3.10.4 and the following packages: - -| package | version | -|----------------|---------| -| beautifulsoup4 | 4.12.2 | -| requests | 2.31.0 | - -## Features -This script should be able to download all file directly linked to in moodle ressources and folders. It is not able to download files from secondary sources. - -## Usage -The script is pretty simple to use. Just provide a moodle link and authentication information like this: -``` -python main.py -u USER -p PASSWORD -d /moodle -m https://moodlearchive.epfl.ch/2019-2020/ -``` -If providing an url that doesn't end with the year, you must specify the year like this: -``` -python main.py -u USER -p PASSWORD -d /moodle -m https://moodle.epfl.ch/ -y 2023-2024 -``` -For speed or storage reasons you can tell the script to not download a specific kind of file: -``` -python main.py -u USER -p PASSWORD -d /moodle -m https://moodlearchive.epfl.ch/2019-2020/ -i mp4 -i mov -``` - -| argument | short | example | -|--------------------|-------|-------------------------| -| --username | -u | username | -| --password | -p | superstrongpassword | -| --moodle_url | -m | https://moodle.epfl.ch/ | -| --academic_year | -y | 2023-2024 | -| --storage_dir | -d | /moodle | -| --ignore_extension | -i | mp4 | - -## Planned -- [ ] Download submission files -- [ ] Create url files for secondary urls -- +# MoodleScraper +A simple tool to download as many files from moodle as possible. +This was designed for me to easily build an archive of my courses at EPFL. It is still in development and was not built for other moodles. +If used and if you don't mind, please send me the result at edouard.dufour@micro-ondes.ch for my personal archive. + +## Requirements +This script was written in python 3.10.4 and the following packages: + +| package | version | +|----------------|---------| +| beautifulsoup4 | 4.12.2 | +| requests | 2.31.0 | + +## Features +This script should be able to download all file directly linked to in moodle ressources and folders. It is not able to download files from secondary sources. + +## Usage +The script is pretty simple to use. Just provide a moodle link and authentication information like this: +``` +python main.py -u USER -p PASSWORD -d /moodle -m https://moodlearchive.epfl.ch/2019-2020/ +``` +If providing an url that doesn't end with the year, you must specify the year like this: +``` +python main.py -u USER -p PASSWORD -d /moodle -m https://moodle.epfl.ch/ -y 2023-2024 +``` +For speed or storage reasons you can tell the script to not download a specific kind of file: +``` +python main.py -u USER -p PASSWORD -d /moodle -m https://moodlearchive.epfl.ch/2019-2020/ -i mp4 -i mov +``` + +| argument | short | example | +|--------------------|-------|-------------------------| +| --username | -u | username | +| --password | -p | superstrongpassword | +| --moodle_url | -m | https://moodle.epfl.ch/ | +| --academic_year | -y | 2023-2024 | +| --storage_dir | -d | /moodle | +| --ignore_extension | -i | mp4 | + +## Planned +- [ ] Download submission files +- [ ] Create url files for secondary urls +-