monash-study-kit 1.4.1__tar.gz → 1.7.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (129) hide show
  1. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/CHANGELOG.md +61 -1
  2. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/PKG-INFO +134 -51
  3. monash_study_kit-1.7.0/PRIVACY.md +72 -0
  4. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/README.md +124 -48
  5. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/README.zh-CN.md +123 -45
  6. monash_study_kit-1.7.0/docs/SECURITY-REVIEW-1.5-SCOPE.md +38 -0
  7. monash_study_kit-1.7.0/docs/adr/0004-confirmed-mail-and-attendance-actions.md +27 -0
  8. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/docs/adr/README.md +2 -1
  9. monash_study_kit-1.7.0/docs/gmail-foundation.md +171 -0
  10. monash_study_kit-1.7.0/docs/google-and-attendance-setup.md +177 -0
  11. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/docs/panels-library-remote.md +5 -2
  12. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/docs/releasing.md +1 -1
  13. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/docs/security.md +3 -1
  14. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/pyproject.toml +8 -3
  15. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/skills/monash-study-kit/SKILL.md +9 -0
  16. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/src/monash_study_kit/__init__.py +1 -1
  17. monash_study_kit-1.7.0/src/monash_study_kit/attendance.py +412 -0
  18. monash_study_kit-1.7.0/src/monash_study_kit/attendance_assets/PROVENANCE.md +4 -0
  19. monash_study_kit-1.7.0/src/monash_study_kit/attendance_assets/extract-rows.js +109 -0
  20. monash_study_kit-1.7.0/src/monash_study_kit/attendance_assets/shared.js +736 -0
  21. monash_study_kit-1.7.0/src/monash_study_kit/attendance_auto.py +116 -0
  22. monash_study_kit-1.7.0/src/monash_study_kit/attendance_evidence.py +202 -0
  23. monash_study_kit-1.7.0/src/monash_study_kit/attendance_http.py +442 -0
  24. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/src/monash_study_kit/cli.py +112 -22
  25. monash_study_kit-1.7.0/src/monash_study_kit/cli_attendance.py +62 -0
  26. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/src/monash_study_kit/cli_ed.py +24 -0
  27. monash_study_kit-1.7.0/src/monash_study_kit/cli_gmail.py +173 -0
  28. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/src/monash_study_kit/doctor.py +64 -4
  29. monash_study_kit-1.7.0/src/monash_study_kit/edexport.py +140 -0
  30. monash_study_kit-1.7.0/src/monash_study_kit/gmail.py +824 -0
  31. monash_study_kit-1.7.0/src/monash_study_kit/gmail_tools.py +37 -0
  32. monash_study_kit-1.7.0/src/monash_study_kit/google_client.json +1 -0
  33. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/src/monash_study_kit/help_menu.py +51 -4
  34. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/src/monash_study_kit/jobs.py +2 -2
  35. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/src/monash_study_kit/lesson_reader.py +3 -0
  36. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/src/monash_study_kit/lessons.py +160 -22
  37. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/src/monash_study_kit/library.py +56 -8
  38. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/src/monash_study_kit/mcp_server.py +267 -14
  39. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/src/monash_study_kit/paths.py +9 -0
  40. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/src/monash_study_kit/remote.py +81 -33
  41. monash_study_kit-1.7.0/src/monash_study_kit/semester.py +129 -0
  42. monash_study_kit-1.7.0/src/monash_study_kit/service_actions.py +95 -0
  43. monash_study_kit-1.7.0/src/monash_study_kit/service_jobs.py +88 -0
  44. monash_study_kit-1.7.0/src/monash_study_kit/service_setup.py +138 -0
  45. monash_study_kit-1.7.0/src/monash_study_kit/student_services.py +404 -0
  46. monash_study_kit-1.7.0/src/monash_study_kit/student_tools.py +228 -0
  47. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/src/monash_study_kit/todo.py +3 -1
  48. monash_study_kit-1.7.0/tests/test_attendance_browser.py +60 -0
  49. monash_study_kit-1.7.0/tests/test_attendance_fast.py +323 -0
  50. monash_study_kit-1.7.0/tests/test_attendance_parity.py +85 -0
  51. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/tests/test_cli.py +4 -0
  52. monash_study_kit-1.7.0/tests/test_ed_export.py +214 -0
  53. monash_study_kit-1.7.0/tests/test_gmail.py +239 -0
  54. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/tests/test_help_menu.py +4 -1
  55. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/tests/test_mcp.py +6 -3
  56. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/tests/test_panels.py +1 -1
  57. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/tests/test_remote.py +86 -0
  58. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/tests/test_security.py +2 -1
  59. monash_study_kit-1.7.0/tests/test_semester.py +65 -0
  60. monash_study_kit-1.7.0/tests/test_service_setup.py +130 -0
  61. monash_study_kit-1.7.0/tests/test_student_gmail.py +242 -0
  62. monash_study_kit-1.7.0/tests/test_student_tools.py +465 -0
  63. monash_study_kit-1.7.0/tests/test_without_ed.py +45 -0
  64. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/uv.lock +431 -18
  65. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/.github/ISSUE_TEMPLATE/bug_report.yml +0 -0
  66. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/.github/ISSUE_TEMPLATE/config.yml +0 -0
  67. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/.github/ISSUE_TEMPLATE/feature_request.yml +0 -0
  68. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/.github/pull_request_template.md +0 -0
  69. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/.github/workflows/release.yml +0 -0
  70. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/.github/workflows/test.yml +0 -0
  71. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/.gitignore +0 -0
  72. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/CODE_OF_CONDUCT.md +0 -0
  73. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/CONTRIBUTING.md +0 -0
  74. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/LICENSE +0 -0
  75. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/SECURITY.md +0 -0
  76. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/docs/adr/0001-one-shared-core.md +0 -0
  77. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/docs/adr/0002-read-only-public-package.md +0 -0
  78. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/docs/adr/0003-release-from-a-tag.md +0 -0
  79. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/docs/screenshots/todo.png +0 -0
  80. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/glama.json +0 -0
  81. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/scripts/check_dist.py +0 -0
  82. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/scripts/measure_tokens.py +0 -0
  83. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/scripts/smoke_test.py +0 -0
  84. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/src/monash_study_kit/__main__.py +0 -0
  85. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/src/monash_study_kit/browser_login.py +0 -0
  86. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/src/monash_study_kit/cdp.py +0 -0
  87. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/src/monash_study_kit/claude_setup.py +0 -0
  88. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/src/monash_study_kit/clients.py +0 -0
  89. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/src/monash_study_kit/content_index.py +0 -0
  90. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/src/monash_study_kit/doctor_deep.py +0 -0
  91. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/src/monash_study_kit/edlib.py +0 -0
  92. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/src/monash_study_kit/edquery.py +0 -0
  93. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/src/monash_study_kit/edsync.py +0 -0
  94. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/src/monash_study_kit/features.py +0 -0
  95. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/src/monash_study_kit/htmldom.py +0 -0
  96. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/src/monash_study_kit/moodlelib.py +0 -0
  97. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/src/monash_study_kit/output.py +0 -0
  98. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/src/monash_study_kit/recordings.py +0 -0
  99. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/src/monash_study_kit/syncer.py +0 -0
  100. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/src/monash_study_kit/textextract.py +0 -0
  101. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/src/monash_study_kit/transcribe.py +0 -0
  102. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/src/monash_study_kit/ui/panel.html +0 -0
  103. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/src/monash_study_kit/update_check.py +0 -0
  104. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/src/monash_study_kit/webnotes.py +0 -0
  105. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/src/monash_study_kit/widgets.py +0 -0
  106. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/tests/conftest.py +0 -0
  107. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/tests/test_cdp.py +0 -0
  108. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/tests/test_clients.py +0 -0
  109. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/tests/test_content_index.py +0 -0
  110. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/tests/test_doctor.py +0 -0
  111. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/tests/test_doctor_deep.py +0 -0
  112. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/tests/test_ed_auth.py +0 -0
  113. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/tests/test_ed_markdown.py +0 -0
  114. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/tests/test_ed_query.py +0 -0
  115. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/tests/test_ed_quiz.py +0 -0
  116. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/tests/test_feature_cli.py +0 -0
  117. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/tests/test_features.py +0 -0
  118. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/tests/test_layout.py +0 -0
  119. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/tests/test_lesson_reader.py +0 -0
  120. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/tests/test_library.py +0 -0
  121. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/tests/test_recordings.py +0 -0
  122. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/tests/test_removed_files.py +0 -0
  123. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/tests/test_setup.py +0 -0
  124. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/tests/test_shared_core.py +0 -0
  125. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/tests/test_skill.py +0 -0
  126. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/tests/test_sync_robustness.py +0 -0
  127. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/tests/test_todo.py +0 -0
  128. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/tests/test_update_check.py +0 -0
  129. {monash_study_kit-1.4.1 → monash_study_kit-1.7.0}/tests/test_webnotes.py +0 -0
