agent2learn 0.1.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (47) hide show
  1. agent2learn-0.1.2/LICENSE +202 -0
  2. agent2learn-0.1.2/PKG-INFO +186 -0
  3. agent2learn-0.1.2/README.md +159 -0
  4. agent2learn-0.1.2/pyproject.toml +91 -0
  5. agent2learn-0.1.2/pyproject.toml.orig +110 -0
  6. agent2learn-0.1.2/skills/a2l-coursework/SKILL.md +52 -0
  7. agent2learn-0.1.2/skills/a2l-setup/SKILL.md +27 -0
  8. agent2learn-0.1.2/skills/a2l-study/SKILL.md +27 -0
  9. agent2learn-0.1.2/skills/a2l-sync/SKILL.md +30 -0
  10. agent2learn-0.1.2/skills.sh.json +16 -0
  11. agent2learn-0.1.2/src/agent2learn/__init__.py +3 -0
  12. agent2learn-0.1.2/src/agent2learn/_release.py +19 -0
  13. agent2learn-0.1.2/src/agent2learn/aipolicy.py +182 -0
  14. agent2learn-0.1.2/src/agent2learn/api.py +590 -0
  15. agent2learn-0.1.2/src/agent2learn/audit.py +358 -0
  16. agent2learn-0.1.2/src/agent2learn/auth/__init__.py +282 -0
  17. agent2learn-0.1.2/src/agent2learn/auth/cdp.py +1067 -0
  18. agent2learn-0.1.2/src/agent2learn/auth/paste.py +378 -0
  19. agent2learn-0.1.2/src/agent2learn/calendar.py +525 -0
  20. agent2learn-0.1.2/src/agent2learn/calibrate.py +347 -0
  21. agent2learn-0.1.2/src/agent2learn/check.py +1091 -0
  22. agent2learn-0.1.2/src/agent2learn/cli.py +2039 -0
  23. agent2learn-0.1.2/src/agent2learn/clock.py +39 -0
  24. agent2learn-0.1.2/src/agent2learn/config.py +205 -0
  25. agent2learn-0.1.2/src/agent2learn/console.py +229 -0
  26. agent2learn-0.1.2/src/agent2learn/convert.py +1223 -0
  27. agent2learn-0.1.2/src/agent2learn/doctor.py +1167 -0
  28. agent2learn-0.1.2/src/agent2learn/errors.py +32 -0
  29. agent2learn-0.1.2/src/agent2learn/ground.py +735 -0
  30. agent2learn-0.1.2/src/agent2learn/index.py +614 -0
  31. agent2learn-0.1.2/src/agent2learn/ingest.py +3229 -0
  32. agent2learn-0.1.2/src/agent2learn/locations.py +247 -0
  33. agent2learn-0.1.2/src/agent2learn/outlines.py +754 -0
  34. agent2learn-0.1.2/src/agent2learn/paths.py +683 -0
  35. agent2learn-0.1.2/src/agent2learn/pipeline.py +392 -0
  36. agent2learn-0.1.2/src/agent2learn/privacy.py +1123 -0
  37. agent2learn-0.1.2/src/agent2learn/schools/__init__.py +29 -0
  38. agent2learn-0.1.2/src/agent2learn/schools/_base.py +194 -0
  39. agent2learn-0.1.2/src/agent2learn/schools/generic.py +78 -0
  40. agent2learn-0.1.2/src/agent2learn/schools/uwaterloo.py +66 -0
  41. agent2learn-0.1.2/src/agent2learn/session.py +373 -0
  42. agent2learn-0.1.2/src/agent2learn/skills.py +1081 -0
  43. agent2learn-0.1.2/src/agent2learn/snapshot.py +399 -0
  44. agent2learn-0.1.2/src/agent2learn/submit.py +1047 -0
  45. agent2learn-0.1.2/src/agent2learn/transactions.py +157 -0
  46. agent2learn-0.1.2/src/agent2learn/upgrade.py +288 -0
  47. agent2learn-0.1.2/src/agent2learn/vault.py +1134 -0
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,186 @@
1
+ Metadata-Version: 2.4
2
+ Name: agent2learn
3
+ Version: 0.1.2
4
+ Summary: A local, source-cited course vault for AI agents
5
+ License-Expression: Apache-2.0
6
+ License-File: LICENSE
7
+ Requires-Dist: typer>=0.15,<1
8
+ Requires-Dist: click>=8.2,<9
9
+ Requires-Dist: rich>=13,<15
10
+ Requires-Dist: requests>=2.32,<3
11
+ Requires-Dist: platformdirs>=4.2,<5
12
+ Requires-Dist: keyring>=25,<27
13
+ Requires-Dist: websocket-client>=1.8,<2
14
+ Requires-Dist: pdf-oxide==0.3.77
15
+ Requires-Dist: pytesseract>=0.3.13,<0.4
16
+ Requires-Dist: pillow>=10,<13
17
+ Requires-Dist: pypdfium2>=5.13,<6
18
+ Requires-Dist: tzdata>=2026.3,<2027
19
+ Requires-Dist: nbformat>=5.10,<6 ; extra == 'notebook'
20
+ Requires-Dist: markitdown[pptx,docx,xlsx]>=0.1,<1 ; extra == 'office'
21
+ Requires-Python: >=3.11
22
+ Project-URL: Repository, https://github.com/ManagementMO/agent2learn
23
+ Project-URL: Issues, https://github.com/ManagementMO/agent2learn/issues
24
+ Provides-Extra: notebook
25
+ Provides-Extra: office
26
+ Description-Content-Type: text/markdown
27
+
28
+ # Agent2Learn
29
+
30
+ > Your own course material, on your own machine, as a vault your coding agent can read and cite.
31
+
32
+ Agent2Learn turns the material available through your own University of Waterloo LEARN account into
33
+ a durable local vault: original files beside Markdown twins, a stable index, and citations that
34
+ resolve to ordinary paths and line numbers. Your agent stops guessing about your course and starts
35
+ quoting it.
36
+
37
+ > **Walkthrough recording:** not yet attached. It is a release artifact, recorded against the
38
+ > synthetic fixture course in `tests/fixtures/` — never against a real account — so no course,
39
+ > student, grade, or session data appears in it. Recording it is a launch gate in
40
+ > [docs/LAUNCH.md](docs/LAUNCH.md); this README will not link a file that does not exist.
41
+
42
+ ## Install
43
+
44
+ Three supported options. Pick one.
45
+
46
+ **macOS and Linux**
47
+
48
+ ```bash
49
+ curl -fsSL https://raw.githubusercontent.com/ManagementMO/agent2learn/main/install.sh | bash
50
+ ```
51
+
52
+ **Windows (PowerShell)**
53
+
54
+ ```powershell
55
+ irm https://raw.githubusercontent.com/ManagementMO/agent2learn/main/install.ps1 | iex
56
+ ```
57
+
58
+ **Already have [uv](https://docs.astral.sh/uv/)?**
59
+
60
+ ```bash
61
+ uv tool install agent2learn
62
+ a2l init
63
+ ```
64
+
65
+ These commands install the published package from PyPI, not an unreleased repository checkout.
66
+ Python 3.11–3.14 is supported. If uv selects an older system Python or your shell cannot find
67
+ `a2l`, see [setup troubleshooting](docs/FAQ.md#setup-and-path).
68
+
69
+ `install.sh` and `install.ps1` install a pinned Agent2Learn (currently 0.1.2), verify that `a2l`
70
+ runs, and then **continue straight into interactive `a2l init`** in the same command. If they are
71
+ run without a terminal on both ends — in CI, or through a pipe — they stop after verifying and
72
+ print the exact next step instead of setting anything up. Neither script needs administrator
73
+ rights, and neither creates a vault, installs agent skills, or opens a browser by itself.
74
+ Onboarding does those things, after showing you a preview and asking.
75
+
76
+ ### Agent skills
77
+
78
+ `a2l init` offers to run `a2l skills install`, which writes the four Agent2Learn skills into the
79
+ agent directories it finds, after previewing exactly what it will touch. You can rerun
80
+ `a2l skills install` at any time.
81
+
82
+ Separately, `npx skills add ManagementMO/agent2learn` is an optional skills-only route through the
83
+ skills ecosystem. It **does not install** the `a2l` engine — only the skill documents — so the
84
+ commands they describe will not exist until you install Agent2Learn itself with one of the three
85
+ options above. That route also runs a third-party CLI with its own network behaviour; see
86
+ [docs/PRIVACY.md](docs/PRIVACY.md).
87
+
88
+ ## Then just ask
89
+
90
+ Once `a2l init` finishes, talk to your agent normally:
91
+
92
+ - "Read my ECON 101 outline and tell me what the late policy actually says."
93
+ - "Assemble the sources for Lab 4, then explain the model using only those files."
94
+ - "Scan my draft against my own course notes and show me what has no matching evidence."
95
+ - "What is due this week, and which lectures cover it?"
96
+
97
+ Your agent has the skills to run the right commands. If you would rather drive it yourself:
98
+
99
+ ```text
100
+ a2l sync [--all|--priority] metadata, outlines, files, twins, index, snapshot, audit
101
+ a2l today deadlines, overdue work, changes, and exam countdowns
102
+ a2l diff [--since SNAPSHOT] changes between local sync snapshots
103
+ a2l calendar [-o FILE] deterministic deadlines/exams/office-hours .ics export
104
+ a2l where QUERY fuzzy topic search across every local term
105
+ a2l open COURSE reveal one known course folder
106
+ a2l ground COURSE ITEM assemble a cited grounding pack for one assignment
107
+ a2l check DRAFT experimental lexical evidence scan of a draft
108
+ a2l courses the offline view of your enrolment
109
+ a2l fetch SOURCE_ID repair one missing file
110
+ a2l auth sign in, or --paste a session, or --clear-profile
111
+ a2l doctor diagnose one problem and get one next step
112
+ a2l skills install install the agent skills
113
+ a2l privacy status collection flags and redacted storage locations
114
+ a2l privacy purge CATEGORY preview an exact grades/discussions/logs purge
115
+ a2l upgrade [--check] the only command that contacts the network on its own
116
+ a2l completions SHELL print a completion script; installs nothing
117
+ a2l enable-submit one-time local acknowledgement for uploads
118
+ a2l submit COURSE ITEM FILE preview an upload, then require your typed confirmation
119
+ ```
120
+
121
+ ## What this does, and what it does not
122
+
123
+ **It does:**
124
+
125
+ - Read **your own account only**, using your own browser session on the same device.
126
+ - Work **read-mostly**: ordinary GET requests against D2L's own student API, which enforces exactly
127
+ the permissions your account already has. It cannot reach anything you could not open yourself.
128
+ - Keep originals beside Markdown twins, with a manifest that preserves earlier revisions when a file
129
+ changes upstream.
130
+ - Tell you what is **missing** and why, rather than implying the archive is complete.
131
+
132
+ **It does not:**
133
+
134
+ - Download licensed eTextbooks or library e-resources. Those are recognised and **never** fetched;
135
+ they are recorded as links for you to open in LEARN yourself.
136
+ - Collect discussions or grades. Both are **off by default** and only ever collected if you turn
137
+ them on.
138
+ - Send Agent2Learn telemetry. There is none, so there is nothing to opt out of, and no passive
139
+ version check. `a2l upgrade` contacts PyPI only when you run it.
140
+ - Upload anything by default. The submission path is **disabled in this build**. Even when enabled,
141
+ every single file requires a fresh confirmation phrase that you type at your own terminal, after
142
+ a full preview.
143
+ - Decide whether your work is right. `a2l check` reports what lexical retrieval matched in your own
144
+ course files, with citations, and says plainly when it found nothing. It does not grade, and no
145
+ status it prints means your work is correct, incorrect, or academically acceptable.
146
+
147
+ Agent2Learn is **not affiliated with, endorsed by, or supported by the University of Waterloo or
148
+ D2L Corporation**. You are responsible for using it within your course rules and your institution's
149
+ policies. See [DISCLAIMER.md](DISCLAIMER.md).
150
+
151
+ ## Privacy defaults
152
+
153
+ | Setting | Default |
154
+ | --- | --- |
155
+ | Course files, outlines, assignment metadata | collected |
156
+ | Discussions | **off** |
157
+ | Grades | **off** |
158
+ | Uploads to LEARN | **disabled in this build**, and always confirmation-gated |
159
+ | Agent2Learn telemetry | none |
160
+ | Passive version or update checks | none |
161
+
162
+ Turning collection off does not delete what is already on disk; `a2l privacy purge` does that, and
163
+ it previews the exact targets and requires a typed phrase first. Full detail, including every
164
+ external request Agent2Learn can make, is in [docs/PRIVACY.md](docs/PRIVACY.md).
165
+
166
+ ## Documentation
167
+
168
+ - [Install guide for agents](docs/install.md) — point your agent here and let it handle setup.
169
+ - [Authentication](docs/AUTHENTICATION.md) — the dedicated profile, Duo, expiry, and recovery.
170
+ - [Privacy](docs/PRIVACY.md) — what is stored, where, every network action, and how to delete it.
171
+ - [FAQ](docs/FAQ.md) — the things that actually go wrong.
172
+ - [Porting to another school](docs/PORTING.md) — the `School` protocol and a worked reference.
173
+ - [What is deferred, and why](docs/FUTURE.md)
174
+ - [Security policy](SECURITY.md) · [Disclaimer](DISCLAIMER.md) · [Licence](LICENSE) ·
175
+ [Third-party notices](THIRD_PARTY_NOTICES.md)
176
+
177
+ ## Status
178
+
179
+ Agent2Learn is in active development. This branch targets **0.1.2**; the pinned installers require
180
+ that version to be available on PyPI before they can install it. A release-preparation branch is
181
+ not evidence of publication. The repository holds the tested implementation of the full v0.1
182
+ command surface; publication is gated on the release checks in [docs/LAUNCH.md](docs/LAUNCH.md),
183
+ including live same-device authentication records on Windows, macOS, and Linux, and a supervised
184
+ upload test before the submission path is enabled in any published build.
185
+
186
+ Licensed under [Apache-2.0](LICENSE).
@@ -0,0 +1,159 @@
1
+ # Agent2Learn
2
+
3
+ > Your own course material, on your own machine, as a vault your coding agent can read and cite.
4
+
5
+ Agent2Learn turns the material available through your own University of Waterloo LEARN account into
6
+ a durable local vault: original files beside Markdown twins, a stable index, and citations that
7
+ resolve to ordinary paths and line numbers. Your agent stops guessing about your course and starts
8
+ quoting it.
9
+
10
+ > **Walkthrough recording:** not yet attached. It is a release artifact, recorded against the
11
+ > synthetic fixture course in `tests/fixtures/` — never against a real account — so no course,
12
+ > student, grade, or session data appears in it. Recording it is a launch gate in
13
+ > [docs/LAUNCH.md](docs/LAUNCH.md); this README will not link a file that does not exist.
14
+
15
+ ## Install
16
+
17
+ Three supported options. Pick one.
18
+
19
+ **macOS and Linux**
20
+
21
+ ```bash
22
+ curl -fsSL https://raw.githubusercontent.com/ManagementMO/agent2learn/main/install.sh | bash
23
+ ```
24
+
25
+ **Windows (PowerShell)**
26
+
27
+ ```powershell
28
+ irm https://raw.githubusercontent.com/ManagementMO/agent2learn/main/install.ps1 | iex
29
+ ```
30
+
31
+ **Already have [uv](https://docs.astral.sh/uv/)?**
32
+
33
+ ```bash
34
+ uv tool install agent2learn
35
+ a2l init
36
+ ```
37
+
38
+ These commands install the published package from PyPI, not an unreleased repository checkout.
39
+ Python 3.11–3.14 is supported. If uv selects an older system Python or your shell cannot find
40
+ `a2l`, see [setup troubleshooting](docs/FAQ.md#setup-and-path).
41
+
42
+ `install.sh` and `install.ps1` install a pinned Agent2Learn (currently 0.1.2), verify that `a2l`
43
+ runs, and then **continue straight into interactive `a2l init`** in the same command. If they are
44
+ run without a terminal on both ends — in CI, or through a pipe — they stop after verifying and
45
+ print the exact next step instead of setting anything up. Neither script needs administrator
46
+ rights, and neither creates a vault, installs agent skills, or opens a browser by itself.
47
+ Onboarding does those things, after showing you a preview and asking.
48
+
49
+ ### Agent skills
50
+
51
+ `a2l init` offers to run `a2l skills install`, which writes the four Agent2Learn skills into the
52
+ agent directories it finds, after previewing exactly what it will touch. You can rerun
53
+ `a2l skills install` at any time.
54
+
55
+ Separately, `npx skills add ManagementMO/agent2learn` is an optional skills-only route through the
56
+ skills ecosystem. It **does not install** the `a2l` engine — only the skill documents — so the
57
+ commands they describe will not exist until you install Agent2Learn itself with one of the three
58
+ options above. That route also runs a third-party CLI with its own network behaviour; see
59
+ [docs/PRIVACY.md](docs/PRIVACY.md).
60
+
61
+ ## Then just ask
62
+
63
+ Once `a2l init` finishes, talk to your agent normally:
64
+
65
+ - "Read my ECON 101 outline and tell me what the late policy actually says."
66
+ - "Assemble the sources for Lab 4, then explain the model using only those files."
67
+ - "Scan my draft against my own course notes and show me what has no matching evidence."
68
+ - "What is due this week, and which lectures cover it?"
69
+
70
+ Your agent has the skills to run the right commands. If you would rather drive it yourself:
71
+
72
+ ```text
73
+ a2l sync [--all|--priority] metadata, outlines, files, twins, index, snapshot, audit
74
+ a2l today deadlines, overdue work, changes, and exam countdowns
75
+ a2l diff [--since SNAPSHOT] changes between local sync snapshots
76
+ a2l calendar [-o FILE] deterministic deadlines/exams/office-hours .ics export
77
+ a2l where QUERY fuzzy topic search across every local term
78
+ a2l open COURSE reveal one known course folder
79
+ a2l ground COURSE ITEM assemble a cited grounding pack for one assignment
80
+ a2l check DRAFT experimental lexical evidence scan of a draft
81
+ a2l courses the offline view of your enrolment
82
+ a2l fetch SOURCE_ID repair one missing file
83
+ a2l auth sign in, or --paste a session, or --clear-profile
84
+ a2l doctor diagnose one problem and get one next step
85
+ a2l skills install install the agent skills
86
+ a2l privacy status collection flags and redacted storage locations
87
+ a2l privacy purge CATEGORY preview an exact grades/discussions/logs purge
88
+ a2l upgrade [--check] the only command that contacts the network on its own
89
+ a2l completions SHELL print a completion script; installs nothing
90
+ a2l enable-submit one-time local acknowledgement for uploads
91
+ a2l submit COURSE ITEM FILE preview an upload, then require your typed confirmation
92
+ ```
93
+
94
+ ## What this does, and what it does not
95
+
96
+ **It does:**
97
+
98
+ - Read **your own account only**, using your own browser session on the same device.
99
+ - Work **read-mostly**: ordinary GET requests against D2L's own student API, which enforces exactly
100
+ the permissions your account already has. It cannot reach anything you could not open yourself.
101
+ - Keep originals beside Markdown twins, with a manifest that preserves earlier revisions when a file
102
+ changes upstream.
103
+ - Tell you what is **missing** and why, rather than implying the archive is complete.
104
+
105
+ **It does not:**
106
+
107
+ - Download licensed eTextbooks or library e-resources. Those are recognised and **never** fetched;
108
+ they are recorded as links for you to open in LEARN yourself.
109
+ - Collect discussions or grades. Both are **off by default** and only ever collected if you turn
110
+ them on.
111
+ - Send Agent2Learn telemetry. There is none, so there is nothing to opt out of, and no passive
112
+ version check. `a2l upgrade` contacts PyPI only when you run it.
113
+ - Upload anything by default. The submission path is **disabled in this build**. Even when enabled,
114
+ every single file requires a fresh confirmation phrase that you type at your own terminal, after
115
+ a full preview.
116
+ - Decide whether your work is right. `a2l check` reports what lexical retrieval matched in your own
117
+ course files, with citations, and says plainly when it found nothing. It does not grade, and no
118
+ status it prints means your work is correct, incorrect, or academically acceptable.
119
+
120
+ Agent2Learn is **not affiliated with, endorsed by, or supported by the University of Waterloo or
121
+ D2L Corporation**. You are responsible for using it within your course rules and your institution's
122
+ policies. See [DISCLAIMER.md](DISCLAIMER.md).
123
+
124
+ ## Privacy defaults
125
+
126
+ | Setting | Default |
127
+ | --- | --- |
128
+ | Course files, outlines, assignment metadata | collected |
129
+ | Discussions | **off** |
130
+ | Grades | **off** |
131
+ | Uploads to LEARN | **disabled in this build**, and always confirmation-gated |
132
+ | Agent2Learn telemetry | none |
133
+ | Passive version or update checks | none |
134
+
135
+ Turning collection off does not delete what is already on disk; `a2l privacy purge` does that, and
136
+ it previews the exact targets and requires a typed phrase first. Full detail, including every
137
+ external request Agent2Learn can make, is in [docs/PRIVACY.md](docs/PRIVACY.md).
138
+
139
+ ## Documentation
140
+
141
+ - [Install guide for agents](docs/install.md) — point your agent here and let it handle setup.
142
+ - [Authentication](docs/AUTHENTICATION.md) — the dedicated profile, Duo, expiry, and recovery.
143
+ - [Privacy](docs/PRIVACY.md) — what is stored, where, every network action, and how to delete it.
144
+ - [FAQ](docs/FAQ.md) — the things that actually go wrong.
145
+ - [Porting to another school](docs/PORTING.md) — the `School` protocol and a worked reference.
146
+ - [What is deferred, and why](docs/FUTURE.md)
147
+ - [Security policy](SECURITY.md) · [Disclaimer](DISCLAIMER.md) · [Licence](LICENSE) ·
148
+ [Third-party notices](THIRD_PARTY_NOTICES.md)
149
+
150
+ ## Status
151
+
152
+ Agent2Learn is in active development. This branch targets **0.1.2**; the pinned installers require
153
+ that version to be available on PyPI before they can install it. A release-preparation branch is
154
+ not evidence of publication. The repository holds the tested implementation of the full v0.1
155
+ command surface; publication is gated on the release checks in [docs/LAUNCH.md](docs/LAUNCH.md),
156
+ including live same-device authentication records on Windows, macOS, and Linux, and a supervised
157
+ upload test before the submission path is enabled in any published build.
158
+
159
+ Licensed under [Apache-2.0](LICENSE).
@@ -0,0 +1,91 @@
1
+ [project]
2
+ name = "agent2learn"
3
+ version = "0.1.2"
4
+ description = "A local, source-cited course vault for AI agents"
5
+ readme = "README.md"
6
+ requires-python = ">=3.11"
7
+ license = "Apache-2.0"
8
+ license-files = ["LICENSE"]
9
+ dependencies = [
10
+ "typer>=0.15,<1",
11
+ "click>=8.2,<9",
12
+ "rich>=13,<15",
13
+ "requests>=2.32,<3",
14
+ "platformdirs>=4.2,<5",
15
+ "keyring>=25,<27",
16
+ "websocket-client>=1.8,<2",
17
+ "pdf-oxide==0.3.77",
18
+ "pytesseract>=0.3.13,<0.4",
19
+ "pillow>=10,<13",
20
+ "pypdfium2>=5.13,<6",
21
+ "tzdata>=2026.3,<2027",
22
+ ]
23
+
24
+ [project.optional-dependencies]
25
+ office = ["markitdown[pptx,docx,xlsx]>=0.1,<1"]
26
+ notebook = ["nbformat>=5.10,<6"]
27
+
28
+ [project.scripts]
29
+ a2l = "agent2learn.cli:app"
30
+
31
+ [project.urls]
32
+ Repository = "https://github.com/ManagementMO/agent2learn"
33
+ Issues = "https://github.com/ManagementMO/agent2learn/issues"
34
+
35
+ [dependency-groups]
36
+ dev = [
37
+ "pytest>=9.0.3,<10",
38
+ "pytest-cov>=6,<8",
39
+ "pytest-httpserver>=1.1,<2",
40
+ "ruff>=0.8,<1",
41
+ "mypy>=1.13,<2",
42
+ "pip-audit>=2.7,<3",
43
+ "cyclonedx-bom>=5,<8",
44
+ "detect-secrets>=1.5,<2",
45
+ "pre-commit>=4,<5",
46
+ ]
47
+
48
+ [build-system]
49
+ requires = ["uv_build>=0.11.32,<0.12.0"]
50
+ build-backend = "uv_build"
51
+
52
+ [tool.ruff]
53
+ line-length = 100
54
+ target-version = "py311"
55
+ extend-exclude = ["tests/fixtures"]
56
+
57
+ [tool.ruff.lint]
58
+ select = [
59
+ "E",
60
+ "F",
61
+ "I",
62
+ "UP",
63
+ "B",
64
+ "SIM",
65
+ ]
66
+
67
+ [tool.mypy]
68
+ python_version = "3.11"
69
+ strict = true
70
+ warn_unreachable = true
71
+ mypy_path = ["src"]
72
+ implicit_reexport = true
73
+
74
+ [tool.uv.build-backend]
75
+ source-include = ["skills.sh.json"]
76
+
77
+ [tool.uv.build-backend.data]
78
+ data = "skills"
79
+
80
+ [tool.pytest.ini_options]
81
+ testpaths = ["tests"]
82
+ addopts = "-q"
83
+ markers = ["benchmark: measured performance budget, enforced only with A2L_BENCHMARK_STRICT"]
84
+
85
+ [tool.coverage.run]
86
+ branch = true
87
+ source = ["agent2learn"]
88
+
89
+ [tool.coverage.report]
90
+ show_missing = true
91
+ fail_under = 77.5