Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.8", "3.9", "3.10", "3.11"]
python-version: ["3.11", "3.12", "3.13", "3.14"]

steps:
- uses: actions/checkout@v3
Expand Down
25 changes: 18 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Downloads the following materials:

## Installation

This software requires **Python 3.6 or higher**.
This software requires **Python 3.11 or higher**.

### Using `pip` (recommended)

Expand Down Expand Up @@ -81,13 +81,15 @@ deactivate # leave virtual environment
The following command line arguments are available:

```bash
usage: python3 -m syncmymoodle [-h] [--secretservice] [--user USER]
[--password PASSWORD] [--totp TOTP] [--totpsecret TOTPSECRET] [--config CONFIG]
[--cookiefile COOKIEFILE] [--courses COURSES]
[--skipcourses SKIPCOURSES]
usage: python3 -m syncmymoodle [-h] [--secretservice] [--secretservicetotpsecret]
[--user USER] [--password PASSWORD]
[--totp TOTP] [--totpsecret TOTPSECRET]
[--config CONFIG] [--cookiefile COOKIEFILE]
[--courses COURSES] [--skipcourses SKIPCOURSES]
[--semester SEMESTER] [--basedir BASEDIR]
[--nolinks]
[--excludefiletypes EXCLUDEFILETYPES] [-v]
[--excludefiletypes EXCLUDEFILETYPES]
[--updatefiles] [-v]

Synchronization client for RWTH Moodle. All optional arguments override those
in config.json.
Expand Down Expand Up @@ -124,6 +126,13 @@ options:
--excludefiletypes EXCLUDEFILETYPES
specify whether specific file types should be
excluded, comma-separated e.g. "mp4,mkv"
--updatefiles define whether modified files with the same name/path
should be redownloaded
--updatefilesconflict {rename,keep,overwrite}
define how to handle locally modified files when
updating: 'rename' (default) moves the old file aside,
'keep' skips the update, 'overwrite' replaces the
local file
-v, --verbose show information useful for debugging
```

Expand Down Expand Up @@ -161,7 +170,9 @@ configuration does:
"folder": true // Include folders
},
"exclude_filetypes": [], // Exclude specific filetypes (e.g. ["mp4", "mkv"]) to disable downloading most videos
"exclude_files": [] // Exclude specific files using UNIX filename pattern matching (e.g. "Lecture{video,zoom}*.{mp4,mkv}")
"exclude_files": [], // Exclude specific files using UNIX filename pattern matching (e.g. "Lecture{video,zoom}*.{mp4,mkv}")
"update_files": true, // If true, existing files are redownloaded only when Moodle reports that they were modified (requires a cached root node from a previous run).
"update_files_conflict": "rename" // How to handle locally modified files when Moodle has a newer version: "rename" (default, move to <name>.syncconflict.<hash>), "keep" (skip update), or "overwrite" (replace local file).
}
```

Expand Down
4 changes: 3 additions & 1 deletion config.json.example
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
"totpsecret": "",
"basedir": "./",
"cookie_file": "./session",
"root_node_cache_file": "./cached_root_node",
"use_secret_service": false,
"secret_service_store_totp_secret": false,
"no_links": false,
Expand All @@ -23,5 +24,6 @@
"folder": true
},
"exclude_filetypes": [],
"exclude_files": []
"exclude_files": [],
"update_files": true
}
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ name = "syncMyMoodle"
version = "0.2.3.post1"
description = "Synchronization client for RWTH Moodle"
readme = "README.md"
requires-python = ">=3.6"
requires-python = ">=3.11"
license = { text = "GPL-3.0-only" }
authors = [
{ name = "Nils Kattenbeck", email = "[email protected]" }
Expand Down
Loading