@@ -2,7 +2,67 @@
2
2
 
3
3
  Version numbers follow `__version__` in `src/monash_study_kit/__init__.py`: patch for bug fixes, minor for new features.
4
4
 
5
- ## Unreleased
5
+ ## 1.7.0
6
+
7
+ This is also the first release on PyPI with the 1.6.0 changes below (the local semester week view and private calendar export); 1.6.0 was never published on its own.
8
+
9
+ Ed Lessons materials are organised like Ed and can be taken away as one zip, matching Ed Web's "download all".
10
+
11
+ - `monash ed export FIT2109` (and `--module`, `--to`, `--open`) packs the synced Ed Lessons of a unit into a zip in Downloads: one folder per module, files in Ed's order, a `Links.md` per lesson for reading pages and the Ed page, and a `README.md` with progress and any files that failed to download. It reads only local files.
12
+ - The same export is a button per unit on the `monash library` page and the `export_ed_lessons` tool for AI apps (not read-only, so remote mode does not expose it; it adds about 360 characters to the tool list and is hidden with `use_ed false`).
13
+ - Ed files are stored as `<unit code>/<NN module>/<NN lesson>/<NN title>`, instead of numeric course and lesson ids. The first sync moves files from the old layout instead of downloading them again. `monash open ed` opens the folder.
14
+ - Files that Ed hosts inside document and code pages (`<file>` on `edusercontent.com`) are downloaded and indexed, up to 200 MB each. Links to other sites are not followed.
15
+ - A PDF replaced on Ed (new file URL) is downloaded again; files of slides removed on Ed are deleted, and empty folders are cleaned up.
16
+ - `list_files` includes Ed Lessons files (with `ed:` paths for `read_file`), filtered by unit, week or name.
17
+ - Fix: the `monash library` page now lists Ed files synced by this package (it expected absolute paths and skipped the relative ones in `ed.db`).
18
+
19
+ ## 1.6.0
20
+
21
+ - `monash semester --days 7` combines Moodle deadlines, local Ed lesson/reply/announcement summaries and the optional attendance cache into one local-first view. No account data is sent to Monash Hub.
22
+ - `monash semester --ics [PATH]` exports verified timestamped Moodle deadlines as a private `.ics` file; it is a snapshot, not a background subscription or an attendance record.
23
+ - This is a CLI view; it does not create an externally hosted dashboard. Missing Moodle/Ed data remains explicitly marked as missing.
24
+
25
+ ## 1.5.0
26
+
27
+ Optional school mail and attendance. Both are off until you connect them, the core still depends only on pypdf, and Moodle and Ed stay read-only.
28
+
29
+ **Connecting**
30
+
31
+ - Ask your AI app "connect my school email" or "connect my attendance". The new `start_school_service_setup` tool installs what is missing into the running install, opens the sign-in window on your computer and turns everything on, then syncs and tells the AI app its tool list changed. Passwords and codes stay in your browser. The tool adds 145 tokens per conversation and is hidden once both are connected.
32
+ - In a terminal: `uv tool install --reinstall "monash-study-kit[gmail,attendance]"`, then `monash gmail login` and `monash attendance login`.
33
+ - `monash gmail login` uses a Google app that ships with the package, so no Google Cloud project is needed. Google shows "this app isn't verified" (Advanced, then continue). `--client` uses your own app instead. For people who only want to ask about their inbox, the guide suggests the AI apps' built-in Gmail connectors.
34
+
35
+ **School mail** (`[gmail]`)
36
+
37
+ - A private local copy: `monash gmail sync` saves each page with its cursor and prints progress, so an interrupted run keeps what it finished and the next run continues. While your AI app is open, mail syncs every 30 minutes (`gmail_sync_minutes`) and a few attachments per round are indexed.
38
+ - `monash gmail todo` and `get_gmail_inbox_todo` list recent unread inbox mail without promotions and social updates. Search results carry the date, unread, inbox, starred, important, category and attachment count. `gmail_read_attachment` reads PDF, Office and image attachments.
39
+ - Drafting, sending a draft and changing labels (archive, mark as read, star) are on after login. Every action returns a full preview and a single-use ticket bound to that payload, and runs only after you confirm that exact action. Nothing permanently deletes mail. `monash gmail login --read-only` asks Google for read access only. See [ADR 0004](docs/adr/0004-confirmed-mail-and-attendance-actions.md).
40
+ - The server instructions tell the AI app to use this for questions about "my email" instead of a general Gmail connector.
41
+
42
+ **Attendance** (`[attendance]`)
43
+
44
+ - `monash attendance login`, `status`, `sync`, `overview`, `codes` and `probe`, and matching tools in the AI app: classes and check-in status from the portal, and candidate codes found in synced Moodle, Ed and school mail, each with its source.
45
+ - A read is one plain request with the saved login (about 5 KB, a few seconds) and a Python port of the extension's parser. On the Malaysia portal it matched the browser read on all 15 days the portal offers. It falls back to a single headless browser page whenever the page looks different or the certificate cannot be verified, and HTTPS is checked with the system certificate store (`truststore`).
46
+ - Reads follow your timetable: weekday mornings at 8 and 15 minutes after each class you have not checked in to, nothing at night, at weekends or for finished classes (`attendance_auto_sync`).
47
+ - Check-in is on after login and is prepared only when you say you attended, with the same preview and confirmation as mail.
48
+ - `monash attendance status` records how long the login lasts. An optional lightweight keepalive (`attendance_keepalive_minutes`) is off until that is known.
49
+ - Checked only against the Malaysia campus portal; `MONASH_ATTENDANCE_ORIGIN` and `MONASH_ATTENDANCE_TZ` point it elsewhere.
50
+
51
+ **Remote MCP**
52
+
53
+ - Each app chooses on the pairing page which mail and attendance features it may use. Only features turned on on the server are offered; read-only ones start ticked, actions unticked. The choice is kept on refresh, checked against the server settings at every call and shown by `monash remote clients`. Apps paired before 1.5.0 keep Moodle and Ed only. Tickets and background jobs belong to one app.
54
+
55
+ **Other changes**
56
+
57
+ - Units without Ed: `monash config use_ed false`, or answering yes in `monash setup` after skipping the Ed token, stops the reminders about a missing token and hides the Ed tools and help.
58
+ - `monash update` keeps every installed extra (`gmail`, `attendance`, `media`).
59
+ - `monash status` and `monash doctor` cover mail and attendance once they are on; doctor output never shows the mail address.
60
+ - `monash help` and the help prompt list mail and attendance once connected, and suggest connecting them until then.
61
+ - The agent skill lists the mail and attendance commands and the rule that `--confirm` comes only after the student confirms the preview.
62
+ - Token use: 3,377 per conversation by default (3,232 in 1.4.1), 5,132 with mail and attendance connected.
63
+ - Docs: setup guide in [docs/google-and-attendance-setup.md](docs/google-and-attendance-setup.md) (Chinese), design notes in [docs/gmail-foundation.md](docs/gmail-foundation.md), privacy policy in [PRIVACY.md](PRIVACY.md).
64
+
65
+ Not verified yet: attendance check-in on a real account, how long the attendance login lasts, the keepalive, and portals of campuses other than Malaysia.
6
66
 
