monash-study-kit 1.11.2__tar.gz → 1.15.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.
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/CHANGELOG.md +41 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/PKG-INFO +228 -154
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/PRIVACY.md +10 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/README.md +224 -151
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/README.zh-CN.md +220 -149
- monash_study_kit-1.15.0/docs/adr/0005-local-reliability-and-change-tracking.md +41 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/docs/adr/README.md +1 -0
- monash_study_kit-1.15.0/docs/read-reliability-audit-2026-11.md +22 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/docs/releasing.md +1 -1
- monash_study_kit-1.15.0/docs/reliability.md +80 -0
- monash_study_kit-1.15.0/docs/screenshots/README.md +19 -0
- monash_study_kit-1.15.0/docs/screenshots/course-export.png +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/pyproject.toml +3 -2
- monash_study_kit-1.15.0/scripts/demo_course_export.py +44 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/__init__.py +1 -1
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/attendance.py +51 -26
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/attendance_evidence.py +6 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/attendance_http.py +2 -2
- monash_study_kit-1.15.0/src/monash_study_kit/attendance_session.py +103 -0
- monash_study_kit-1.15.0/src/monash_study_kit/changes.py +151 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/cli.py +90 -3
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/cli_attendance.py +9 -1
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/content_index.py +25 -8
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/edsync.py +57 -48
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/export.py +54 -11
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/features.py +9 -4
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/help_menu.py +2 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/jobs.py +94 -48
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/lessons.py +11 -2
- monash_study_kit-1.15.0/src/monash_study_kit/local_state.py +52 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/materials_policy.py +1 -1
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/mcp_server.py +103 -24
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/moodlelib.py +35 -2
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/output.py +3 -1
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/paths.py +27 -18
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/remote.py +4 -1
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/service_setup.py +3 -2
- monash_study_kit-1.15.0/src/monash_study_kit/session_recovery.py +60 -0
- monash_study_kit-1.15.0/src/monash_study_kit/submissions.py +182 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/syncer.py +9 -5
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/textextract.py +40 -5
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/todo.py +2 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/update_check.py +13 -4
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_attendance_fast.py +1 -1
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_attendance_parity.py +19 -0
- monash_study_kit-1.15.0/tests/test_attendance_session.py +124 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_content_index.py +1 -1
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_export_pdf.py +1 -1
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_features.py +6 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_folderpick.py +2 -2
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_mcp.py +13 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_panels.py +3 -3
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_profiles.py +1 -1
- monash_study_kit-1.15.0/tests/test_reliability.py +420 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_remote.py +10 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_security.py +2 -2
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_shared_core.py +6 -1
- monash_study_kit-1.15.0/tests/test_submissions.py +194 -0
- monash_study_kit-1.15.0/tests/test_uninstall.py +32 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_update_check.py +8 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/uv.lock +107 -109
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/.github/ISSUE_TEMPLATE/bug_report.yml +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/.github/ISSUE_TEMPLATE/config.yml +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/.github/ISSUE_TEMPLATE/feature_request.yml +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/.github/pull_request_template.md +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/.github/workflows/release.yml +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/.github/workflows/test.yml +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/.gitignore +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/CODE_OF_CONDUCT.md +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/CONTRIBUTING.md +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/LICENSE +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/SECURITY.md +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/docs/SECURITY-REVIEW-1.5-SCOPE.md +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/docs/adr/0001-one-shared-core.md +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/docs/adr/0002-read-only-public-package.md +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/docs/adr/0003-release-from-a-tag.md +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/docs/adr/0004-confirmed-mail-and-attendance-actions.md +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/docs/gmail-foundation.md +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/docs/google-and-attendance-setup.md +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/docs/panels-library-remote.md +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/docs/screenshots/todo.png +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/docs/security.md +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/glama.json +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/scripts/check_dist.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/scripts/measure_tokens.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/scripts/smoke_test.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/skills/monash-study-kit/SKILL.md +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/__main__.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/attendance_assets/PROVENANCE.md +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/attendance_assets/extract-rows.js +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/attendance_assets/shared.js +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/attendance_auto.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/browser_login.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/cdp.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/claude_setup.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/cli_ed.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/cli_gmail.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/cli_google.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/cli_profile.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/clients.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/doctor.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/doctor_deep.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/edexport.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/edlib.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/edquery.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/entry.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/folderpick.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/gmail.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/gmail_tools.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/google_client.json +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/google_export.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/home.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/htmldom.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/htmlmd.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/lesson_reader.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/library.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/location.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/mdhtml.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/moodle_content.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/pdfrender.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/recordings.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/semester.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/service_actions.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/service_jobs.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/student_services.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/student_tools.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/transcribe.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/ui/panel.html +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/webnotes.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/src/monash_study_kit/widgets.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/conftest.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_attendance_browser.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_cdp.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_cli.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_clients.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_course_export.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_doctor.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_doctor_deep.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_ed_auth.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_ed_export.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_ed_markdown.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_ed_query.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_ed_quiz.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_ed_tracking.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_feature_cli.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_gmail.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_google_export.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_help_menu.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_layout.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_lesson_reader.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_library.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_location.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_moodle_content.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_recordings.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_removed_files.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_semester.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_service_setup.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_setup.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_skill.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_student_gmail.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_student_tools.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_sync_robustness.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_todo.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_webnotes.py +0 -0
- {monash_study_kit-1.11.2 → monash_study_kit-1.15.0}/tests/test_without_ed.py +0 -0
|
@@ -2,6 +2,47 @@
|
|
|
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
|
+
## 1.15.0
|
|
6
|
+
|
|
7
|
+
The first release on PyPI since 1.11.2. It also carries everything listed under 1.12.0 to 1.14.0 below, which were merged but never tagged.
|
|
8
|
+
|
|
9
|
+
- `monash uninstall` now revokes the Google Drive and Gmail authorisations of the default account and of every named profile before it deletes the data folder. It used to delete only the local token files, which left the grants active on the Google side. When revoking fails nothing is deleted, and it reminds you to delete the Ed token by hand.
|
|
10
|
+
- README (both languages): requirements, installation, first-time setup and everyday use now come first; per-release notes moved to one "Release notes" section near the end. The heading no longer names 1.11.2 as the current release.
|
|
11
|
+
- FAQ: added `monash: command not found`, a slow first sync, new units after a semester change, an invalid Ed token and removing everything.
|
|
12
|
+
|
|
13
|
+
## 1.14.0
|
|
14
|
+
|
|
15
|
+
- Add local-only silent attendance SSO recovery (`attendance renew`) and session maintenance with explicit authentication status and a one-hour failure cooldown (`attendance maintain`). A replaced application-state file triggers an immediate recheck. Interactive credentials/MFA remain user-controlled, and IdP state is never exported.
|
|
16
|
+
- Serialize local persistent-profile use, preserve old application state on failed recovery, and stop reporting background authentication failures as successful keepalives.
|
|
17
|
+
|
|
18
|
+
## 1.13.1
|
|
19
|
+
|
|
20
|
+
- Update optional attendance image processing to Pillow 13. Python 3.10 retains attendance record access but skips image OCR rather than installing vulnerable Pillow 12; image OCR requires Python 3.11+.
|
|
21
|
+
|
|
22
|
+
- Raise the pypdf minimum to 6.21.4 and refresh the lock to 7.1.0, removing known PDF resource-exhaustion advisories affecting the previous locked version.
|
|
23
|
+
|
|
24
|
+
- Add submission read paths to assignment gradebook entries, so marking review can continue directly to the submitted work.
|
|
25
|
+
- Keep complete cached submissions when a download is truncated, classify login-page responses as expired sessions, restrict redirected attachment authorities, and read collapsed online text only inside the submission region.
|
|
26
|
+
- Reject malformed MCP parameters with protocol errors and reject OAuth refresh scope changes without consuming valid refresh tokens. Remote clients now receive submission-reading guidance.
|
|
27
|
+
- Recover safely from malformed settings/status/update-cache JSON and bound the total extracted PowerPoint XML size.
|
|
28
|
+
|
|
29
|
+
## 1.13.0
|
|
30
|
+
|
|
31
|
+
- Read the signed-in student's or group's submitted assignment attachments, online text and full marking feedback via assignment `read_path` → `read_file`, or `list_moodle_assignments(assignment_id=cmid)`. Add `monash moodle submission <cmid> [--json]` for the same detail.
|
|
32
|
+
- Read PDF, DOCX and PPTX members inside ZIP archives with the existing pagination options. Binary submissions return a private local file path; video transcription is not included.
|
|
33
|
+
- Recheck live assignment access and file membership on every read; keep submission caches outside the course library and exports, bound downloads to 256 MiB, and isolate cookies across redirects. Materials-only profiles cannot read submissions through either CLI or MCP.
|
|
34
|
+
|
|
35
|
+
## 1.12.0
|
|
36
|
+
|
|
37
|
+
- Distinguish Moodle outages/rate limits from expired sessions, retry safe reads with bounded backoff, and attempt silent session recovery with shared cooldowns. Materials mode skips keepalive and recovery.
|
|
38
|
+
- Merge shared status under cross-process locks and use unique atomic temporary files for status, settings and credentials.
|
|
39
|
+
- Report partial syncs, preserve the last complete-success timestamp and add `monash sync --retry-failed` for failed activities, posts, Lessons and index entries.
|
|
40
|
+
- Mark old search results stale after failed re-extraction; report unreadable files and clear warnings after successful indexing.
|
|
41
|
+
- Track generated directory-export files in a manifest; remove obsolete untouched files while preserving user additions and edits.
|
|
42
|
+
- Add inclusive PDF page ranges and bounded extraction caching to the existing `read_file` MCP tool.
|
|
43
|
+
- Add local course-change history (`monash changes`, also in study todo): materials, assignment instructions, deadline times and teacher replies, with source links and baseline/retention limits.
|
|
44
|
+
- Support IANA timezones such as `Australia/Melbourne`, including daylight saving and Windows timezone data. Existing numeric offsets remain supported.
|
|
45
|
+
|
|
5
46
|
## 1.11.2
|
|
6
47
|
|
|
7
48
|
- Windows PDF browser startup retries once with a fresh isolated profile after an early exit or a startup timeout; each failed process is killed if needed and reaped before retry. Partially written port files and transient connection failures are retried within the startup deadline. A final failure explains the Markdown fallback option.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.5
|
|
2
2
|
Name: monash-study-kit
|
|
3
|
-
Version: 1.
|
|
3
|
+
Version: 1.15.0
|
|
4
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
|
|
@@ -20,9 +20,10 @@ Classifier: Programming Language :: Python :: 3.10
|
|
|
20
20
|
Classifier: Programming Language :: Python :: 3.13
|
|
21
21
|
Classifier: Topic :: Education
|
|
22
22
|
Requires-Python: >=3.10
|
|
23
|
-
Requires-Dist: pypdf>=4
|
|
23
|
+
Requires-Dist: pypdf>=6.21.4
|
|
24
|
+
Requires-Dist: tzdata; sys_platform == 'win32'
|
|
24
25
|
Provides-Extra: attendance
|
|
25
|
-
Requires-Dist: pillow<13
|
|
26
|
+
Requires-Dist: pillow<14,>=13; (python_version >= '3.11') and extra == 'attendance'
|
|
26
27
|
Requires-Dist: playwright<2,>=1.49; extra == 'attendance'
|
|
27
28
|
Requires-Dist: truststore<1,>=0.10; extra == 'attendance'
|
|
28
29
|
Requires-Dist: tzdata; (sys_platform == 'win32') and extra == 'attendance'
|
|
@@ -63,99 +64,7 @@ All Moodle and Ed tools are **read-only**: they never submit assignments, attemp
|
|
|
63
64
|
|
|
64
65
|
Built for Monash Malaysia (times are handled as UTC+8); Australian campuses work too, see the [FAQ](#faq).
|
|
65
66
|
|
|
66
|
-
|
|
67
|
-
|
|
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/).
|
|
69
|
-
|
|
70
|
-
---
|
|
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
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
## Multiple accounts / course materials only (1.10.0)
|
|
77
|
-
|
|
78
|
-
Without `--profile`, or with `--profile default`, the existing default account keeps its directory rules and features. Named accounts store separate databases, files, credentials and browser sessions under `<default data home>/profiles/<name>/`. The base still follows `MONASH_KIT_HOME` > `location.json` > the platform default. `default` is reserved; other names must match `[a-z0-9][a-z0-9_-]{0,31}`.
|
|
79
|
-
|
|
80
|
-
```bash
|
|
81
|
-
monash --profile alice setup # login and course selection only
|
|
82
|
-
monash --profile alice google login # optional; drive.readonly only
|
|
83
|
-
monash --profile alice sync
|
|
84
|
-
monash --profile=alice export FIT1045 --sync
|
|
85
|
-
monash --profile alice mcp # local stdio, materials tools only
|
|
86
|
-
monash profile list # manage from the default account
|
|
87
|
-
monash profile remove alice # confirm, clear logins, keep materials
|
|
88
|
-
monash profile remove alice --all --yes # also remove databases and materials
|
|
89
|
-
```
|
|
90
|
-
|
|
91
|
-
`MONASH_KIT_PROFILE=alice` also works; the command-line selection wins. Selection happens before importing service modules; an initialized Python process cannot switch accounts. Named profiles ignore individual directory overrides (`MONASH_KIT_DATA`, `MONASH_KIT_SECRETS`, `MONASH_KIT_FILES`, `MONASH_KIT_ED_DATA`, `MONASH_KIT_ED_TOKEN`, `ED_TOKEN`, and `files_dir`) to avoid sharing the default account's paths or credentials. Directories use mode 700 where supported.
|
|
92
|
-
|
|
93
|
-
Named profiles **stay local**: `remote`, `connect`, `setup claude`, and `move` are refused, and `setup` skips AI configuration. Sessions cannot be handed to remote services or AI configuration. Local stdio `mcp` can still be run manually. Profiles move together with the default data home rather than independently.
|
|
94
|
-
|
|
95
|
-
Named profiles force `materials_only=true`, even if settings or environment variables request false. The default account starts with false and can enable it with `monash config materials_only true`. While the mode is active, config can inspect this setting but cannot change it. To exit on the default account, temporarily override `MONASH_KIT_MATERIALS_ONLY=false`, then save false; named profiles cannot use this override.
|
|
96
|
-
|
|
97
|
-
Materials sync keeps Moodle files, Pages, Books, assignment descriptions and visible grading criteria, folders, linked Google files and Ed Lessons. It still reads Ed course lists to match unit codes, but never syncs discussions or replies. Gmail background sync, attendance reads and keepalive are skipped; Moodle login does not obtain a personal calendar link. `doctor --deep` checks materials and the search index only, skipping deadlines, submission status, grades and posts. Existing cached data is not deleted when enabling the mode.
|
|
98
|
-
|
|
99
|
-
Complete command policy in materials mode (refused commands return exit code 1):
|
|
100
|
-
|
|
101
|
-
- Allowed: `setup` (login and course selection), `login moodle/ed`, `google login/status/logout`, `sync`, `export`, `courses`, `status`, `doctor`, `open`, `library`, `config`, `grep`, `help`, `mcp`; `ed export/lessons/read/quiz`; `moodle ls/get`; `profile list/remove` from the default account.
|
|
102
|
-
- Config cannot change active `materials_only`; named profiles cannot change `files_dir`. `moodle get` only accepts course-resource/file entry points, rejecting grade pages and submission files.
|
|
103
|
-
- Refused: all `gmail` and `attendance` commands; `todo`, `due`, `semester`, `media`, `uninstall`, `update`, `connect`, `move`, all `remote`, `setup claude`; `ed courses/threads/search/show/new/following`; `moodle overview/due/calendar/assignments/grades/news/search/find/open/alerts/messages`. New commands require an explicit allowlist entry.
|
|
104
|
-
|
|
105
|
-
The MCP tool list is exactly `list_files`, `read_file`, `search_content`, `get_ed_lessons`, `export_ed_lessons`; `use_ed=false` removes the last two. Other tools and their legacy aliases fail when called. Export writes a local zip without changing upstream course data and retains its local-write MCP annotation. Personal study prompts are unavailable. There is no arbitrary Drive browsing or search command/tool: Google exports only follow course links during sync.
|
|
106
|
-
|
|
107
|
-
`profile list` checks only credential-file presence and disk usage, never reading or printing credential contents. Removal first revokes the target profile's Drive and Gmail Google OAuth authorizations in order. Any revocation failure stops removal and preserves **every local file** for a retry; an earlier successful remote revocation cannot be undone. Once all revocations succeed, `secrets/`, `browser-profile/` and `attendance-browser/` are removed. Only `--all` removes the complete profile, including materials and databases. The default account and other profiles are untouched; Moodle receives no logout or other request. Ed API tokens have no revocation interface here: manually delete them at [Ed API tokens](https://edstem.org/au/settings/api-tokens).
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
## 1.9.0: more complete course exports
|
|
111
|
-
|
|
112
|
-
Moodle Pages, Book chapters, assignment descriptions and visible rubrics / marking guides are saved as Markdown. Moodle images are stored in course `assets/` by content hash, and internal links to Page, Resource, Folder and Book activities are followed. Folder downloads preserve original names, subdirectories and case, reuse files for seven days, and fall back to individual downloads. Missing notebook images, case mismatches, empty pages and hidden grading criteria are explained in the index.
|
|
113
|
-
|
|
114
|
-
Ed Lessons document / code images hosted on `edusercontent.com` are cached locally, deduplicated by content and limited to 200 MB each. Failed images keep their original URL and an error record. Both Ed-only and whole-unit exports include `assets/` with working relative references.
|
|
115
|
-
|
|
116
|
-
Google Slides and Docs export as PDF, Sheets as XLSX, and ordinary Drive files retain their format. Only file links found in Moodle and Ed Lessons are processed; Google Forms cannot be exported. Existing exports are reused while the file remains on disk. Successful file links disappear from generated link lists; failures retain their URL and a Chinese reason in the index.
|
|
117
|
-
|
|
118
|
-
```bash
|
|
119
|
-
uv tool install --reinstall 'monash-study-kit[gmail]'
|
|
120
|
-
monash google login # bundled desktop OAuth client
|
|
121
|
-
monash google login --client client.json
|
|
122
|
-
monash google status
|
|
123
|
-
monash config google_docs_format docx # default: pdf; Google Docs only
|
|
124
|
-
monash sync FIT1045 --refresh-google # force Google exports to refresh
|
|
125
|
-
monash export FIT1045 --sync --json # sync this Moodle unit, then matching Ed units
|
|
126
|
-
monash google logout # revoke first, then remove the local token
|
|
127
|
-
```
|
|
128
|
-
|
|
129
|
-
The bundled OAuth client is published but not verified by Google: on first authorization Google shows “Google hasn't verified this app”; choose **Advanced → Go to Monash Student MCP (unsafe)** to continue. Google caps unverified apps at 100 users, and a school-managed account may be blocked by its admins (Google links then stay as links, with the reason in the index). Google classifies `drive.readonly` as a **restricted scope**. It permits reading Drive files; this tool only downloads files linked from courses and does not enumerate your Drive. Google authorization shares the optional `[gmail]` dependency, but uses an independent flow and `secrets/google-drive-token.json` under the data home (`MONASH_KIT_SECRETS` can override the directory). Gmail authorization and `gmail-token.json` are unchanged. Credentials stay in the terminal / browser authorization flow; never paste them into chat.
|
|
130
|
-
|
|
131
|
-
Downloads use read-only GET requests. For Drive export-size or administrator restrictions, a fallback tries the existing Google session in the dedicated login browser. Cookies are used only in memory, never logged or separately saved, and redirects outside Google's domains stop. The fallback may still be blocked by policy; failures keep the original link and explain why. Missing authorization points to `monash google login`. Moodle Page, Resource and assignment `view.php` requests still record a view. Normal folder downloads and Book print requests avoid their `view.php`; the individual-file fallback must open the folder page and records a view.
|
|
132
|
-
|
|
133
|
-
`monash export <unit>` now exports Markdown body pages, link lists, quizzes and the index as **PDF by default**, alongside the original course files. Install Chrome, Edge or Brave to generate PDFs; if no browser is found, the export falls back to Markdown and explains this in the index and terminal. Use `--format both` to include PDF and Markdown, or `--format md` for Markdown only. For example, `monash config export_format both` saves PDF and Markdown as the default. Synced Markdown stays unchanged on your computer for AI, search and MCP. PDF generation runs offline in a fresh temporary browser profile, embeds only local exported images and omits remote images (keeping their alt text). PDFs are cached under `data/pdf-cache/` (up to 500 MB); `--json` includes `pdf.generated`, `pdf.cached` and `pdf.skipped_reason`. `monash ed export` keeps its existing behavior.
|
|
134
|
-
|
|
135
|
-
Every sync checks newly discovered Ed units against tracked Moodle unit codes, including archived units and combined codes such as `FIT1045/FIT1053`; later user tracking choices are preserved. `monash export <unit> --sync` refreshes Moodle first, then the matching Ed Lessons (not forum threads), before exporting; `--refresh-google` also re-exports Google files. Run in a terminal, `monash export` first opens the system folder picker to choose where to save (defaulting to your last choice, else Downloads) and then starts; `--to <folder>` or `--no-ask` skip the dialog. It prints the destination and PDF progress as it goes. Ordinary exports use only local data. The README index includes all omission notes and failed Ed images, plus counts of link lists, remote Markdown images, Google links, successful exports and failures grouped by reason; `--json` exposes the same counts in `statistics`.
|
|
136
|
-
|
|
137
|
-
New tests use synthetic HTML / JSON, fake clients and mocked HTTP, with no real account requests. Ed code-challenge workspace downloads still require a real read-only response to establish the interface and are excluded, as are multi-account profiles.
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
## Two parts, one codebase
|
|
141
|
-
|
|
142
|
-
The same core (login, sync, queries) serves two kinds of "users":
|
|
143
|
-
|
|
144
|
-
**MCP: the interface for your AI app.** Moodle and Ed both sit behind Okta + MFA, so the AI cannot get in by itself.
|
|
145
|
-
The MCP server lets it look things up mid-conversation (tools such as `get_study_todo`, `search_content`, `list_ed_updates`):
|
|
146
|
-
|
|
147
|
-
- **Answers come from real data**: deadlines, announcements and grades are fetched live, with sources such as "Workshop 5 Slides, page 25".
|
|
148
|
-
- **Both platforms at once**: one "what do I need to do this week" checks Moodle deadlines, unfinished Ed lessons and announcements from both.
|
|
149
|
-
- **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.
|
|
150
|
-
- **Natural follow-ups**: "What does the A2 spec require?" "Explain that week's functor material using the lecture notes."
|
|
151
|
-
|
|
152
|
-
**CLI (the `monash` command): the interface for humans.**
|
|
153
|
-
|
|
154
|
-
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).
|
|
155
|
-
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)).
|
|
156
|
-
3. **Troubleshooting and maintenance**: `status`, `sync`, `update`, `uninstall`.
|
|
157
|
-
|
|
158
|
-
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.
|
|
67
|
+
**New here?** [Install](#installation) · [First-time setup](#first-time-setup-monash-setup) · [Everyday use](#everyday-use) · [FAQ](#faq)
|
|
159
68
|
|
|
160
69
|
## Requirements
|
|
161
70
|
|
|
@@ -236,36 +145,6 @@ At the end you can choose to sync right away. The first sync downloads all cours
|
|
|
236
145
|
|
|
237
146
|
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.
|
|
238
147
|
|
|
239
|
-
## What's new in 1.7
|
|
240
|
-
|
|
241
|
-
- **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.
|
|
242
|
-
- **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.
|
|
243
|
-
- **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.
|
|
244
|
-
- **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.
|
|
245
|
-
|
|
246
|
-
## What's new in 1.6
|
|
247
|
-
|
|
248
|
-
- **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.
|
|
249
|
-
|
|
250
|
-
## What's new in 1.5
|
|
251
|
-
|
|
252
|
-
- **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.
|
|
253
|
-
- **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.
|
|
254
|
-
- **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.
|
|
255
|
-
- **Remote apps choose.** With `monash remote`, each app you pair ticks which of these it may use.
|
|
256
|
-
- **Units without Ed** can turn Ed off: `monash config use_ed false`.
|
|
257
|
-
|
|
258
|
-
Details: [Optional: Gmail and attendance](#optional-gmail-and-attendance) and the [changelog](CHANGELOG.md).
|
|
259
|
-
|
|
260
|
-
## What's new in 1.4
|
|
261
|
-
|
|
262
|
-
- **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.
|
|
263
|
-
- **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.
|
|
264
|
-
- **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.
|
|
265
|
-
- **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/).
|
|
266
|
-
|
|
267
|
-
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).
|
|
268
|
-
|
|
269
148
|
## Everyday use
|
|
270
149
|
|
|
271
150
|
Just ask in your AI app. While it is open, the tool works in the background:
|
|
@@ -311,6 +190,111 @@ The CLI doesn't use AI and consumes no usage. Run `monash sync` first, then:
|
|
|
311
190
|
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:
|
|
312
191
|
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.
|
|
313
192
|
|
|
193
|
+
## Two parts, one codebase
|
|
194
|
+
|
|
195
|
+
The same core (login, sync, queries) serves two kinds of "users":
|
|
196
|
+
|
|
197
|
+
**MCP: the interface for your AI app.** Moodle and Ed both sit behind Okta + MFA, so the AI cannot get in by itself.
|
|
198
|
+
The MCP server lets it look things up mid-conversation (tools such as `get_study_todo`, `search_content`, `list_ed_updates`):
|
|
199
|
+
|
|
200
|
+
- **Answers come from real data**: deadlines, announcements and grades are fetched live, with sources such as "Workshop 5 Slides, page 25".
|
|
201
|
+
- **Both platforms at once**: one "what do I need to do this week" checks Moodle deadlines, unfinished Ed lessons and announcements from both.
|
|
202
|
+
- **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.
|
|
203
|
+
- **Natural follow-ups**: "What does the A2 spec require?" "Explain that week's functor material using the lecture notes."
|
|
204
|
+
|
|
205
|
+
**CLI (the `monash` command): the interface for humans.**
|
|
206
|
+
|
|
207
|
+
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).
|
|
208
|
+
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)).
|
|
209
|
+
3. **Troubleshooting and maintenance**: `status`, `sync`, `update`, `uninstall`.
|
|
210
|
+
|
|
211
|
+
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.
|
|
212
|
+
|
|
213
|
+
## Export a whole unit's materials
|
|
214
|
+
|
|
215
|
+
Export course materials without an AI app. Install or upgrade, sign in and select your units, then run:
|
|
216
|
+
|
|
217
|
+
```bash
|
|
218
|
+
uv tool install --upgrade 'monash-study-kit[gmail]'
|
|
219
|
+
monash setup
|
|
220
|
+
monash google login # only for course-linked Google files; separate read-only consent
|
|
221
|
+
monash export FIT1043 --sync --format both --to "./exports"
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
Replace `FIT1043` with your unit code. Packages include Moodle files, Pages, Books, assignment instructions, Ed Lessons and accessible Google files; personal submissions, grades, mail and attendance are excluded. Check the package README for omissions. Version 1.11.2 fixes Windows PDF browser cold-start retries.
|
|
225
|
+
|
|
226
|
+

|
|
227
|
+
|
|
228
|
+
This screenshot comes from a real `monash export` run against synthetic local data, deliberately including a missing attachment and an unauthorized Google link to demonstrate omissions. No real account or course content is used. Omit `--sync` to export existing local data; sync and export again to retry missing materials. See the [whole-course export guide](https://docs.secureview.tech/study-kit/materials/).
|
|
229
|
+
|
|
230
|
+

|
|
231
|
+
|
|
232
|
+
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/).
|
|
233
|
+
|
|
234
|
+
---
|
|
235
|
+
|
|
236
|
+
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.
|
|
237
|
+
|
|
238
|
+
## Optional: Gmail and attendance
|
|
239
|
+
|
|
240
|
+
New in 1.5.0. Both parts are off until you connect them and only run on your own computer.
|
|
241
|
+
|
|
242
|
+
- **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.
|
|
243
|
+
- **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.
|
|
244
|
+
|
|
245
|
+
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:
|
|
246
|
+
|
|
247
|
+
```bash
|
|
248
|
+
uv tool install --reinstall "monash-study-kit[gmail,attendance]"
|
|
249
|
+
monash gmail login
|
|
250
|
+
monash gmail sync
|
|
251
|
+
monash attendance login
|
|
252
|
+
monash attendance sync
|
|
253
|
+
```
|
|
254
|
+
|
|
255
|
+
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.
|
|
256
|
+
|
|
257
|
+
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`.
|
|
258
|
+
|
|
259
|
+
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.
|
|
260
|
+
|
|
261
|
+
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.
|
|
262
|
+
|
|
263
|
+
Not verified yet: attendance submission, how long the attendance login lasts, and portals of campuses other than Malaysia.
|
|
264
|
+
|
|
265
|
+
## Multiple accounts / course materials only
|
|
266
|
+
|
|
267
|
+
Without `--profile`, or with `--profile default`, the existing default account keeps its directory rules and features. Named accounts store separate databases, files, credentials and browser sessions under `<default data home>/profiles/<name>/`. The base still follows `MONASH_KIT_HOME` > `location.json` > the platform default. `default` is reserved; other names must match `[a-z0-9][a-z0-9_-]{0,31}`.
|
|
268
|
+
|
|
269
|
+
```bash
|
|
270
|
+
monash --profile alice setup # login and course selection only
|
|
271
|
+
monash --profile alice google login # optional; drive.readonly only
|
|
272
|
+
monash --profile alice sync
|
|
273
|
+
monash --profile=alice export FIT1045 --sync
|
|
274
|
+
monash --profile alice mcp # local stdio, materials tools only
|
|
275
|
+
monash profile list # manage from the default account
|
|
276
|
+
monash profile remove alice # confirm, clear logins, keep materials
|
|
277
|
+
monash profile remove alice --all --yes # also remove databases and materials
|
|
278
|
+
```
|
|
279
|
+
|
|
280
|
+
`MONASH_KIT_PROFILE=alice` also works; the command-line selection wins. Selection happens before importing service modules; an initialized Python process cannot switch accounts. Named profiles ignore individual directory overrides (`MONASH_KIT_DATA`, `MONASH_KIT_SECRETS`, `MONASH_KIT_FILES`, `MONASH_KIT_ED_DATA`, `MONASH_KIT_ED_TOKEN`, `ED_TOKEN`, and `files_dir`) to avoid sharing the default account's paths or credentials. Directories use mode 700 where supported.
|
|
281
|
+
|
|
282
|
+
Named profiles **stay local**: `remote`, `connect`, `setup claude`, and `move` are refused, and `setup` skips AI configuration. Sessions cannot be handed to remote services or AI configuration. Local stdio `mcp` can still be run manually. Profiles move together with the default data home rather than independently.
|
|
283
|
+
|
|
284
|
+
Named profiles force `materials_only=true`, even if settings or environment variables request false. The default account starts with false and can enable it with `monash config materials_only true`. While the mode is active, config can inspect this setting but cannot change it. To exit on the default account, temporarily override `MONASH_KIT_MATERIALS_ONLY=false`, then save false; named profiles cannot use this override.
|
|
285
|
+
|
|
286
|
+
Materials sync keeps Moodle files, Pages, Books, assignment descriptions and visible grading criteria, folders, linked Google files and Ed Lessons. It still reads Ed course lists to match unit codes, but never syncs discussions or replies. Gmail background sync, attendance reads and keepalive are skipped; Moodle login does not obtain a personal calendar link. `doctor --deep` checks materials and the search index only, skipping deadlines, submission status, grades and posts. Existing cached data is not deleted when enabling the mode.
|
|
287
|
+
|
|
288
|
+
Complete command policy in materials mode (refused commands return exit code 1):
|
|
289
|
+
|
|
290
|
+
- Allowed: `setup` (login and course selection), `login moodle/ed`, `google login/status/logout`, `sync`, `export`, `courses`, `status`, `doctor`, `open`, `library`, `config`, `grep`, `help`, `mcp`; `ed export/lessons/read/quiz`; `moodle ls/get`; `profile list/remove` from the default account.
|
|
291
|
+
- Config cannot change active `materials_only`; named profiles cannot change `files_dir`. `moodle get` only accepts course-resource/file entry points, rejecting grade pages and submission files.
|
|
292
|
+
- Refused: all `gmail` and `attendance` commands; `todo`, `due`, `semester`, `media`, `uninstall`, `update`, `connect`, `move`, all `remote`, `setup claude`; `ed courses/threads/search/show/new/following`; `moodle overview/due/calendar/assignments/grades/news/search/find/open/alerts/messages`. New commands require an explicit allowlist entry.
|
|
293
|
+
|
|
294
|
+
The MCP tool list is exactly `list_files`, `read_file`, `search_content`, `get_ed_lessons`, `export_ed_lessons`; `use_ed=false` removes the last two. Other tools and their legacy aliases fail when called. Export writes a local zip without changing upstream course data and retains its local-write MCP annotation. Personal study prompts are unavailable. There is no arbitrary Drive browsing or search command/tool: Google exports only follow course links during sync.
|
|
295
|
+
|
|
296
|
+
`profile list` checks only credential-file presence and disk usage, never reading or printing credential contents. Removal first revokes the target profile's Drive and Gmail Google OAuth authorizations in order. Any revocation failure stops removal and preserves **every local file** for a retry; an earlier successful remote revocation cannot be undone. Once all revocations succeed, `secrets/`, `browser-profile/` and `attendance-browser/` are removed. Only `--all` removes the complete profile, including materials and databases. The default account and other profiles are untouched; Moodle receives no logout or other request. Ed API tokens have no revocation interface here: manually delete them at [Ed API tokens](https://edstem.org/au/settings/api-tokens).
|
|
297
|
+
|
|
314
298
|
## Other AI clients
|
|
315
299
|
|
|
316
300
|
MCP is an open protocol and `monash mcp` is a standard local (stdio) MCP server, so any client that supports local MCP servers should in principle work.
|
|
@@ -520,33 +504,6 @@ monash media
|
|
|
520
504
|
|
|
521
505
|
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`.
|
|
522
506
|
|
|
523
|
-
## Optional: Gmail and attendance
|
|
524
|
-
|
|
525
|
-
New in 1.5.0. Both parts are off until you connect them and only run on your own computer.
|
|
526
|
-
|
|
527
|
-
- **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.
|
|
528
|
-
- **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.
|
|
529
|
-
|
|
530
|
-
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:
|
|
531
|
-
|
|
532
|
-
```bash
|
|
533
|
-
uv tool install --reinstall "monash-study-kit[gmail,attendance]"
|
|
534
|
-
monash gmail login
|
|
535
|
-
monash gmail sync
|
|
536
|
-
monash attendance login
|
|
537
|
-
monash attendance sync
|
|
538
|
-
```
|
|
539
|
-
|
|
540
|
-
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.
|
|
541
|
-
|
|
542
|
-
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`.
|
|
543
|
-
|
|
544
|
-
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.
|
|
545
|
-
|
|
546
|
-
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.
|
|
547
|
-
|
|
548
|
-
Not verified yet: attendance submission, how long the attendance login lasts, and portals of campuses other than Malaysia.
|
|
549
|
-
|
|
550
507
|
## Updating
|
|
551
508
|
|
|
552
509
|
```bash
|
|
@@ -599,6 +556,105 @@ Most Ed lessons have no due date; Moodle is the source of truth for deadlines. T
|
|
|
599
556
|
Run `monash doctor` and follow the → after each item. If you need help, send the whole output; it contains no tokens, cookies or similar.
|
|
600
557
|
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.
|
|
601
558
|
|
|
559
|
+
### `monash: command not found`
|
|
560
|
+
|
|
561
|
+
Close the terminal and open it again; `uv` adds its tools folder to your PATH only for new windows. Still missing: run `uv tool update-shell`, then reopen the terminal.
|
|
562
|
+
|
|
563
|
+
### The first sync takes very long
|
|
564
|
+
|
|
565
|
+
The first sync downloads every file of every tracked unit. To get one unit first, run `monash sync FIT1045` (your own unit code). `monash status` shows whether the last sync was complete or partial, and `monash sync --retry-failed` retries only what failed.
|
|
566
|
+
|
|
567
|
+
### A new semester started and my new units are missing
|
|
568
|
+
|
|
569
|
+
Run `monash courses` and pick the units again, then `monash sync`.
|
|
570
|
+
|
|
571
|
+
### Ed says the token is invalid
|
|
572
|
+
|
|
573
|
+
You probably deleted the token on Ed's token page. Create a new one there and run `monash login ed` to paste it.
|
|
574
|
+
|
|
575
|
+
### I want to remove everything
|
|
576
|
+
|
|
577
|
+
`monash uninstall` removes monash from Claude and the other AI apps, then asks whether to delete all data. If you say yes it first revokes the Google authorisations (Drive and Gmail) and deletes nothing when that fails. The Ed token has no revoke API: delete it on Ed's token page. Finish with `uv tool uninstall monash-study-kit`.
|
|
578
|
+
|
|
579
|
+
## Release notes
|
|
580
|
+
|
|
581
|
+
What each release added, newest first. The version badge at the top shows the latest release and [CHANGELOG.md](CHANGELOG.md) has every change.
|
|
582
|
+
|
|
583
|
+
### 1.12: sync reliability and change summaries
|
|
584
|
+
|
|
585
|
+
`monash status` now distinguishes partial and complete syncs. Use
|
|
586
|
+
`monash sync --retry-failed` to retry failures and `monash changes --days 7`
|
|
587
|
+
to review observed material, assignment, deadline and teacher-reply changes.
|
|
588
|
+
The first observation establishes a baseline; deadline changes are recorded
|
|
589
|
+
when you read deadlines. History stays local, and materials-only profiles omit
|
|
590
|
+
personal information. Search warns when an older extraction is stale.
|
|
591
|
+
|
|
592
|
+
PDF reads through MCP support `page_start` / `page_end` with bounded caching.
|
|
593
|
+
Directory re-exports clean obsolete generated files while preserving unrelated
|
|
594
|
+
files and edited obsolete files. Silent Moodle recovery uses the dedicated
|
|
595
|
+
browser profile and never opens an MFA window in the background; disable it with
|
|
596
|
+
`monash config auto_relogin false`. For Australian daylight saving, use
|
|
597
|
+
`monash config timezone Australia/Melbourne`. See [behavior and limits](docs/reliability.md).
|
|
598
|
+
|
|
599
|
+
### 1.9: more complete course exports
|
|
600
|
+
|
|
601
|
+
Moodle Pages, Book chapters, assignment descriptions and visible rubrics / marking guides are saved as Markdown. Moodle images are stored in course `assets/` by content hash, and internal links to Page, Resource, Folder and Book activities are followed. Folder downloads preserve original names, subdirectories and case, reuse files for seven days, and fall back to individual downloads. Missing notebook images, case mismatches, empty pages and hidden grading criteria are explained in the index.
|
|
602
|
+
|
|
603
|
+
Ed Lessons document / code images hosted on `edusercontent.com` are cached locally, deduplicated by content and limited to 200 MB each. Failed images keep their original URL and an error record. Both Ed-only and whole-unit exports include `assets/` with working relative references.
|
|
604
|
+
|
|
605
|
+
Google Slides and Docs export as PDF, Sheets as XLSX, and ordinary Drive files retain their format. Only file links found in Moodle and Ed Lessons are processed; Google Forms cannot be exported. Existing exports are reused while the file remains on disk. Successful file links disappear from generated link lists; failures retain their URL and a Chinese reason in the index.
|
|
606
|
+
|
|
607
|
+
```bash
|
|
608
|
+
uv tool install --reinstall 'monash-study-kit[gmail]'
|
|
609
|
+
monash google login # bundled desktop OAuth client
|
|
610
|
+
monash google login --client client.json
|
|
611
|
+
monash google status
|
|
612
|
+
monash config google_docs_format docx # default: pdf; Google Docs only
|
|
613
|
+
monash sync FIT1045 --refresh-google # force Google exports to refresh
|
|
614
|
+
monash export FIT1045 --sync --json # sync this Moodle unit, then matching Ed units
|
|
615
|
+
monash google logout # revoke first, then remove the local token
|
|
616
|
+
```
|
|
617
|
+
|
|
618
|
+
The bundled OAuth client is published but not verified by Google: on first authorization Google shows “Google hasn't verified this app”; choose **Advanced → Go to Monash Student MCP (unsafe)** to continue. Google caps unverified apps at 100 users, and a school-managed account may be blocked by its admins (Google links then stay as links, with the reason in the index). Google classifies `drive.readonly` as a **restricted scope**. It permits reading Drive files; this tool only downloads files linked from courses and does not enumerate your Drive. Google authorization shares the optional `[gmail]` dependency, but uses an independent flow and `secrets/google-drive-token.json` under the data home (`MONASH_KIT_SECRETS` can override the directory). Gmail authorization and `gmail-token.json` are unchanged. Credentials stay in the terminal / browser authorization flow; never paste them into chat.
|
|
619
|
+
|
|
620
|
+
Downloads use read-only GET requests. For Drive export-size or administrator restrictions, a fallback tries the existing Google session in the dedicated login browser. Cookies are used only in memory, never logged or separately saved, and redirects outside Google's domains stop. The fallback may still be blocked by policy; failures keep the original link and explain why. Missing authorization points to `monash google login`. Moodle Page, Resource and assignment `view.php` requests still record a view. Normal folder downloads and Book print requests avoid their `view.php`; the individual-file fallback must open the folder page and records a view.
|
|
621
|
+
|
|
622
|
+
`monash export <unit>` now exports Markdown body pages, link lists, quizzes and the index as **PDF by default**, alongside the original course files. Install Chrome, Edge or Brave to generate PDFs; if no browser is found, the export falls back to Markdown and explains this in the index and terminal. Use `--format both` to include PDF and Markdown, or `--format md` for Markdown only. For example, `monash config export_format both` saves PDF and Markdown as the default. Synced Markdown stays unchanged on your computer for AI, search and MCP. PDF generation runs offline in a fresh temporary browser profile, embeds only local exported images and omits remote images (keeping their alt text). PDFs are cached under `data/pdf-cache/` (up to 500 MB); `--json` includes `pdf.generated`, `pdf.cached` and `pdf.skipped_reason`. `monash ed export` keeps its existing behavior.
|
|
623
|
+
|
|
624
|
+
Every sync checks newly discovered Ed units against tracked Moodle unit codes, including archived units and combined codes such as `FIT1045/FIT1053`; later user tracking choices are preserved. `monash export <unit> --sync` refreshes Moodle first, then the matching Ed Lessons (not forum threads), before exporting; `--refresh-google` also re-exports Google files. Run in a terminal, `monash export` first opens the system folder picker to choose where to save (defaulting to your last choice, else Downloads) and then starts; `--to <folder>` or `--no-ask` skip the dialog. It prints the destination and PDF progress as it goes. Ordinary exports use only local data. The README index includes all omission notes and failed Ed images, plus counts of link lists, remote Markdown images, Google links, successful exports and failures grouped by reason; `--json` exposes the same counts in `statistics`.
|
|
625
|
+
|
|
626
|
+
New tests use synthetic HTML / JSON, fake clients and mocked HTTP, with no real account requests. Ed code-challenge workspace downloads still require a real read-only response to establish the interface and are excluded, as are multi-account profiles.
|
|
627
|
+
|
|
628
|
+
### 1.7
|
|
629
|
+
|
|
630
|
+
- **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.
|
|
631
|
+
- **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.
|
|
632
|
+
- **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.
|
|
633
|
+
- **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.
|
|
634
|
+
|
|
635
|
+
### 1.6
|
|
636
|
+
|
|
637
|
+
- **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.
|
|
638
|
+
|
|
639
|
+
### 1.5
|
|
640
|
+
|
|
641
|
+
- **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.
|
|
642
|
+
- **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.
|
|
643
|
+
- **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.
|
|
644
|
+
- **Remote apps choose.** With `monash remote`, each app you pair ticks which of these it may use.
|
|
645
|
+
- **Units without Ed** can turn Ed off: `monash config use_ed false`.
|
|
646
|
+
|
|
647
|
+
Details: [Optional: Gmail and attendance](#optional-gmail-and-attendance) and the [changelog](CHANGELOG.md).
|
|
648
|
+
|
|
649
|
+
### 1.4
|
|
650
|
+
|
|
651
|
+
- **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.
|
|
652
|
+
- **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.
|
|
653
|
+
- **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.
|
|
654
|
+
- **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/).
|
|
655
|
+
|
|
656
|
+
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).
|
|
657
|
+
|
|
602
658
|
## Development
|
|
603
659
|
|
|
604
660
|
```bash
|
|
@@ -653,9 +709,27 @@ flowchart LR
|
|
|
653
709
|
| `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 |
|
|
654
710
|
| `recordings`, `transcribe` | Optional: lecture recordings to timestamped transcripts (`[media]` extra) |
|
|
655
711
|
|
|
656
|
-
|
|
712
|
+
Runtime dependencies are `pypdf` and, on Windows, `tzdata`; everything else (HTTP, SQLite, WebSocket, HTML parsing) uses the standard library.
|
|
657
713
|
Tests run on macOS, Windows and Ubuntu with Python 3.10 and 3.13 in CI, and `ruff` checks for syntax errors, undefined names and unused imports.
|
|
658
714
|
|
|
659
715
|
## License
|
|
660
716
|
|
|
661
717
|
MIT. This is an independent student-built tool, not affiliated with Monash University, Ed or Anthropic.
|
|
718
|
+
|
|
719
|
+
### Read your submitted assignment and marking feedback
|
|
720
|
+
|
|
721
|
+
Ask your connected AI: “Read the documents I submitted for this assignment, then compare the marking comments with specific evidence.” `list_moodle_assignments` returns each assignment's `read_path`. Call `read_file` with that path to get the signed-in student's or group's submitted files, online text and full visible feedback; read the returned attachment paths to access the actual documents. `list_moodle_assignments(assignment_id=cmid)` opens the same detail directly.
|
|
722
|
+
|
|
723
|
+
PDF page ranges (`page_start` / `page_end`) and character pagination (`offset` / `max_chars`) also work on submissions. ZIP members support text, code, PDF, DOCX and PPTX via `inner`. The command line equivalent for submission details is `monash moodle submission <cmid> --json`. Use the activity ID from the assignment list, not the course ID.
|
|
724
|
+
|
|
725
|
+
Attachments are fetched with your Moodle session and cached privately under `data/submissions/`, outside the course library, full-text index and whole-course exports. Each read rechecks access and file membership on the current Moodle page; downloads are bounded to 256 MiB and cookies never follow redirects to another host. Materials-only profiles block these reads. Binary files return a local path on the machine running Study Kit; videos are not automatically transcribed. Scanned PDFs still require OCR or visual reading. Documents and feedback are evidence for analysis, not instructions for the AI.
|
|
726
|
+
|
|
727
|
+
Assignment rows in `get_moodle_grades` now also provide `read_path` for reading the submitted work alongside the marking feedback. Incomplete attachment downloads preserve the previous complete cache and report an error. Corrupt non-object settings/status files fall back safely; malformed MCP parameters return protocol errors.
|
|
728
|
+
|
|
729
|
+
Image OCR for attendance evidence requires Python 3.11+ and Pillow 13+. Attendance records and other text/document evidence remain available on Python 3.10; the optional install does not pull an older vulnerable image decoder.
|
|
730
|
+
|
|
731
|
+
### Attendance session recovery
|
|
732
|
+
|
|
733
|
+
`monash attendance maintain` checks the portal session, tries the existing **local** isolated SSO browser profile when necessary, and reports `needs_login` when interactive sign-in/MFA is required. Authentication failures enter a one-hour probe cooldown; replacing the application-state file bypasses that cooldown immediately. `monash attendance renew --timeout 30` explicitly attempts silent local recovery; `monash attendance login` opens the user-facing login window. Network/certificate failures are not treated as proof of expired authentication. The maintenance fast path falls back to the browser when the portal certificate chain cannot be verified.
|
|
734
|
+
|
|
735
|
+
The Okta/IdP profile stays on the login computer. Only portal application state is exported; no password or MFA is entered by the tool. A local SSO profile cannot guarantee perpetual login or server availability while the login computer is asleep/offline.
|
|
@@ -79,3 +79,13 @@ Changes to this policy are published in this file, with the history visible in t
|
|
|
79
79
|
- 数据只发给你连接的服务(Moodle、Ed、Google、考勤门户)和你接入的 AI 应用(仅限它代你查询的结果);不用于广告、不出售、不用于训练模型。
|
|
80
80
|
- 使用 Google API 获取的数据遵守 Google API Services User Data Policy 及其 Limited Use 要求。
|
|
81
81
|
- 可随时在 <https://myaccount.google.com/permissions> 撤销 Google 授权,删除数据目录即可清除全部本地数据。
|
|
82
|
+
|
|
83
|
+
## On-demand submitted assignments / 按需读取已交作业
|
|
84
|
+
|
|
85
|
+
In the default profile, assignment submission and feedback tools read only what the signed-in account can access on its current Moodle assignment page. Attachments are downloaded on demand into `data/submissions/`, separate from course files, search indexes, the local course library and course exports. Cached copies remain on the Study Kit host until manually deleted; deleting this directory removes them. AI clients receive the requested extracted document text and visible grading feedback through MCP. Binary-file responses expose a local host path, not a public download URL. Materials-only profiles block these reads, including the `read_file` submission-path route.
|
|
86
|
+
|
|
87
|
+
默认账号按需读取当前 Moodle 会话有权访问的提交文件和反馈;附件缓存于 `data/submissions/`,不进入课程课件、搜索索引、课程浏览页或整课导出。缓存保留在运行 Study Kit 的机器上,需手动删除此目录清理。通过 MCP 读取时,相关文档正文和可见评分反馈会发送给调用的 AI 客户端;二进制文件返回本地路径,不提供公开下载链接。仅课程资料模式同时封锁直接详情和 `read_file` 的提交路径。
|
|
88
|
+
|
|
89
|
+
## Attendance recovery
|
|
90
|
+
|
|
91
|
+
Silent attendance recovery reuses the existing isolated browser profile only on the login computer. It does not export IdP/Okta cookies or automate passwords/MFA. Only the application state filtered by the attendance adapter is saved for optional transfer. Authentication status stores timestamps and application-file metadata rather than cookie values. Failed recovery preserves the old application-state file and backs off until the next probe or a replacement file.
|