worsaga 0.1.0__tar.gz

worsaga-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Support. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or support.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Yamin Mushtaq
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied. See the License for the specific language governing
+   permissions and limitations under the License.

worsaga-0.1.0/MANIFEST.in

@@ -0,0 +1,4 @@
+include LICENSE
+include README.md
+include pyproject.toml
+recursive-include src *.py

worsaga-0.1.0/PKG-INFO

@@ -0,0 +1,298 @@
+Metadata-Version: 2.4
+Name: worsaga
+Version: 0.1.0
+Summary: Study kit for university LMS systems, starting with Moodle
+License-Expression: Apache-2.0
+Keywords: moodle,lms,education,study,mcp
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Education
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: platformdirs>=2.10
+Requires-Dist: pymupdf>=1.23
+Requires-Dist: rich>=13.0
+Provides-Extra: mcp
+Requires-Dist: mcp>=1.0; extra == "mcp"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Dynamic: license-file
+
+# Worsaga
+
+Worsaga is a study kit for university LMS systems.
+
+This repository is the **open-source core** of Worsaga — the CLI and the MCP server — released under the Apache License 2.0 (see [LICENSE](LICENSE)). The wider Worsaga platform, app, and architecture are developed separately and are not part of this repo.
+
+## Platform support
+
+- Supported now: **Moodle**
+- Coming soon: **Blackboard**, **Canvas**
+
+Worsaga is intentionally positioned as a broader LMS study layer, not a Moodle-only product. Moodle just happens to be the first integration.
+
+## What's in this repo
+
+This repo contains only the open-core pieces:
+
+- The `worsaga` command-line interface.
+- The `worsaga.mcp_server` MCP server for agents.
+- The read-only Moodle client and supporting Python modules they share.
+
+The broader Worsaga product — hosted platform, end-user app, and overall system architecture — lives outside this repository and is not open source. Issues, PRs, and discussions here should stay scoped to the CLI and MCP core.
+
+## Quick start
+
+### Install
+
+Pick whichever tool you already have:
+
+```bash
+uv tool install worsaga      # recommended — adds worsaga to PATH automatically
+pipx install worsaga         # alternative
+pip install worsaga          # if you just want the library, or don't have uv/pipx
+```
+
+**Windows note:** If `worsaga` is not recognised after `pip install`, the Python
+Scripts folder may not be on your PATH. Either:
+
+1. Add it manually — find the path with:
+   ```
+   py -c "import site; print(site.getusersitepackages())"
+   ```
+   Then add that directory to your PATH in **Windows Settings > System > Environment Variables**.
+
+2. Or use the module form directly (works immediately, no PATH changes needed):
+   ```
+   py -m worsaga.cli courses
+   ```
+
+### Set up credentials
+
+```bash
+worsaga setup
+```
+
+The setup command will prompt for your Moodle URL, API token, and user ID, then verify
+the connection and save credentials. See [Getting a Moodle API token](#getting-a-moodle-api-token) below if you don't have a token yet.
+
+Non-interactive setup (for scripts and agents):
+
+```bash
+worsaga setup --url https://moodle.example.ac.uk --token YOUR_TOKEN
+```
+
+## Getting a Moodle API token
+
+### Via the Moodle web interface (recommended)
+
+1. Log in to your Moodle site in a browser.
+2. Click your profile picture (top right) → **Preferences**.
+3. Under **User account**, click **Security keys**.
+4. Find the **Moodle mobile web service** row.
+5. Click **Reset** to generate a new token (or copy the existing one if shown).
+6. Copy the token string — this is the long alphanumeric value you need for setup.
+
+> **Tip:** Copy the token value itself (a long string of letters and numbers), not the key name like "Webservice-A3JsY" shown in the table.
+
+### Via the token URL (advanced)
+
+If the method above doesn't work for your institution, you can request a token directly:
+
+```
+https://<your-moodle>/login/token.php?username=YOUR_USER&password=YOUR_PASS&service=moodle_mobile_app
+```
+
+**Note:** Only use this over HTTPS. Never share your token.
+
+## Configuration
+
+Credentials are resolved in this order:
+
+1. **Explicit arguments** passed to `MoodleConfig.load(url=..., token=...)`
+2. **Environment variables**: `WORSAGA_URL`, `WORSAGA_TOKEN`, `WORSAGA_USERID`
+3. **Config file** (first found):
+   - `$WORSAGA_CREDS_PATH` (if set)
+   - Platform-native config directory (see below)
+
+The config directory is determined by `platformdirs` so it follows each OS's conventions: `~/.config/worsaga/` on Linux, `~/Library/Application Support/worsaga/` on macOS, and `%APPDATA%\worsaga\` on Windows. Run `worsaga config` to see the active path on your system, or `worsaga config --json` for machine-readable output.
+
+### Config file format
+
+```json
+{
+  "url": "https://moodle.example.ac.uk",
+  "token": "your_token_here",
+  "userid": 12345
+}
+```
+
+### Environment variables
+
+```bash
+export WORSAGA_URL="https://moodle.example.ac.uk"
+export WORSAGA_TOKEN="your_token_here"
+export WORSAGA_USERID="12345"
+```
+
+## CLI usage
+
+```
+worsaga courses              # List enrolled courses
+worsaga deadlines            # Show upcoming deadlines (14-day window)
+worsaga deadlines --days 7   # Shorter look-ahead
+worsaga contents 12345       # Show sections for course ID 12345
+worsaga contents EC100       # Look up by course short-code
+worsaga contents MG488       # Prefix match: finds MG488_2526 if unique
+worsaga contents EC100 --week 3    # Filter to a specific week
+worsaga materials EC100      # List all downloadable materials (discovery)
+worsaga materials EC100 --week 3   # Materials for week 3 only
+worsaga download EC100 --week 3 --match slides   # Download a file (authenticated)
+worsaga download EC100 --week 3 --index 0        # Download by index
+worsaga summary EC100 --week 3     # AI-generated study notes for a week
+worsaga setup                # Guided first-time setup
+worsaga update               # Show the safe upgrade command
+```
+
+Add `--json` before the command for machine-readable JSON output:
+
+```
+worsaga --json courses
+worsaga --json deadlines
+```
+
+## MCP server
+
+For use with Claude Code, OpenClaw, or other MCP-capable agents:
+
+```bash
+pip install "worsaga[mcp]"
+python -m worsaga.mcp_server
+```
+
+The server runs as a stdio-based MCP server. Tools: `list_courses`, `get_deadlines`, `get_course_contents`, `get_week_materials` (discovery), `search_course_content`, `get_weekly_summary`, `download_material` (authenticated fetch).
+
+**Claude Code**: Add to your Claude Code settings / MCP Servers config:
+```json
+{
+  "mcpServers": {
+    "worsaga": {
+      "command": "python",
+      "args": ["-m", "worsaga.mcp_server"]
+    }
+  }
+}
+```
+Set `WORSAGA_URL`, `WORSAGA_TOKEN`, `WORSAGA_USERID` as environment variables or in `~/.config/worsaga/config.json`.
+
+**OpenClaw**: Add to your agent or gateway config:
+```yaml
+mcpServers:
+  moodle:
+    command: python
+    args: ["-m", "worsaga.mcp_server"]
+    env:
+      WORSAGA_URL: "https://your-moodle.example.ac.uk"
+      WORSAGA_TOKEN: "your_token_here"
+      WORSAGA_USERID: "12345"
+```
+
+## CI
+
+Packaging and install smoke tests run automatically on every push and pull request across Linux, macOS, and Windows. The workflow builds both sdist and wheel, installs each in a clean virtual environment, and verifies the CLI entrypoints work.
+
+## Development
+
+To work on worsaga itself (contributors / developers):
+
+```bash
+git clone <repo-url> && cd worsaga
+python -m venv .venv && source .venv/bin/activate   # Windows: .venv\Scripts\activate
+pip install -e '.[dev]'
+```
+
+### Running tests
+
+```bash
+pytest
+
+# On Windows, if pytest isn't found on PATH:
+py -m pytest
+```
+
+## Safety
+
+This package is **read-only by design**. Every Moodle API call is checked against a hardcoded allowlist in `ALLOWED_FUNCTIONS` inside the client module. Write-like operations — submitting assignments, posting forum replies, uploading files, creating events, deleting content — are blocked with a `SafetyError` before any network request is made.
+
+- Your token cannot modify anything on Moodle/Canvas/Blackboard, even accidentally.
+- Agents (Claude Code, OpenClaw, etc.) can use these tools safely.
+- Treat your API token like a password: never commit it to git, never share it, use HTTPS only.
+
+### Known limitations
+
+- **Token portability varies by institution.** Some Moodle instances require specific web-service configurations. Check with your Moodle administrator about enabling REST web services.
+- **Rate limiting.** Moodle servers may throttle rapid API calls. The package handles errors gracefully but cannot bypass institutional limits.
+- **Only Moodle REST API v2 is supported.**
+- **Course discovery by short-code uses prefix matching** (e.g. "MG488" matches "MG488_2526") — see CLI usage above.
+
+## For Agent Authors
+
+worsaga is designed to be agent-friendly:
+
+- Zero configuration needed for discovery — call `list_courses()` with no arguments to explore.
+- Self-documenting tool names and clear purpose descriptions.
+- Structured output by default — use `--json` on CLI, or rely on structured dict/JSON from the Python API.
+- Graceful degradation with clear error messages when credentials are missing.
+
+### Discovery vs. download
+
+There are two distinct steps — **discovery** and **download** — with separate commands for each:
+
+| Purpose | CLI | MCP tool |
+|---------|-----|----------|
+| **List** available files (metadata only) | `worsaga materials` | `get_week_materials()` |
+| **Download** a file (authenticated) | `worsaga download` | `download_material()` |
+
+`materials` / `get_week_materials` return metadata including a `file_url` field. This URL is the raw Moodle address retained for **provenance only** — do not fetch it directly, as it requires token authentication that is handled internally by `download` / `download_material`.
+
+### Downloading materials
+
+The `download` command (CLI) and `download_material` tool (MCP) provide authenticated file downloads without exposing the Moodle token. The flow:
+
+1. **Discover** materials: `worsaga materials EC100 --week 3`
+2. **Download** one: `worsaga download EC100 --week 3 --match slides`
+
+If multiple materials match, you get a structured candidate list with indices:
+
+```bash
+worsaga --json download EC100 --week 3
+# → {"error": "3 materials match. Use --index ...", "candidates": [...]}
+
+worsaga --json download EC100 --week 3 --index 0
+# → {"local_path": "/path/to/week3_slides.pdf", "file_name": "week3_slides.pdf", ...}
+```
+
+The same workflow is available via MCP:
+
+```
+get_week_materials(course_id=42, week="3")          # discover
+download_material(course_id=42, week="3", match="slides")  # fetch
+```
+
+Example integration in an agent system prompt:
+```
+You have access to worsaga. First run list_courses() to see available courses,
+then get_deadlines() to check upcoming work, then explore specific courses with
+get_course_contents(). To see what files are available, use get_week_materials(). To
+fetch a file, use download_material() — it handles authentication internally. Never
+fetch file_url values directly; always use download_material().
+```
+
+## License
+
+This repo — the worsaga CLI and MCP server — is released under the [Apache License 2.0](LICENSE). The rest of the Worsaga platform (hosted service, end-user app, and overall system architecture) is developed separately and is not covered by this license.