7
67
  ## 1.4.1
8
68
 
@@ -1,14 +1,14 @@
1
1
  Metadata-Version: 2.5
2
2
  Name: monash-study-kit
3
- Version: 1.4.1
4
- Summary: Connect Monash Moodle and Ed to Claude via a local MCP server and CLI: deadlines, announcements, grades, full-text search over course materials and Ed posts, all on your own machine.
3
+ Version: 1.7.0
4
+ Summary: Connect Monash Moodle and Ed to Claude, Codex, Cursor or any local MCP client via a local MCP server and CLI: deadlines, announcements, grades, full-text search over course materials and Ed posts, all on your own machine.
5
5
  Project-URL: Homepage, https://github.com/Waldo0926/monash-study-kit
6
6
  Project-URL: Issues, https://github.com/Waldo0926/monash-study-kit/issues
7
7
  Project-URL: Changelog, https://github.com/Waldo0926/monash-study-kit/blob/main/CHANGELOG.md
8
8
  Author: Waldo
9
9
  License-Expression: MIT
10
10
  License-File: LICENSE
11
- Keywords: claude,cli,edstem,mcp,model-context-protocol,monash,moodle,study-tools
11
+ Keywords: claude,cli,codex,cursor,edstem,mcp,model-context-protocol,monash,moodle,study-tools
12
12
  Classifier: Development Status :: 5 - Production/Stable
13
13
  Classifier: Environment :: Console
14
14
  Classifier: Intended Audience :: Education
@@ -21,6 +21,13 @@ Classifier: Programming Language :: Python :: 3.13
21
21
  Classifier: Topic :: Education
22
22
  Requires-Python: >=3.10
23
23
  Requires-Dist: pypdf>=4.0
24
+ Provides-Extra: attendance
25
+ Requires-Dist: pillow<13,>=10; extra == 'attendance'
26
+ Requires-Dist: playwright<2,>=1.49; extra == 'attendance'
27
+ Requires-Dist: truststore<1,>=0.10; extra == 'attendance'
28
+ Requires-Dist: tzdata; (sys_platform == 'win32') and extra == 'attendance'
29
+ Provides-Extra: gmail
30
+ Requires-Dist: google-auth-oauthlib<2,>=1.2; extra == 'gmail'
24
31
  Provides-Extra: media
25
32
  Requires-Dist: deno>=2.0; extra == 'media'
26
33
  Requires-Dist: faster-whisper>=1.0; extra == 'media'
