induslms-agent 0.3.0__py3-none-any.whl

induslms_agent-0.3.0.dist-info/METADATA

@@ -0,0 +1,252 @@
+Metadata-Version: 2.4
+Name: induslms-agent
+Version: 0.3.0
+Summary: Read-only agent access to Indus LMS academics: announcements, assignments, shared resources, attendance
+Author: IndusLMS Agent contributors
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/StrangeSid/induslms-agent
+Project-URL: Repository, https://github.com/StrangeSid/induslms-agent
+Project-URL: Issues, https://github.com/StrangeSid/induslms-agent/issues
+Keywords: lms,mcp,education,school,agent
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Education
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Education
+Classifier: Topic :: Scientific/Engineering :: Interface Engine/Protocol Translator
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.31
+Requires-Dist: mcp<2,>=1.0
+Requires-Dist: msal>=1.30
+Requires-Dist: python-dotenv>=1.0
+Dynamic: license-file
+
+# IndusLMS Agent
+
+Read-only agent access to Indus LMS academics: **announcements, assignments, shared resources, notifications, attendance**. For `pi` + `opencode` harnesses via **MCP + Skill + CLI**.
+
+## Quickstart (one command)
+
+```bash
+git clone https://github.com/StrangeSid/induslms-agent.git
+cd induslms-agent
+./install.sh
+```
+
+This creates `.venv`, installs the package, runs `lms.py login`,
+merges MCP configs for pi + opencode, installs the skill, and runs
+`lms.py doctor`. Restart your agent host afterwards.
+
+Manual setup (if you prefer):
+
+> Replace `/path/to/induslms-agent` with your checkout path and
+> `you@indusschool.com` with your school email.
+
+```bash
+cd /path/to/induslms-agent
+python3 -m venv .venv && source .venv/bin/activate
+pip install -e .  # or: pip install -r requirements.txt
+
+cp .env.example .env  # then fill INDUSLMS_EMAIL/PASS/TENANT (.env auto-loaded)
+# Authenticate once (token saved OUTSIDE the repo)
+python3 lms.py login you@indusschool.com
+# or: INDUSLMS_EMAIL=... INDUSLMS_PASS=... python3 lms.py login
+
+# Health check
+python3 lms.py doctor
+# CLI
+python3 lms.py courses
+python3 lms.py assignments --course <course_id>
+python3 lms.py resources --course <course_id>
+python3 lms.py children <folder_id>
+python3 lms.py download <resource_id> <file_id> --out /tmp/induslms-test
+python3 lms.py notifications --unread-only --limit 5
+python3 lms.py attendance && python3 lms.py attendance-day
+```
+
+Tokens live at `~/.induslms_token.json` (override with `INDUSLMS_TOKEN_FILE`). Never committed — see `.gitignore`.
+
+## Credentials (`.env`) — used by programs, never sent to the LLM
+
+```bash
+cp .env.example .env   # then fill in your own values
+```
+
+| Variable | Used by | Never leaves your machine |
+|---|---|---|
+| `INDUSLMS_EMAIL` / `INDUSLMS_PASS` | `lms.py login` only (one POST, then discarded) | ✅ |
+| `INDUSLMS_TENANT` | Tenant fallback when the token has no roles | ✅ |
+| `INDUSLMS_TOKEN_FILE` | Where the JWT is cached (`~/.induslms_token.json`) | ✅ |
+| `INDUS_OUTLOOK_CLIENT_ID` | Graph device-code login (`outlook.py login`) | ✅ |
+
+How it stays private:
+
+* `lms.py`, `outlook.py`, `server.py` load `.env` via `python-dotenv` at startup — values live only in the local process environment.
+* The MCP server exposes **no** login/token tools, and no tool ever returns passwords, tokens, or client IDs — tools return school data (assignments, mail, attendance) only.
+* `.gitignore` blocks `.env`, `*token*.json`, and downloads, so credentials can't be committed by accident. Share only `.env.example` (empty values).
+
+PyPI (after release): `pipx install induslms-agent` or `uvx induslms-agent doctor`,
+then `induslms login you@indusschool.com` + `induslms-server` as your MCP command.
+
+## MCP server (recommended for agents)
+
+Stdio, read-only tools only (no login, no mark-read, no submissions):
+
+```bash
+python3 server.py
+```
+
+Tools: `get_profile`, `list_courses`, `list_resources`, `get_resource`, `download_resource`, `assignments_overview`, `list_eol`, `list_assessments`, `list_notifications`, `get_attendance`, `get_attendance_day`, `list_announcements`, `list_calendar`, `schoolmail_search`, `schoolmail_read`, `schoolmail_folders`, `outlook_search`, `outlook_read`, `outlook_folders`, `od_resolve_link`, `od_browse`, `od_download`.
+
+Run with `python3 server.py` (or `induslms-server` after `pip install`). Copy-paste
+configs live in `examples/`: `.mcp.json` (Claude Code project scope),
+`claude_desktop_config.json.example`, `opencode.jsonc.example`,
+`mcp-uvx.json.example` (PyPI/uvx form).
+
+## School email (Apple Mail.app — macOS only)
+
+Mail.app already holds the `School` account, so agents read it via osascript (JXA). No credentials, no app registration. On Linux/Windows `schoolmail_*` reports unavailable — use `outlook_*` instead:
+
+```bash
+python3 mailapp.py folders
+python3 mailapp.py search "assignment" --top 5
+python3 mailapp.py search --sender teacher@indusschool.com --since 2026-09-01
+python3 mailapp.py read Inbox:24203
+```
+
+Refs are `Mailbox:id`. Override account/mailbox with `SCHOOL_MAIL_ACCOUNT` / `SCHOOL_MAILBOX`.
+
+### Register in pi
+
+Create `~/.pi/agent/mcp.json` (same shape as `mcp.json` in this repo,
+with `/path/to/induslms-agent` replaced by your checkout path):
+
+```json
+{ "mcpServers": { "induslms-academics": {
+  "command": "/path/to/induslms-agent/.venv/bin/python",
+  "args": ["/path/to/induslms-agent/server.py"],
+  "cwd": "/path/to/induslms-agent"
+} } }
+```
+
+Use the venv python — system python lacks `mcp`/`msal`. Restart pi afterwards.
+
+### Register in opencode
+
+In `~/.config/opencode/opencode.jsonc` under `mcp` (replace
+`/path/to/induslms-agent` with your checkout path):
+
+```json
+"induslms-academics": {
+  "type": "local",
+  "command": ["/path/to/induslms-agent/.venv/bin/python", "/path/to/induslms-agent/server.py"],
+  "cwd": "/path/to/induslms-agent",
+  "enabled": true,
+  "timeout": 15000
+}
+```
+
+Restart opencode afterwards. Verify with a prompt like
+"list my courses using induslms-academics".
+
+### Claude Code
+
+```bash
+claude mcp add induslms-academics -- /path/to/induslms-agent/.venv/bin/python /path/to/induslms-agent/server.py
+# or project scope: copy .mcp.json (replace paths), then: claude mcp list
+```
+
+Skill: `bash scripts/install-skill.sh` also copies to `~/.claude/skills/`
+(`INSTALL_PROJECT_SKILL=1` for `.claude/skills/`).
+
+### Claude Desktop
+
+Copy `examples/claude_desktop_config.json.example` into
+`~/Library/Application Support/Claude/claude_desktop_config.json`
+(macOS; see file for Win/Linux paths), replace paths, relaunch.
+
+### OpenAI-compatible agents (code, no config file)
+
+```python
+from agents.mcp import MCPServerStdio
+async with MCPServerStdio(
+    params={"command": "/path/to/induslms-agent/.venv/bin/python",
+            "args": ["/path/to/induslms-agent/server.py"]},
+    cache_tools_list=True,
+) as server:
+    ...
+```
+
+Hosted MCP / GPT Actions need a public HTTPS endpoint (not provided;
+stdio-only by design).
+
+## Skill (workflow guidance)
+
+`skills/induslms-academics/SKILL.md` teaches the workflow:
+announcements → assignments → resources/download → attendance,
+plus School inbox. Install (copies to pi, opencode, and Claude skills):
+
+```bash
+bash scripts/install-skill.sh
+```
+
+### End-user prompt: refresh local school materials
+
+`examples/update-resources.prompt.md` is a copy-paste template that
+checks LMS + the School mailbox for new teacher materials, downloads
+only what's missing into a `School/` folder, and parses everything to
+text. Fill in your subjects/teachers, paste it into a fresh agent
+session.
+
+## Key API notes (reverse-engineered, verified live)
+
+* Base `https://api.induslms.com`, `Authorization: Bearer <access>` from `POST /api/v1/auth/login/`.
+* Resources: `GET /api/v1/tenants/{tid}/resources/?course_id=` for top level; children via `?parent_resource_id={rid}` (NOT `?parent=`, which returns unfiltered results). Files: `.../resources/{rid}/files/{fid}/content/?disposition=attachment|inline` (binary, streamed).
+* Assignments = EOL tests (`/eol-tests/my/`, 23 items) + student assessments (`/student/assessments/`, 6 items) + resources. `test-marks/me` is PYP-only (DP gets `BAD_REQUEST`) — handled gracefully.
+* DP projects endpoint returns `[]` for this student; section fetcher ready for when IDs exist.
+* Notifications support `?limit=&offset=`; unread filter is client-side (`is_read`) so `--limit 5 --unread-only` may return fewer rows — use a larger limit.
+* Attendance has two shapes: session summary (`/students/me/attendance/`) and day breakdown (`/tenants/{tid}/students/me/attendance/day/`).
+
+## Security
+
+* Read-only by design. The only POSTs in the codebase are `login` and the (CLI-unused) token-refresh helper — the MCP server exposes neither.
+* Credentials via env/prompt only; tokens outside the repo; `.gitignore` blocks `*token*.json`, `.env`, downloads.
+
+## Outlook (school inbox via Microsoft Graph)
+
+Read-only (`Mail.Read` delegated, device-code flow). Token cache at
+`~/.indus_outlook_token.json` — never in repo.
+
+```bash
+# 1. Entra ID -> App registrations -> New: allow public client flows,
+#    add delegated Mail.Read. Multitenant OK.
+export INDUS_OUTLOOK_CLIENT_ID=<app/client id>
+# ..or skip registration: export INDUS_USE_BUILTIN_CLIENT=1 (sign in as yourself)
+python3 outlook.py login        # approve code in browser
+python3 outlook.py search "assignment" --top 5
+python3 outlook.py search --sender teacher@indusschool.com --since 2026-09-01
+python3 outlook.py read <message_id>
+```
+
+MCP tools: `outlook_search`, `outlook_read`, `outlook_folders`
+(same coverage; unconfigured → clear error, not crash).
+School tenant blocks user consent → IT admin must grant admin consent first
+(not needed with `INDUS_USE_BUILTIN_CLIENT=1`).
+
+## OneDrive / SharePoint (school files via Microsoft Graph)
+
+Read-only (`Files.Read` + `Sites.Read.All`, same device-code flow and token
+cache as Outlook — re-run login once to consent to the new scopes):
+
+```bash
+python3 sharepoint.py login
+python3 sharepoint.py resolve <sharing-link-from-mail>  # shared file/folder metadata
+python3 sharepoint.py browse /                          # your OneDrive root
+python3 sharepoint.py download <item-id-or-link> --out /tmp/school
+```
+
+MCP tools: `od_resolve_link`, `od_browse`, `od_download`. No local OneDrive
+sync client needed — pure HTTPS, works on any OS.