@@ -34,54 +41,59 @@ Description-Content-Type: text/markdown
34
41
  [![Release](https://img.shields.io/github/v/release/Waldo0926/monash-study-kit?style=for-the-badge&label=Release&color=16a34a)](https://github.com/Waldo0926/monash-study-kit/releases)
35
42
  [![PyPI](https://img.shields.io/pypi/v/monash-study-kit?style=for-the-badge&label=PyPI&color=0ea5e9)](https://pypi.org/project/monash-study-kit/)
36
43
  [![License](https://img.shields.io/badge/License-MIT-16a34a?style=for-the-badge)](LICENSE)
37
- [![Access](https://img.shields.io/badge/Access-Read--only-475569?style=for-the-badge)](#privacy-and-security)
44
+ [![Moodle/Ed read-only](https://img.shields.io/badge/Moodle%20%2F%20Ed-read--only-475569?style=for-the-badge)](#privacy-and-security)
38
45
  [![Docs](https://img.shields.io/badge/Docs-docs.secureview.tech-1e5eff?style=for-the-badge)](https://docs.secureview.tech/study-kit/)
39
46
 
40
47
  [![CI](https://github.com/Waldo0926/monash-study-kit/actions/workflows/test.yml/badge.svg)](https://github.com/Waldo0926/monash-study-kit/actions/workflows/test.yml) [![Monash Study Kit MCP server – quality and maintenance score on Glama](https://glama.ai/mcp/servers/Waldo0926/monash-study-kit/badges/score.svg)](https://glama.ai/mcp/servers/Waldo0926/monash-study-kit)
41
48
 
42
49
  **English** · [中文](README.zh-CN.md)
43
50
 
44
- Connect Monash **Moodle** and **Ed** to Claude, then just ask Claude:
51
+ Connect Monash **Moodle** and **Ed** to the AI app on your computer (Claude, Codex, Cursor, VS Code and others), then just ask:
45
52
 
46
53
  - "What's due this week?": Moodle deadlines, assignments you may have missed, unfinished Ed lessons, latest announcements
47
54
  - "Anything new on Ed? Has anyone replied to my question?"
48
55
  - "Which week of FIT2102 covered monads? Which slide deck, which page?"
49
56
  - "What does the A2 spec ask for?", "What's my current grade in FIT2109?"
57
+ - "Quiz me on FIT2109 week 3." In apps that support MCP Apps, to-dos, lesson progress and quiz questions also show up as small panels you can click
50
58
 
51
- By default, everything stays **on your own computer**: course files, login state and the database live locally and never pass through a third-party server.
52
- All tools are **read-only**: they never submit assignments, attempt quizzes or post on Ed.
59
+ You can also run **`monash semester --days 7`** for a combined private week view of Moodle deadlines, Ed lessons/replies and any locally cached attendance records. Add **`--ics`** to export a private `semester.ics` into the Study Kit data directory, or **`--ics /path/to/file.ics`** to choose a path. This is a one-time calendar snapshot, not a live subscription; deadline times must be verified with Moodle. No personal semester data is uploaded to Monash Hub.
60
+
61
+ By default, synced course files, login state and the local database stay **on your own computer**. Results returned by MCP tools go to the AI app you connect; its privacy policy applies. Optional remote access sends those results through the AI provider's connection, not through a server run by this project's maintainer.
62
+ All Moodle and Ed tools are **read-only**: they never submit assignments, attempt quizzes or post on Ed. The optional school mail and attendance parts can draft mail, change labels or check you in, and only after you confirm each action.
53
63
 
54
64
  Built for Monash Malaysia (times are handled as UTC+8); Australian campuses work too, see the [FAQ](#faq).
55
65
 
56
66
  ![What monash todo prints: Moodle deadlines, a possibly missed assignment, Ed lessons not started, new course files, announcements and unread replies](docs/screenshots/todo.png)
57
67
 
58
- The picture is real output of `monash todo` against a database filled with made-up units, files and posts. Claude reads the same data through the MCP tools. Guide with more pictures: [docs.secureview.tech/study-kit](https://docs.secureview.tech/study-kit/).
68
+ The picture is real output of `monash todo` against a database filled with made-up units, files and posts. Your AI app reads the same data through the MCP tools. Guide with more pictures: [docs.secureview.tech/study-kit](https://docs.secureview.tech/study-kit/).
59
69
 
60
70
  ---
61
71
 
72
+ For the original v1.1 security review and the [1.5 feature review checklist](docs/SECURITY-REVIEW-1.5-SCOPE.md), see [security documentation](docs/security.md). The earlier review does not automatically certify features added later.
73
+
62
74
  ## Two parts, one codebase
63
75
 
64
76
  The same core (login, sync, queries) serves two kinds of "users":
65
77
 
66
- **MCP: the interface for Claude.** Moodle and Ed both sit behind Okta + MFA, so Claude cannot get in by itself.
67
- The MCP server lets Claude look things up mid-conversation (tools such as `get_study_todo`, `search_content`, `list_ed_updates`):
78
+ **MCP: the interface for your AI app.** Moodle and Ed both sit behind Okta + MFA, so the AI cannot get in by itself.
79
+ The MCP server lets it look things up mid-conversation (tools such as `get_study_todo`, `search_content`, `list_ed_updates`):
68
80
 
69
81
  - **Answers come from real data**: deadlines, announcements and grades are fetched live, with sources such as "Workshop 5 Slides, page 25".
70
82
  - **Both platforms at once**: one "what do I need to do this week" checks Moodle deadlines, unfinished Ed lessons and announcements from both.
71
- - **No manual copying**: no downloading PDFs and re-uploading them. Claude finds the right file and reads only the pages it needs, saving time and usage.
83
+ - **No manual copying**: no downloading PDFs and re-uploading them. The AI finds the right file and reads only the pages it needs, saving time and usage.
72
84
  - **Natural follow-ups**: "What does the A2 spec require?" "Explain that week's functor material using the lecture notes."
73
85
 
74
86
  **CLI (the `monash` command): the interface for humans.**
75
87
 
76
88
  1. **Things only a person can do**: installation, passing MFA in the login window, pasting the Ed token (tokens should never go through a chat, so they are only entered in the terminal).
77
- 2. **No AI needed**: out of usage or just want a quick look? `monash todo` answers in a second (see [Works without Claude usage](#works-without-claude-usage)).
89
+ 2. **No AI needed**: out of usage or just want a quick look? `monash todo` answers in a second (see [Works without AI usage](#works-without-ai-usage)).
78
90
  3. **Troubleshooting and maintenance**: `status`, `sync`, `update`, `uninstall`.
79
91
 
80
- In short: MCP turns Claude into a TA who knows your units; the CLI handles setup, login and fallback. Ask in Claude day to day, open the terminal occasionally.
92
+ In short: MCP turns your AI app into a TA who knows your units; the CLI handles setup, login and fallback. Ask in your AI app day to day, open the terminal occasionally.
81
93
 
82
94
  ## Requirements
83
95
 
84
- - **Claude Desktop** ([download](https://claude.ai/download)) or **Claude Code**
96
+ - An AI app that supports local MCP: **Claude Desktop** ([download](https://claude.ai/download)) or **Claude Code** are set up automatically; **Codex** (including Codex in the ChatGPT desktop app), **Cursor**, **VS Code**, **Windsurf** and **Gemini CLI** take one more command (see [Other AI clients](#other-ai-clients))
85
97
  - **Chrome, Edge or Brave** (the Edge that ships with Windows is fine), used to log in to Moodle
86
98
  - A Monash account
87
99
 
@@ -149,42 +161,64 @@ Follow the prompts. There are four steps:
149
161
  This window has its own profile and is completely isolated from your everyday browser: the tool only takes the Moodle session from this window
150
162
  and never reads anything from your normal browser.
151
163
  3. **Units**: tracks this semester's units by default, or pick your own.
152
- 4. **Connect to Claude**: adds `monash` to Claude Desktop and Claude Code automatically.
164
+ 4. **Connect your AI app**: adds `monash` to Claude Desktop and Claude Code automatically.
153
165
  - On macOS it quits Claude Desktop first (Claude overwrites config edits made while it is running), then reopens it.
154
166
  - On Windows it asks you to **fully quit** Claude Desktop first: tray icon at the bottom right → right-click → Quit.
167
+ - Using Codex, Cursor, VS Code, Windsurf or Gemini CLI? If this step says Claude Desktop is not found, ignore it. After setup, run `monash connect codex` (or `cursor`, `vscode`, `windsurf`, `gemini`) and restart that app.
155
168
 
156
169
  At the end you can choose to sync right away. The first sync downloads all course files and takes a few minutes to around a quarter of an hour.
157
170
 
158
- Then open Claude Desktop: under **"+" → Connectors** in the chat box you'll see **monash**. Leave it switched on.
171
+ Then open your AI app. In Claude Desktop, **"+" → Connectors** in the chat box lists **monash**; leave it switched on. For other apps, `monash connect` shows which ones are connected.
172
+
173
+ ## What's new in 1.7
174
+
175
+ - **Download a whole unit's Ed materials as one zip.** `monash ed export FIT2109` packs the Ed Lessons you have synced into a zip in your Downloads folder: one folder per week with the PDFs, text pages and attachments, a `Links.md` per lesson (reading pages and the original Ed page) and a top-level `README.md` with your progress. `--module "Week 3"` packs one week, `--open` shows the zip in Finder. You can also ask your AI app "zip up my FIT2109 Ed materials", or use the button next to each unit on the `monash library --open` page. It works offline from files already on your computer.
176
+ - **Ed files are stored by unit code.** Folders change from numeric ids to `FIT2109/03 Week 3 - Editor-Modern IDE/12 W3 Workshop/01 Workshop 3 Slides.pdf`, in the same order as on Ed. `monash open ed` opens them. The first sync after upgrading moves existing files instead of downloading them again.
177
+ - **Files attached inside Ed pages are downloaded too.** Starter-code zips, handouts and other files that Ed hosts inside a lesson page are now downloaded and searchable; single files over 200 MB are skipped. A replaced PDF is downloaded again, and pages removed on Ed are removed locally.
178
+ - **The AI sees Ed files when listing materials.** "What materials are there for FIT2109 week 3?" now lists Ed Lessons files through `list_files`, ready to read.
179
+
180
+ ## What's new in 1.6
181
+
182
+ - **Semester week view.** `monash semester --days 7` puts Moodle deadlines, Ed lessons and replies and cached attendance in one view; `--ics` exports the deadlines as a private calendar file.
183
+
184
+ ## What's new in 1.5
159
185
 
160
- ## Panels, a local library, and optional remote access (1.4.0)
186
+ - **School mail (optional).** Ask "anything in my email I need to deal with?" and get recent unread school mail, offline search, whole threads and attachment text. The AI can draft a reply, send a draft or archive mail, and only after you confirm each action.
187
+ - **Attendance (optional).** "Which classes this week haven't I checked in to?" and "what's the code for today's workshop?", with each code's source. Reads follow your timetable and take a few seconds without opening a browser. Checked against the Malaysia campus portal.
188
+ - **No terminal needed to connect them.** Say "connect my school email" or "connect my attendance" in your AI app; it installs what is missing and opens the sign-in window. No Google Cloud setup either.
189
+ - **Remote apps choose.** With `monash remote`, each app you pair ticks which of these it may use.
190
+ - **Units without Ed** can turn Ed off: `monash config use_ed false`.
161
191
 
162
- - **Study panels:** todo cards, Ed Lesson progress and quiz practice render in MCP Apps-capable hosts. Existing tools retain their text results; quiz choices go to the AI for explanation, never to Ed for submission.
163
- - **Activity finder:** ask for a Moodle section or activity by name with `search_moodle_activities`.
164
- - **Local file library:** run `monash library --open` to browse synced Moodle and Ed Lesson files by course/week and download originals, without an AI app. It only listens on your computer.
165
- - **Optional self-hosting:** `monash remote serve --public-url https://your-host.example` starts a single-user OAuth-protected remote MCP server behind your own HTTPS proxy. It exposes 16 read-only query tools; local login/sync maintenance stays on the server terminal. No server starts automatically.
192
+ Details: [Optional: Gmail and attendance](#optional-gmail-and-attendance) and the [changelog](CHANGELOG.md).
166
193
 
167
- See [setup, connection modes, security boundaries and validation](docs/panels-library-remote.md). Normal local use still needs no domain, VPS or remote account.
194
+ ## What's new in 1.4
195
+
196
+ - **Study panels.** In apps that support MCP Apps, "what do I need to do this week", "show my FIT2109 lesson progress" and "help me practise the week 3 quiz" also come with a small panel: deadline cards, lesson progress by module, and quiz questions you can click through. When you finish a quiz, the **交给 AI 批改** button sends your choices back to the chat and the AI explains them from the lesson. Nothing is submitted to Ed. Apps without panels still get the same text answers as before.
197
+ - **Find a Moodle activity by name.** "Where is the week 7 workshop on Moodle?" now works through the new `search_moodle_activities` tool. It needs a Moodle login.
198
+ - **Browse your files without AI.** `monash library --open` opens a page in your browser with every Moodle and Ed lesson file you have synced. Filter by unit, week or name and download the original. It only listens on `127.0.0.1`, so other devices cannot open it.
199
+ - **Optional remote access.** `monash remote serve` lets ChatGPT, or Claude on the web and phone, reach your own data over HTTPS. Use your own server and domain, or try it with a free Cloudflare quick tunnel on your own computer, which needs no account and no domain. Each app pairs with a one-time code from your terminal, and only the 16 read-only query tools are exposed. Nothing starts unless you run it. Steps are on [Host it yourself](https://docs.secureview.tech/study-kit/remote/).
200
+
201
+ 1.4.1 adds `library` and `remote` to the summary at the top of `monash --help`. Everyday use on your own computer still needs no server, domain or extra account. Technical notes: [docs/panels-library-remote.md](docs/panels-library-remote.md).
168
202
 
169
203
  ## Everyday use
170
204
 
171
- Just ask in Claude. While Claude is open, the tool works in the background:
205
+ Just ask in your AI app. While it is open, the tool works in the background:
172
206
 
173
207
  - syncs Ed and Moodle every hour (new posts, replies, course files) and refreshes the full-text index;
174
208
  - refreshes the Moodle session every 20 minutes (Moodle logs you out after 4 idle hours).
175
209
 
176
210
  ### Not sure what to ask?
177
211
 
178
- Use your own words: Claude picks tools by meaning, not keywords, so both "anything due this week" and "did I forget to submit something" reach the to-do tool.
212
+ Use your own words: the AI picks tools by meaning, not keywords, so both "anything due this week" and "did I forget to submit something" reach the to-do tool.
179
213
  To see everything it can do:
180
214
 
181
- - Ask Claude "what can you do", or choose one of monash's preset prompts from the **"+" menu**: feature overview, this week's to-dos,
215
+ - Ask your AI "what can you do". In Claude you can also pick one of monash's preset prompts from the **"+" menu** (other apps show MCP prompts in their own place, or not at all): feature overview, this week's to-dos,
182
216
  Ed updates, find a topic, quiz review, assignment requirements, grades and feedback. Presets are only sent when you click them, so they cost nothing otherwise.
183
217
  - Run `monash help` in the terminal: every feature with an example question and the matching command.
184
218
 
185
219
  ### When the Moodle login expires
186
220
 
187
- After shutdown or a long sleep, the Moodle session expires. Claude will tell you and ask whether to log in.
221
+ After shutdown or a long sleep, the Moodle session expires. The AI will tell you and ask whether to log in.
188
222
  If you agree, it opens the login window on your computer; if Okta still remembers you, it logs in silently without even showing the window.
189
223
  You can also run it yourself:
190
224
 
@@ -194,7 +228,7 @@ monash login
194
228
 
195
229
  While the login is expired, **deadlines still work** (they come from Moodle's calendar subscription link, which needs no login), and Ed features are unaffected.
196
230
 
197
- ### Works without Claude usage
231
+ ### Works without AI usage
198
232
 
199
233
  The CLI doesn't use AI and consumes no usage. Run `monash sync` first, then:
200
234
 
@@ -208,8 +242,8 @@ The CLI doesn't use AI and consumes no usage. Run `monash sync` first, then:
208
242
  | Read a full post | `monash ed show FIT2102#42` |
209
243
  | Grades / possibly missed assignments | `monash moodle grades FIT2102` / `monash moodle assignments --missing` |
210
244
 
211
- The difference is that nobody summarises for you; you get the raw information. Background sync and Moodle session refresh run alongside Claude Desktop:
212
- while Claude is open they keep running even if your usage is exhausted; if Claude is closed, run `monash sync` before querying and `monash login` if Moodle has expired.
245
+ The difference is that nobody summarises for you; you get the raw information. Background sync and Moodle session refresh run while your AI app is open, because that is when the MCP server runs:
246
+ they keep running even if your usage is exhausted; if the app is closed, run `monash sync` before querying and `monash login` if Moodle has expired.
213
247
 
214
248
  ## Other AI clients
215
249
 
@@ -223,9 +257,9 @@ monash connect cursor # or codex, vscode, windsurf, gemini
223
257
 
224
258
  It adds only the `monash` entry to the client's config file with the full path to the program, keeps everything else, and saves a backup first. Codex is set up with `codex mcp add` when the `codex` command exists. `--print` shows the entry without changing anything, and `--remove` takes it out again. `monash uninstall` removes it from every client.
225
259
 
226
- > **Verified:** Claude Desktop and Claude Code with the local server; ChatGPT and Codex through a private remote integration using the same v1.3.0 core. On 30 October 2026, Codex successfully queried Moodle and Ed courses; ChatGPT's course query was also confirmed. The public package's stdio handshake, 17-tool catalog, isolated course query and ping passed an offline smoke test.
260
+ > **Verified:** Claude Desktop and Claude Code with the local server. ChatGPT and Codex through a private remote integration on the v1.3.0 core: on 30 October 2026 Codex queried Moodle and Ed courses and ChatGPT's course query was confirmed. ChatGPT Plus works with the author's own domain and server.
227
261
  >
228
- > The tested private deployment remains separate; 1.4.0 adds an optional [self-hosted remote mode](docs/panels-library-remote.md). These checks do not establish native local Codex, Cursor, VS Code, Windsurf or Gemini CLI connectivity. `monash connect` writes the format from each vendor's official docs (as of 2026-10); the official docs take precedence.
262
+ > On 30 October 2026 the 1.4.0 package from PyPI was also checked in a clean environment with made-up data: the stdio handshake, the 18-tool catalog, the three panels, `monash library`, and the whole `monash remote` sign-in and query flow using the Claude and ChatGPT callback addresses. None of this covers the native local Codex, Cursor, VS Code, Windsurf or Gemini CLI connections. `monash connect` writes the format from each vendor's official docs (as of 2026-10); the official docs take precedence.
229
263
 
230
264
  To configure a client by hand instead, first find the full path of the `monash` program (many clients don't inherit your terminal's PATH):
231
265
 
@@ -244,7 +278,7 @@ Replace `/full/path/monash` in the examples with your path. **In JSON, Windows b
244
278
  | Windsurf | `~/.codeium/windsurf/mcp_config.json` | Untested |
245
279
  | VS Code (Copilot) | Command Palette → `MCP: Open User Configuration` | Untested |
246
280
  | Gemini CLI | `~/.gemini/settings.json` | Untested |
247
- | ChatGPT web / mobile app | Separately hosted remote endpoint | Requires a remote MCP server; the public local package alone does not provide one |
281
+ | ChatGPT, Claude web / mobile app | `monash remote serve` behind your own domain or a Cloudflare quick tunnel | ChatGPT Plus works with the author's domain; see [Host it yourself](https://docs.secureview.tech/study-kit/remote/) |
248
282
 
249
283
  Codex (`~/.codex/config.toml`), or simply run `codex mcp add monash -- /full/path/monash mcp`:
250
284
 
@@ -281,7 +315,7 @@ If the file already lists other servers, add the `monash` entry rather than over
281
315
  - Login and unit selection are still done with `monash setup`. Without Claude installed, the last step reports "Claude Desktop not found"; just ignore it.
282
316
  - Background sync and Moodle session refresh only run while the client is open and the MCP server is running.
283
317
  - Tool descriptions are written with Claude in mind. Other models usually follow them fine, but this hasn't been verified.
284
- - If you'd rather not bother, the CLI works with no AI at all (see [Works without Claude usage](#works-without-claude-usage)); you can paste the output of `monash todo` and friends into any AI.
318
+ - If you'd rather not bother, the CLI works with no AI at all (see [Works without AI usage](#works-without-ai-usage)); you can paste the output of `monash todo` and friends into any AI.
285
319
 
286
320
  ### Agent skill
287
321
 
@@ -295,10 +329,10 @@ The file is [`skills/monash-study-kit/SKILL.md`](skills/monash-study-kit/SKILL.m
295
329
 
296
330
  ### What can be searched
297
331
 
298
- `monash grep` and Claude's course-material search cover:
332
+ `monash grep` and the AI's course-material search cover:
299
333
 
300
334
  - Moodle course files (PDF, Word, PowerPoint, text and code)
301
- - PDFs in Ed Lessons, plus content pages written directly in Ed
335
+ - PDFs in Ed Lessons, files attached inside Ed pages, plus content pages written directly in Ed
302
336
  - **Course-notes websites**: many units publish notes on a lecturer's public site, e.g. tgdwyer.github.io for FIT2102 or
303
337
  yqtian-se.github.io for FIT2109. Pages of this kind linked from Moodle or Ed are fetched, converted to text and stored in the
304
338
  `Course notes (web)` folder of your course files. Only pages the unit links to directly are fetched (no site-wide crawling), and each page is re-fetched at most once a week.
@@ -312,11 +346,13 @@ The file is [`skills/monash-study-kit/SKILL.md`](skills/monash-study-kit/SKILL.m
312
346
  - Windows: `%LOCALAPPDATA%\monash-study-kit`
313
347
 
314
348
  It contains course files (`files`), the database (`data`), login credentials (`secrets`, readable only by your own user account) and the dedicated login window's profile (`browser-profile`).
315
- Run `monash open` to open the course-files folder.
349
+ Run `monash open` to open the course-files folder, or `monash open ed` for Ed Lessons files (in `data/ed-files`, by unit code).
316
350
  - **Stored credentials**: the Moodle session cookie, the Ed API token and the Moodle calendar subscription link. They stay on your computer and are only used to talk to Moodle / Ed.
317
351
  **Never send the `secrets` folder to anyone.**
318
- - **What Claude can see**: only what a tool returns when you ask something (e.g. a list of deadlines, the full text of a post, the text of a course file).
319
- Tokens and cookies are never sent to Claude. **Don't paste your Ed token into a chat either**; it is only entered in the terminal.
352
+ - **What the AI can see**: only what a tool returns when you ask something (e.g. a list of deadlines, the full text of a post, the text of a course file).
353
+ Tokens and cookies are never sent to the AI. **Don't paste your Ed token into a chat either**; it is only entered in the terminal.
354
+ - **Course library page**: `monash library` only listens on `127.0.0.1` and only serves files that sync registered. It has no password, so don't forward it to the internet.
355
+ - **Optional remote mode**: `monash remote` keeps the apps you paired in `secrets/remote-mcp.db`, storing only hashes of their tokens. Access tokens last an hour, refresh tokens 30 days and change on every use. `monash remote revoke --all` cuts every app off.
320
356
  - **What it does to Moodle / Ed**: read-only. Requests are spaced out, so it never hammers university systems like a crawler.
321
357
  - **Complete removal**:
322
358
 
@@ -329,13 +365,15 @@ The file is [`skills/monash-study-kit/SKILL.md`](skills/monash-study-kit/SKILL.m
329
365
 
330
366
  ## Token use
331
367
 
332
- Every MCP tool's name, description and parameters are sent to Claude at the start of each conversation, so they cost tokens even when unused. Measured with `scripts/measure_tokens.py` on 1.4.0 (estimate: 4 ASCII characters or 1 Chinese character per token):
368
+ Every MCP tool's name, description and parameters are sent to the model at the start of each conversation, so they cost tokens even when unused. Measured with `scripts/measure_tokens.py` on 1.5.0 (estimate: 4 ASCII characters or 1 Chinese character per token):
333
369
 
334
370
  | Sent once per conversation | Tokens |
335
371
  | --- | ---: |
336
- | 18 tool definitions | 2,962 |
372
+ | 19 tool definitions | 3,107 |
337
373
  | Server instructions | 270 |
338
- | **Total** | **3,232** |
374
+ | **Total** | **3,377** |
375
+
376
+ 1.5.0 added `start_school_service_setup` (145), which lets you connect school mail or attendance by asking your AI app. It is hidden again once both are connected; with both connected the total is 5,132. In 1.4.0 the total was 3,232.
339
377
 
340
378
  The instructions grew from 187 in 1.2.0 when the rule for assignment questions was added (brief and rubric first, then staff answers on Ed).
341
379
 
@@ -357,7 +395,7 @@ To measure your own answers (what a "what's due this week" or a course-file sear
357
395
 
358
396
  ## Command reference
359
397
 
360
- You can also query directly in the terminal without Claude:
398
+ You can also query directly in the terminal without any AI:
361
399
 
362
400
  | Command | What it does |
363
401
  |---|---|
@@ -371,15 +409,20 @@ You can also query directly in the terminal without Claude:
371
409
  | `monash sync` | Sync now |
372
410
  | `monash login` / `monash login ed` | Log in to Moodle / replace the Ed token |
373
411
  | `monash courses` | Re-pick tracked units |
374
- | `monash open` | Open the course-files folder |
412
+ | `monash open [ed]` | Open the course-files folder (`ed`: Ed Lessons files) |
413
+ | `monash library [--open]` | Browse and download synced files in your browser (only on this computer) |
375
414
  | `monash moodle grades [FIT2102]` | Grades and feedback |
376
415
  | `monash moodle assignments --missing` | Possibly missed assignments |
377
416
  | `monash moodle news` / `find` / `get` / `messages` / `calendar` | Announcements / find an activity / download one file / messages / calendar subscription link |
378
417
  | `monash ed new` / `following` / `search` / `show FIT2102#42` | Ed updates / new replies to my posts / search / read a post |
379
418
  | `monash ed lessons FIT2109` / `quiz FIT2109` | Ed lesson progress / quiz questions (for revision) |
380
419
  | `monash ed read FIT2109 "W3 Pre-Class"` | A whole lesson as Markdown: text slides, reading pages and PDFs in order, plus its quiz questions |
381
- | `monash config` | View / change settings (restart Claude Desktop afterwards) |
420
+ | `monash ed export FIT2109 [--module "Week 3"] [--open]` | Zip a unit's Ed materials by week into Downloads |
421
+ | `monash config` | View / change settings (restart your AI app afterwards) |
382
422
  | `monash connect [client]` | Connect to Codex, Cursor, VS Code, Windsurf or Gemini CLI (see [Other AI clients](#other-ai-clients)) |
423
+ | `monash remote serve` / `pair` / `clients` / `revoke` | Optional remote MCP for ChatGPT and Claude on the web ([Host it yourself](https://docs.secureview.tech/study-kit/remote/)) |
424
+ | `monash gmail todo` / `sync` / `search` / `thread` | Optional school Gmail: unread inbox mail / sync / offline search / read a thread ([setup](#optional-gmail-and-attendance)) |
425
+ | `monash attendance login` / `status` / `sync` / `overview` / `codes` | Optional attendance: log in / status / read the portal / saved classes / find check-in codes |
383
426
  | `monash update` | Update to the latest version |
384
427
 
385
428
  Add `--json` for JSON output (output is JSON automatically when piped; `--text` forces text). Every command has `--help`.
@@ -389,7 +432,7 @@ Exit codes (for scripts): 0 success, 1 bad arguments, 2 login required (`monash
389
432
 
390
433
  ## Lecture-recording transcripts (optional)
391
434
 
392
- To let Claude know what was said in class, recordings can be turned into timestamped transcripts:
435
+ To let your AI know what was said in class, recordings can be turned into timestamped transcripts:
393
436
 
394
437
  - **YouTube** links in Ed "Week N … Recording" posts: YouTube captions are fetched directly, which is fast;
395
438
  - **Zoom** recordings: downloaded with the passcode from the post, then transcribed on your computer with Whisper (a two-hour lecture takes 20–30 minutes on an ordinary laptop).
@@ -408,24 +451,53 @@ monash media
408
451
 
409
452
  Videos uploaded directly to Moodle aren't downloaded by default either (often hundreds of MB); they are recorded as links. To download them: `monash config download_videos true`.
410
453
 
454
+ ## Optional: Gmail and attendance
455
+
456
+ New in 1.5.0. Both parts are off until you connect them and only run on your own computer.
457
+
458
+ - **School Gmail.** Keeps a private copy of your Monash mailbox. Ask "anything in my email I need to deal with?" and the AI lists recent unread school mail (promotions and social updates left out), searches it offline, reads whole threads and the text of attachments (PDF, Office, images). Reading never marks mail as read.
459
+ - **Attendance.** Reads your classes and check-in status from the attendance portal, so you can ask "which classes this week haven't I checked in to?" or "what's the code for today's FIT2102 workshop?". Codes are looked up in synced Moodle, Ed and school mail and shown with where they came from, for you to check. Only checked against the Malaysia campus portal.
460
+
461
+ If you only want to ask about your inbox in Claude or ChatGPT, their built-in Gmail connectors are the easiest way. The Gmail part here is for linking mail with attendance codes, searching mail and attachments offline, and using it in apps without a Gmail connector such as Codex or Cursor. No Google Cloud setup is needed: the package includes a Google app, and Google will show "this app isn't verified" (click Advanced, then continue). Using your own Google app instead is optional. The step-by-step guide (in Chinese) is [docs/google-and-attendance-setup.md](docs/google-and-attendance-setup.md); what is accessed and stored is in [PRIVACY.md](PRIVACY.md). The easiest way is to ask your AI app: "connect my school email" or "connect my attendance". It installs what is missing, opens the sign-in window on your computer, and you only sign in; nothing is typed in a terminal and no password goes into the chat. The same steps in a terminal:
462
+
463
+ ```bash
464
+ uv tool install --reinstall "monash-study-kit[gmail,attendance]"
465
+ monash gmail login
466
+ monash gmail sync
467
+ monash attendance login
468
+ monash attendance sync
469
+ ```
470
+
471
+ Restart your AI app after logging in. While it is open, mail syncs in the background every 30 minutes (`monash config gmail_sync_minutes`, 0 turns it off); `monash gmail sync` updates it right away. Attendance follows your timetable instead of the clock: once on weekday mornings at 8 and 15 minutes after each class you have not checked in to yet, so nothing runs at night, at weekends or between classes (`monash config attendance_auto_sync false` turns it off). You or the AI can also ask for a read any time. A read is one plain request to the portal (about 5 KB, a few seconds, no browser); if the page ever looks different from what is expected it falls back to one headless browser page. On the Malaysia portal both ways gave the same result for all 15 days the portal offers, and `monash attendance probe` repeats that check on yours. `monash status` and `monash doctor` show both parts once they are on, and `monash update` keeps the extras you installed.
472
+
473
+ Logging in turns everything on in your AI app, including drafting, sending a draft, changing labels (archive, mark as read, star) and checking in to a class. The AI has to show you the full preview first and only runs it after you confirm that exact action; a check-in is only prepared when you say you attended. Mail is never permanently deleted. To keep mail read-only, log in with `monash gmail login --read-only`; to switch an action off, `monash config gmail_manage_enabled false` or `monash config attendance_submit_enabled false`.
474
+
475
+ With `monash remote serve`, each app you pair chooses on the pairing page which of these features it may use. Only features turned on on the server are offered, read-only ones start ticked and the write ones start unticked. So Claude on your phone can have attendance only and ChatGPT mail only, or neither. Apps paired earlier keep Moodle and Ed only until you pair them again, and `monash remote clients` shows what each app has.
476
+
477
+ Each part adds tool descriptions to every conversation: with both logged in it is about 1,900 tokens more (5,132 in total instead of 3,232); without logging in nothing changes.
478
+
479
+ Not verified yet: attendance submission, how long the attendance login lasts, and portals of campuses other than Malaysia.
480
+
411
481
  ## Updating
412
482
 
413
483
  ```bash
414
484
  monash update
415
485
  ```
416
486
 
417
- Restart Claude Desktop afterwards. On Windows it tells you to quit Claude first and which command to run next (a running program can't be overwritten).
487
+ Restart your AI app afterwards. On Windows it tells you to quit Claude first and which command to run next (a running program can't be overwritten); close Codex, Cursor or whichever app you use before updating.
418
488
 
419
- You'll be told when a new version is out: an extra line after terminal commands, and a short mention when you ask Claude for your to-dos. It checks GitHub at most once a day
489
+ You'll be told when a new version is out: an extra line after terminal commands, and a short mention when you ask your AI for your to-dos. It checks GitHub at most once a day
420
490
  and sends no personal information; to turn it off: `monash config update_check false`.
421
491
 
422
492
  ## FAQ
423
493
 
424
- ### monash doesn't show up in Claude
494
+ ### monash doesn't show up in your AI app
425
495
 
426
- Run `monash setup claude` to reconnect. On Windows, **fully quit** Claude from the tray first.
496
+ Claude Desktop or Claude Code: run `monash setup claude` to reconnect. On Windows, **fully quit** Claude from the tray first.
427
497
  If it still fails, check for errors under Claude Desktop → Settings → Developer.
428
498
 
499
+ Codex, Cursor, VS Code, Windsurf or Gemini CLI: run `monash connect` to see whether the app is connected, then `monash connect <app>` and restart the app.
500
+
429
501
  ### The login window won't open / "no browser found"
430
502
 
431
503
  Install Chrome or Edge. If your browser lives somewhere unusual, point to it:
@@ -436,6 +508,10 @@ Install Chrome or Edge. If your browser lives somewhere unusual, point to it:
436
508
  By default Windows limits full paths to 260 characters, and unit name + week name + file name can exceed that. Store course files somewhere shorter:
437
509
  `monash config files_dir C:\Monash`, then `monash sync`.
438
510
 
511
+ ### My units don't use Ed
512
+
513
+ That's fine: deadlines, grades, course files, search, mail and attendance work without it. When `monash setup` asks for the Ed token, press Enter to skip and answer yes to "not using Ed". Or run `monash config use_ed false` at any time. After that sync, the to-do list and `monash doctor` stop mentioning Ed, and your AI app no longer lists the Ed tools. `monash login ed` turns it back on.
514
+
439
515
  ### Australian campuses
440
516
 
441
517
  Moodle shows times in your account's time zone; the default is Malaysia (UTC+8). For Australian campuses: `monash config tz_offset 10` (11 during daylight saving).
@@ -448,7 +524,7 @@ Most Ed lessons have no due date; Moodle is the source of truth for deadlines. T
448
524
  ### Something is broken
449
525
 
450
526
  Run `monash doctor` and follow the → after each item. If you need help, send the whole output; it contains no tokens, cookies or similar.
451
- You can also just tell Claude "monash isn't working" and it will run the same checks. The MCP background log is `mcp.log` in the data directory.
527
+ You can also just tell your AI "monash isn't working" and it will run the same checks. The MCP background log is `mcp.log` in the data directory.
452
528
 
453
529
  ## Development
454
530
 
@@ -469,7 +545,7 @@ Every PR also builds the wheel, checks what went into it (`scripts/check_dist.py
469
545
 
470
546
  ```mermaid
471
547
  flowchart LR
472
- Claude["Claude Desktop / Claude Code"] -- "stdio (JSON-RPC)" --> MCP["mcp_server"]
548
+ Claude["Claude, Codex, Cursor and other local MCP apps"] -- "stdio (JSON-RPC)" --> MCP["mcp_server"]
473
549
  You["You, in a terminal"] --> CLI["cli / cli_ed"]
474
550
  MCP --> Core
475
551
  CLI --> Core
@@ -482,6 +558,10 @@ flowchart LR
482
558
  Core -- "API token, read-only" --> Ed["Ed"]
483
559
  Core -- "public pages only" --> Notes["Course-notes sites"]
484
560
  Login["browser_login + cdp: dedicated login window"] -- "Moodle cookie only" --> Core
561
+ Web["ChatGPT / Claude on the web (optional)"] -- "HTTPS + OAuth" --> Remote["remote"]
562
+ Remote --> Core
563
+ Browser["Your browser"] -- "127.0.0.1 only" --> Library["library"]
564
+ Library --> Core
485
565
  ```
486
566
 
487
567
  | Module | What it does |
@@ -494,6 +574,9 @@ flowchart LR
494
574
  | `content_index`, `textextract`, `webnotes` | Full-text search over PDFs, Office files, course-notes websites and transcripts |
495
575
  | `browser_login`, `cdp` | Dedicated login window driven over the Chrome DevTools Protocol (a minimal WebSocket client in the standard library) |
496
576
  | `jobs`, `mcp_server`, `cli` | Sync and keep-alive jobs, the MCP server, the command line |
577
+ | `widgets`, `ui/panel.html` | The study panels: what each tool attaches for MCP Apps hosts, and the single HTML page that draws them |
578
+ | `library` | `monash library`: the local, read-only page for browsing synced files |
579
+ | `remote` | `monash remote`: optional single-user remote MCP with pairing codes, OAuth and PKCE |
497
580
  | `doctor`, `doctor_deep`, `help_menu`, `update_check`, `claude_setup` | Health check and `--deep` cross-checks, help and preset prompts, new-version notice, adding the server to Claude |
498
581
  | `recordings`, `transcribe` | Optional: lecture recordings to timestamped transcripts (`[media]` extra) |
499
582
 
@@ -0,0 +1,72 @@
1
+ # Privacy policy
2
+
3
+ Last updated: 31 October 2026
4
+
5
+ **English** · [中文摘要](#中文摘要)
6
+
7
+ Monash Study Kit (also used under the name "Monash Student MCP") is open-source, self-hosted software. It is not a hosted service: each person runs it on their own computer or their own server, with their own accounts and credentials. The maintainer does not operate a shared server for other users and does not receive anyone's data.
8
+
9
+ This policy explains what the software accesses, where that data goes, and how to remove it.
10
+
11
+ ## What the software accesses
12
+
13
+ Depending on which parts you set up, the software signs in as you and reads:
14
+
15
+ - **Moodle** (learning.monash.edu): courses, files, assignments, grades, feedback, announcements, messages and calendar events.
16
+ - **Ed** (edstem.org): posts, replies, lessons and lesson progress.
17
+ - **Gmail** (optional): if you connect a Google account, messages, threads, labels and attachments, through the Gmail API.
18
+ - **Attendance** (optional): your attendance records on the university attendance portal.
19
+
20
+ Gmail access is requested only when you choose to connect it. The package includes a Google OAuth client (a "desktop app" registered in the maintainer's Google Cloud project) so you can sign in without creating your own. It only tells Google which app is asking; your mail goes from Google straight to your own computer and never passes through the maintainer, who cannot see your tokens or messages. You can use your own client instead with `--client`. By default the software asks for `gmail.modify`, which lets it read mail and, when you ask for it, create drafts, send a draft you reviewed or change labels (archive, mark as read, star). It cannot permanently delete email. If you only want reading, log in with `--read-only` and it asks for `gmail.readonly` instead. Every mailbox action and every attendance check-in runs only after you review the full preview and confirm that specific action.
21
+
22
+ ## How the data is used
23
+
24
+ Data is used only to provide the features you use: syncing a private local copy, full-text search, to-do and deadline summaries, and answering questions you ask through an AI app connected to your own instance.
25
+
26
+ The software does not use your data for advertising, does not sell it, and does not use it to build profiles or train machine-learning models.
27
+
28
+ ## Where the data is stored
29
+
30
+ - Synced data (course files, posts, email bodies and attachments) is stored on the machine that runs your instance: your own computer, or a server you control.
31
+ - Sign-in state (Moodle session, Ed token, Google OAuth tokens) is stored on that same machine in a private, owner-only directory. Passwords are never stored; Google sign-in happens in your own browser.
32
+ - Nothing is sent to the maintainer or to any analytics or telemetry service.
33
+
34
+ ## Sharing
35
+
36
+ The software sends data to:
37
+
38
+ - the services you connected (Moodle, Ed, Google, the attendance portal), to read your data and, only after you confirm, to carry out an action you asked for;
39
+ - the AI app you connect to your instance (for example Claude or Codex), and only the results of the queries that app makes on your behalf. That app's own privacy policy applies to what it receives. With the optional remote mode, an app receives mail or attendance results only if you ticked that feature when pairing it.
40
+
41
+ No other party receives your data.
42
+
43
+ ## Google user data
44
+
45
+ Use and transfer of information received from Google APIs adheres to the [Google API Services User Data Policy](https://developers.google.com/terms/api-services-user-data-policy), including the Limited Use requirements. Specifically, Google user data is used only to provide or improve the user-facing features described above; it is not transferred to others except as described in "Sharing", as needed to provide those features, to comply with law, or with your explicit consent; it is not used for advertising; and humans do not read it unless you ask for help with a specific message, it is needed for security or to comply with law, or the data is aggregated and anonymised for internal operations.
46
+
47
+ ## Keeping and deleting your data
48
+
49
+ Data stays until you delete it. You can at any time:
50
+
51
+ - revoke Google access at <https://myaccount.google.com/permissions>;
52
+ - delete the local data and credentials by removing the instance's data directory (`MONASH_KIT_HOME`, or `MONASH_KIT_DATA` and `MONASH_KIT_SECRETS` if you set them separately);
53
+ - uninstall the software.
54
+
55
+ Copies already downloaded (for example an attachment) remain on your machine until you delete them, even if the original is later deleted at the source.
56
+
57
+ ## Security
58
+
59
+ Credentials and private data are kept in owner-only files and directories, are never written to logs, and are not placed in the course-file web directory. Remote access to a self-hosted server requires OAuth sign-in. Details are in [docs/security.md](docs/security.md). To report a problem, see [SECURITY.md](SECURITY.md).
60
+
61
+ ## Changes and contact
62
+
63
+ Changes to this policy are published in this file, with the history visible in the repository. Questions can be raised through [GitHub issues](https://github.com/Waldo0926/monash-study-kit/issues).
64
+
65
+ ## 中文摘要
66
+
67
+ - 这是开源、自托管的软件:每个人在自己的电脑或自己的服务器上运行,维护者不运营共享服务,也收不到任何人的数据。
68
+ - 数据(课件、帖子、邮件正文与附件)和登录凭据只保存在运行实例的那台机器上,凭据存放在仅本人可读的目录,不保存密码。
69
+ - Gmail 为可选功能,默认只读;邮箱操作(草稿、发信、标签)需要额外授权,并在你确认具体内容后才执行,永不彻底删除邮件。
70
+ - 数据只发给你连接的服务(Moodle、Ed、Google、考勤门户)和你接入的 AI 应用(仅限它代你查询的结果);不用于广告、不出售、不用于训练模型。
71
+ - 使用 Google API 获取的数据遵守 Google API Services User Data Policy 及其 Limited Use 要求。
72
+ - 可随时在 <https://myaccount.google.com/permissions> 撤销 Google 授权,删除数据目录即可清除全部本地数据。