induslms_agent-0.3.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+lms.py,sha256=tp06cHe4tRVfBYl4LiQ7jnkRfWWC7pLJLP3Et7paaks,32669
+mailapp.py,sha256=Eiy_cKzIcbgfRyESOg2J2m-bTyUF1vrZffQY9Cq0q8U,7699
+outlook.py,sha256=ZndF2-8Fq_h-gGPd7MUc0vK7TXaJySmdfa-PF5Az3rM,9402
+server.py,sha256=5bIefr-Lz20y4QYsGfxTOdAMq3tVxvctRpWDWe2mXNk,6863
+sharepoint.py,sha256=MGVjjbVIfd8mtyf8HrnbruFDhCYvCdNG5XSUhPFNZFE,7960
+induslms_agent-0.3.0.dist-info/licenses/LICENSE,sha256=N9SVKT0xZ44AytlOQZzpHrnfRw3d7BmPNzy85mI40LU,1084
+induslms_agent-0.3.0.dist-info/METADATA,sha256=on_587aO9ctbWsE20AvXHQzEN-DU1PKl9sA1rMg28DA,10423
+induslms_agent-0.3.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+induslms_agent-0.3.0.dist-info/entry_points.txt,sha256=pOutrRGtDuyVRIcKn608-a3nWcjfyr7A8JWmi4Cht1E,170
+induslms_agent-0.3.0.dist-info/top_level.txt,sha256=UnzuU2XlGh3HKSj6AjlCMTlhERTERRzeysCOzZIrWaQ,38
+induslms_agent-0.3.0.dist-info/RECORD,,

induslms_agent-0.3.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

induslms_agent-0.3.0.dist-info/entry_points.txt

@@ -0,0 +1,6 @@
+[console_scripts]
+induslms = lms:main
+induslms-mailapp = mailapp:main
+induslms-outlook = outlook:main
+induslms-server = server:main
+induslms-sharepoint = sharepoint:main

induslms_agent-0.3.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 IndusLMS Agent contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

induslms_agent-0.3.0.dist-info/top_level.txt

@@ -0,0 +1,5 @@
+lms
+mailapp
+outlook
+server
+sharepoint