learningfoundry 0.2.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.
- learningfoundry-0.2.0/.github/workflows/publish.yml +49 -0
- learningfoundry-0.2.0/.gitignore +42 -0
- learningfoundry-0.2.0/.project-guide.yml +5 -0
- learningfoundry-0.2.0/.pyve/config +6 -0
- learningfoundry-0.2.0/.tool-versions +1 -0
- learningfoundry-0.2.0/CHANGELOG.md +23 -0
- learningfoundry-0.2.0/LICENSE +201 -0
- learningfoundry-0.2.0/PKG-INFO +13 -0
- learningfoundry-0.2.0/README.md +19 -0
- learningfoundry-0.2.0/docs/project-guide/.metadata.yml +195 -0
- learningfoundry-0.2.0/docs/project-guide/README.md +51 -0
- learningfoundry-0.2.0/docs/project-guide/developer/best-practices-guide.md +342 -0
- learningfoundry-0.2.0/docs/project-guide/developer/brand-descriptions-guide.md +461 -0
- learningfoundry-0.2.0/docs/project-guide/developer/codecov-setup-guide.md +181 -0
- learningfoundry-0.2.0/docs/project-guide/developer/debug-guide.md +469 -0
- learningfoundry-0.2.0/docs/project-guide/developer/landing-page-guide.md +808 -0
- learningfoundry-0.2.0/docs/project-guide/developer/production-github-guide.md +437 -0
- learningfoundry-0.2.0/docs/project-guide/developer/project-guide.md +452 -0
- learningfoundry-0.2.0/docs/project-guide/go.md +233 -0
- learningfoundry-0.2.0/docs/project-guide/templates/artifacts/brand-descriptions.md +54 -0
- learningfoundry-0.2.0/docs/project-guide/templates/artifacts/concept.md +37 -0
- learningfoundry-0.2.0/docs/project-guide/templates/artifacts/features.md +77 -0
- learningfoundry-0.2.0/docs/project-guide/templates/artifacts/project-essentials.md +43 -0
- learningfoundry-0.2.0/docs/project-guide/templates/artifacts/stories.md +21 -0
- learningfoundry-0.2.0/docs/project-guide/templates/artifacts/tech-spec.md +77 -0
- learningfoundry-0.2.0/docs/project-guide/templates/llm_entry_point.md +5 -0
- learningfoundry-0.2.0/docs/project-guide/templates/modes/_header-common.md +46 -0
- learningfoundry-0.2.0/docs/project-guide/templates/modes/_header-cycle.md +4 -0
- learningfoundry-0.2.0/docs/project-guide/templates/modes/_header-sequence.md +7 -0
- learningfoundry-0.2.0/docs/project-guide/templates/modes/_phase-letters.md +27 -0
- learningfoundry-0.2.0/docs/project-guide/templates/modes/archive-stories-mode.md +80 -0
- learningfoundry-0.2.0/docs/project-guide/templates/modes/code-test-first-mode.md +58 -0
- learningfoundry-0.2.0/docs/project-guide/templates/modes/code-velocity-mode.md +58 -0
- learningfoundry-0.2.0/docs/project-guide/templates/modes/debug-mode.md +462 -0
- learningfoundry-0.2.0/docs/project-guide/templates/modes/default-mode.md +100 -0
- learningfoundry-0.2.0/docs/project-guide/templates/modes/document-brand-mode.md +484 -0
- learningfoundry-0.2.0/docs/project-guide/templates/modes/document-landing-mode.md +808 -0
- learningfoundry-0.2.0/docs/project-guide/templates/modes/plan-concept-mode.md +50 -0
- learningfoundry-0.2.0/docs/project-guide/templates/modes/plan-features-mode.md +57 -0
- learningfoundry-0.2.0/docs/project-guide/templates/modes/plan-phase-mode.md +75 -0
- learningfoundry-0.2.0/docs/project-guide/templates/modes/plan-stories-mode.md +73 -0
- learningfoundry-0.2.0/docs/project-guide/templates/modes/plan-tech-spec-mode.md +74 -0
- learningfoundry-0.2.0/docs/project-guide/templates/modes/production-mode.md +16 -0
- learningfoundry-0.2.0/docs/project-guide/templates/modes/project-scaffold-mode.md +139 -0
- learningfoundry-0.2.0/docs/project-guide/templates/modes/refactor-document-mode.md +104 -0
- learningfoundry-0.2.0/docs/project-guide/templates/modes/refactor-plan-mode.md +123 -0
- learningfoundry-0.2.0/docs/specs/concept.md +140 -0
- learningfoundry-0.2.0/docs/specs/d3foundry/dependency-spec.md +334 -0
- learningfoundry-0.2.0/docs/specs/d802-curriculum-idea-statement.md +250 -0
- learningfoundry-0.2.0/docs/specs/features.md +344 -0
- learningfoundry-0.2.0/docs/specs/idea.md +33 -0
- learningfoundry-0.2.0/docs/specs/lmentry/features.md +282 -0
- learningfoundry-0.2.0/docs/specs/nbfoundry/dependency-spec.md +356 -0
- learningfoundry-0.2.0/docs/specs/project-essentials.md +75 -0
- learningfoundry-0.2.0/docs/specs/quizazz/concept.md +118 -0
- learningfoundry-0.2.0/docs/specs/quizazz/dependency-spec.md +191 -0
- learningfoundry-0.2.0/docs/specs/quizazz/features.md +382 -0
- learningfoundry-0.2.0/docs/specs/quizazz/tech_spec.md +641 -0
- learningfoundry-0.2.0/docs/specs/stories.md +394 -0
- learningfoundry-0.2.0/docs/specs/tech-spec.md +1099 -0
- learningfoundry-0.2.0/pyproject.toml +43 -0
- learningfoundry-0.2.0/src/learningfoundry/__init__.py +4 -0
- learningfoundry-0.2.0/src/learningfoundry/__main__.py +7 -0
- learningfoundry-0.2.0/src/learningfoundry/cli.py +12 -0
- learningfoundry-0.2.0/src/learningfoundry/py.typed +0 -0
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
name: Publish to PyPI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
tags:
|
|
6
|
+
- "v*"
|
|
7
|
+
|
|
8
|
+
jobs:
|
|
9
|
+
build:
|
|
10
|
+
name: Build distribution
|
|
11
|
+
runs-on: ubuntu-latest
|
|
12
|
+
steps:
|
|
13
|
+
- uses: actions/checkout@v4
|
|
14
|
+
|
|
15
|
+
- name: Set up Python
|
|
16
|
+
uses: actions/setup-python@v5
|
|
17
|
+
with:
|
|
18
|
+
python-version: "3.12"
|
|
19
|
+
|
|
20
|
+
- name: Install build
|
|
21
|
+
run: pip install build
|
|
22
|
+
|
|
23
|
+
- name: Build sdist and wheel
|
|
24
|
+
run: python -m build
|
|
25
|
+
|
|
26
|
+
- name: Upload distribution artifacts
|
|
27
|
+
uses: actions/upload-artifact@v4
|
|
28
|
+
with:
|
|
29
|
+
name: dist
|
|
30
|
+
path: dist/
|
|
31
|
+
|
|
32
|
+
publish:
|
|
33
|
+
name: Publish to PyPI
|
|
34
|
+
needs: build
|
|
35
|
+
runs-on: ubuntu-latest
|
|
36
|
+
environment:
|
|
37
|
+
name: pypi
|
|
38
|
+
url: https://pypi.org/p/learningfoundry
|
|
39
|
+
permissions:
|
|
40
|
+
id-token: write # required for OIDC trusted publishing
|
|
41
|
+
steps:
|
|
42
|
+
- name: Download distribution artifacts
|
|
43
|
+
uses: actions/download-artifact@v4
|
|
44
|
+
with:
|
|
45
|
+
name: dist
|
|
46
|
+
path: dist/
|
|
47
|
+
|
|
48
|
+
- name: Publish to PyPI
|
|
49
|
+
uses: pypa/gh-action-pypi-publish@release/v1
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# macOS only
|
|
2
|
+
.DS_Store
|
|
3
|
+
|
|
4
|
+
# Python build and test artifacts
|
|
5
|
+
__pycache__
|
|
6
|
+
*.pyc
|
|
7
|
+
*.pyo
|
|
8
|
+
*.pyd
|
|
9
|
+
*.egg-info
|
|
10
|
+
*.egg
|
|
11
|
+
.coverage
|
|
12
|
+
coverage.xml
|
|
13
|
+
htmlcov/
|
|
14
|
+
.pytest_cache/
|
|
15
|
+
dist/
|
|
16
|
+
build/
|
|
17
|
+
|
|
18
|
+
# Jupyter notebooks
|
|
19
|
+
.ipynb_checkpoints/
|
|
20
|
+
*.ipynb_checkpoints
|
|
21
|
+
|
|
22
|
+
# Pyve virtual environment
|
|
23
|
+
.pyve/testenv
|
|
24
|
+
.envrc
|
|
25
|
+
.env
|
|
26
|
+
.venv
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
# Node / SvelteKit
|
|
32
|
+
node_modules/
|
|
33
|
+
.svelte-kit/
|
|
34
|
+
.output/
|
|
35
|
+
.vercel/
|
|
36
|
+
.netlify/
|
|
37
|
+
|
|
38
|
+
# TypeScript
|
|
39
|
+
*.tsbuildinfo
|
|
40
|
+
|
|
41
|
+
# project-guide
|
|
42
|
+
docs/project-guide/**/*.bak.*
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
python 3.12.13
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to this project will be documented in this file.
|
|
4
|
+
|
|
5
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
|
6
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
|
+
|
|
8
|
+
## [Unreleased]
|
|
9
|
+
|
|
10
|
+
## [0.2.0] - 2026-04-15
|
|
11
|
+
|
|
12
|
+
### Added
|
|
13
|
+
|
|
14
|
+
- `.github/workflows/publish.yml` — publishes sdist + wheel to PyPI on `v*` tag push via OIDC trusted publishing
|
|
15
|
+
|
|
16
|
+
## [0.1.0] - 2026-04-15
|
|
17
|
+
|
|
18
|
+
### Added
|
|
19
|
+
|
|
20
|
+
- `src/learningfoundry/__init__.py` with `__version__ = "0.1.0"`
|
|
21
|
+
- `src/learningfoundry/py.typed` PEP 561 marker
|
|
22
|
+
- `src/learningfoundry/cli.py` Click entry point with `--version` flag
|
|
23
|
+
- `src/learningfoundry/__main__.py` enabling `python -m learningfoundry`
|
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: learningfoundry
|
|
3
|
+
Version: 0.2.0
|
|
4
|
+
Summary: A curriculum engine that turns a YAML curriculum definition into a deployable SvelteKit learning application.
|
|
5
|
+
Author: Pointmatic
|
|
6
|
+
License-Expression: Apache-2.0
|
|
7
|
+
License-File: LICENSE
|
|
8
|
+
Requires-Python: >=3.12
|
|
9
|
+
Requires-Dist: click>=8.1
|
|
10
|
+
Requires-Dist: pydantic>=2.0
|
|
11
|
+
Requires-Dist: pyyaml>=6.0
|
|
12
|
+
Provides-Extra: quizazz
|
|
13
|
+
Requires-Dist: quizazz-builder>=0.1; extra == 'quizazz'
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# learningfoundry
|
|
2
|
+
|
|
3
|
+
[](LICENSE)
|
|
4
|
+
|
|
5
|
+
A curriculum engine that turns a YAML curriculum definition into a deployable SvelteKit learning application — with LLM-generated content, interactive assessments, executable notebooks, and data visualizations — in a single pipeline.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
pip install learningfoundry
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Usage
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
learningfoundry build
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
<!-- Full usage documentation coming soon. -->
|
|
@@ -0,0 +1,195 @@
|
|
|
1
|
+
common:
|
|
2
|
+
mode_templates_path: "project_guide/templates/project-guide/templates/modes"
|
|
3
|
+
artifact_templates_path: "project_guide/templates/project-guide/templates/artifacts"
|
|
4
|
+
spec_artifacts_path: "docs/specs"
|
|
5
|
+
root_artifacts_path: "."
|
|
6
|
+
web_root: "docs/site"
|
|
7
|
+
programming_language: python
|
|
8
|
+
test_command: pytest
|
|
9
|
+
test_invocation: "pyve run {{test_command}}"
|
|
10
|
+
default_code_mode: code_velocity
|
|
11
|
+
|
|
12
|
+
modes:
|
|
13
|
+
|
|
14
|
+
# Default
|
|
15
|
+
- name: default
|
|
16
|
+
info: Getting started -- full project lifecycle overview
|
|
17
|
+
description: Default mode for new projects. Walks through setup, planning, and implementation with links to specific modes.
|
|
18
|
+
sequence_or_cycle: sequence
|
|
19
|
+
generation_type: document
|
|
20
|
+
mode_template: "{{mode_templates_path}}/default-mode.md"
|
|
21
|
+
next_mode: plan_concept
|
|
22
|
+
|
|
23
|
+
# Planning
|
|
24
|
+
- name: plan_concept
|
|
25
|
+
info: Generate a high-level concept (problem and solution space)
|
|
26
|
+
description: Define the problem space (problem statement, pain points, target users, value criteria) and the solution space (solution statement, goals, scope, constraints), and pain point to solution mapping.
|
|
27
|
+
sequence_or_cycle: sequence
|
|
28
|
+
generation_type: document
|
|
29
|
+
mode_template: "{{mode_templates_path}}/plan-concept-mode.md"
|
|
30
|
+
next_mode: plan_features
|
|
31
|
+
artifacts:
|
|
32
|
+
- file: "{{spec_artifacts_path}}/concept.md"
|
|
33
|
+
action: create
|
|
34
|
+
- name: plan_features
|
|
35
|
+
info: Generate feature requirements (what the project does)
|
|
36
|
+
description: This is what the project does (functional and presentation requirements, not technical implementation).
|
|
37
|
+
sequence_or_cycle: sequence
|
|
38
|
+
generation_type: document
|
|
39
|
+
mode_template: "{{mode_templates_path}}/plan-features-mode.md"
|
|
40
|
+
next_mode: plan_tech_spec
|
|
41
|
+
artifacts:
|
|
42
|
+
- file: "{{spec_artifacts_path}}/features.md"
|
|
43
|
+
action: create
|
|
44
|
+
files_exist:
|
|
45
|
+
- "{{spec_artifacts_path}}/concept.md"
|
|
46
|
+
- name: plan_tech_spec
|
|
47
|
+
info: Generate a technical specification prompt (how it's built)
|
|
48
|
+
description: This details the requirements for how the project is built (architecture, modules, dependencies, but not code).
|
|
49
|
+
sequence_or_cycle: sequence
|
|
50
|
+
generation_type: document
|
|
51
|
+
mode_template: "{{mode_templates_path}}/plan-tech-spec-mode.md"
|
|
52
|
+
next_mode: plan_stories
|
|
53
|
+
artifacts:
|
|
54
|
+
- file: "{{spec_artifacts_path}}/tech-spec.md"
|
|
55
|
+
action: create
|
|
56
|
+
- file: "{{spec_artifacts_path}}/project-essentials.md"
|
|
57
|
+
action: create
|
|
58
|
+
files_exist:
|
|
59
|
+
- "{{spec_artifacts_path}}/concept.md"
|
|
60
|
+
- "{{spec_artifacts_path}}/features.md"
|
|
61
|
+
- name: plan_stories
|
|
62
|
+
info: Generate a user stories prompt
|
|
63
|
+
description: Based on the concept, features, and technical specification documents, scaffold the project, determine the implementation phases, and breakdown all that into stories.
|
|
64
|
+
sequence_or_cycle: sequence
|
|
65
|
+
generation_type: document
|
|
66
|
+
mode_template: "{{mode_templates_path}}/plan-stories-mode.md"
|
|
67
|
+
next_mode: project_scaffold
|
|
68
|
+
artifacts:
|
|
69
|
+
- file: "{{spec_artifacts_path}}/stories.md"
|
|
70
|
+
action: create
|
|
71
|
+
files_exist:
|
|
72
|
+
- "{{spec_artifacts_path}}/concept.md"
|
|
73
|
+
- "{{spec_artifacts_path}}/features.md"
|
|
74
|
+
- "{{spec_artifacts_path}}/tech-spec.md"
|
|
75
|
+
|
|
76
|
+
# Post-Release
|
|
77
|
+
- name: archive_stories
|
|
78
|
+
info: Archive docs/specs/stories.md and re-render a fresh one for the next phase
|
|
79
|
+
description: Move the current stories.md to .archive/ under a version-stamped name derived from the latest story, and re-render an empty stories.md from the artifact template preserving the `## Future` section.
|
|
80
|
+
sequence_or_cycle: sequence
|
|
81
|
+
generation_type: document
|
|
82
|
+
mode_template: "{{mode_templates_path}}/archive-stories-mode.md"
|
|
83
|
+
next_mode: plan_phase
|
|
84
|
+
artifacts:
|
|
85
|
+
- file: "{{spec_artifacts_path}}/stories.md"
|
|
86
|
+
action: archive
|
|
87
|
+
files_exist:
|
|
88
|
+
- "{{spec_artifacts_path}}/stories.md"
|
|
89
|
+
- name: plan_phase
|
|
90
|
+
info: Generate a feature phase prompt, which includes a mini-concept, features, and technical details
|
|
91
|
+
description: Based on a specific request from the developer, develop a combined concept, features, and technical specification document that describes the gap to fill, then create a new phase in the stories document, and breakdown all that into stories.
|
|
92
|
+
sequence_or_cycle: sequence
|
|
93
|
+
generation_type: document
|
|
94
|
+
mode_template: "{{mode_templates_path}}/plan-phase-mode.md"
|
|
95
|
+
next_mode: "{{default_code_mode}}"
|
|
96
|
+
artifacts:
|
|
97
|
+
- file: "{{spec_artifacts_path}}/new-phase-{{phase_name}}.md"
|
|
98
|
+
- file: "{{spec_artifacts_path}}/stories.md"
|
|
99
|
+
action: modify
|
|
100
|
+
- file: "{{spec_artifacts_path}}/project-essentials.md"
|
|
101
|
+
action: modify
|
|
102
|
+
files_exist:
|
|
103
|
+
- "{{spec_artifacts_path}}/concept.md"
|
|
104
|
+
- "{{spec_artifacts_path}}/features.md"
|
|
105
|
+
- "{{spec_artifacts_path}}/tech-spec.md"
|
|
106
|
+
- "{{spec_artifacts_path}}/stories.md"
|
|
107
|
+
|
|
108
|
+
# Scaffold
|
|
109
|
+
- name: project_scaffold
|
|
110
|
+
info: Scaffold the project foundation (LICENSE, headers, manifest, README, CHANGELOG)
|
|
111
|
+
description: One-time project scaffolding after planning. Creates license, copyright headers, package manifest, README with badges, CHANGELOG, and .gitignore based on decisions made during planning.
|
|
112
|
+
sequence_or_cycle: sequence
|
|
113
|
+
generation_type: document
|
|
114
|
+
mode_template: "{{mode_templates_path}}/project-scaffold-mode.md"
|
|
115
|
+
next_mode: "{{default_code_mode}}"
|
|
116
|
+
files_exist:
|
|
117
|
+
- "{{spec_artifacts_path}}/concept.md"
|
|
118
|
+
- "{{spec_artifacts_path}}/features.md"
|
|
119
|
+
- "{{spec_artifacts_path}}/tech-spec.md"
|
|
120
|
+
- "{{spec_artifacts_path}}/stories.md"
|
|
121
|
+
|
|
122
|
+
# Pre-Release
|
|
123
|
+
- name: document_brand
|
|
124
|
+
info: Develop and document branding for the project
|
|
125
|
+
description: Define the canonical source of truth for all descriptive language about the project brand for the project. All consumer files (README.md, docs/index.html, pyproject.toml, features.md) should draw from these definitions.
|
|
126
|
+
sequence_or_cycle: sequence
|
|
127
|
+
generation_type: document
|
|
128
|
+
mode_template: "{{mode_templates_path}}/document-brand-mode.md"
|
|
129
|
+
artifacts:
|
|
130
|
+
- file: "{{spec_artifacts_path}}/brand-descriptions.md"
|
|
131
|
+
action: create
|
|
132
|
+
files_exist:
|
|
133
|
+
- "{{spec_artifacts_path}}/concept.md"
|
|
134
|
+
- "{{spec_artifacts_path}}/features.md"
|
|
135
|
+
- name: document_landing
|
|
136
|
+
info: Generate a GitHub landing page and markdown support documentation using MkDocs
|
|
137
|
+
description: TBD.
|
|
138
|
+
sequence_or_cycle: sequence
|
|
139
|
+
generation_type: document
|
|
140
|
+
mode_template: "{{mode_templates_path}}/document-landing-mode.md"
|
|
141
|
+
artifacts:
|
|
142
|
+
- webpage: "{{web_root}}/index.md"
|
|
143
|
+
action: create
|
|
144
|
+
- framework: mkdocs
|
|
145
|
+
action: create
|
|
146
|
+
files_exist:
|
|
147
|
+
- "{{spec_artifacts_path}}/concept.md"
|
|
148
|
+
- "{{spec_artifacts_path}}/features.md"
|
|
149
|
+
- "{{spec_artifacts_path}}/tech-spec.md"
|
|
150
|
+
- "{{spec_artifacts_path}}/stories.md"
|
|
151
|
+
- "{{spec_artifacts_path}}/brand-descriptions.md"
|
|
152
|
+
|
|
153
|
+
# Code modes
|
|
154
|
+
- name: code_velocity
|
|
155
|
+
info: Generate code with velocity
|
|
156
|
+
description: TBD.
|
|
157
|
+
sequence_or_cycle: cycle
|
|
158
|
+
generation_type: code
|
|
159
|
+
mode_template: "{{mode_templates_path}}/code-velocity-mode.md"
|
|
160
|
+
files_exist:
|
|
161
|
+
- "{{spec_artifacts_path}}/stories.md"
|
|
162
|
+
- "{{root_artifacts_path}}/CHANGELOG.md"
|
|
163
|
+
- name: code_test_first
|
|
164
|
+
info: Generate code with a test-first approach
|
|
165
|
+
description: TBD.
|
|
166
|
+
sequence_or_cycle: cycle
|
|
167
|
+
generation_type: code
|
|
168
|
+
mode_template: "{{mode_templates_path}}/code-test-first-mode.md"
|
|
169
|
+
files_exist:
|
|
170
|
+
- "{{spec_artifacts_path}}/stories.md"
|
|
171
|
+
- name: debug
|
|
172
|
+
info: Debug code with a test-first approach
|
|
173
|
+
description: TBD.
|
|
174
|
+
sequence_or_cycle: cycle
|
|
175
|
+
generation_type: code
|
|
176
|
+
mode_template: "{{mode_templates_path}}/debug-mode.md"
|
|
177
|
+
files_exist:
|
|
178
|
+
- "{{spec_artifacts_path}}/stories.md"
|
|
179
|
+
|
|
180
|
+
# Refactoring modes
|
|
181
|
+
- name: refactor_plan
|
|
182
|
+
info: Update planning artifacts (concept, features, tech-spec)
|
|
183
|
+
description: Rewrite or update existing planning documents because of new features or improvements, including concept, features, and tech-spec. You can also migrate legacy project-guide planning documents--it will preserve information while restructuring into standardized sections.
|
|
184
|
+
sequence_or_cycle: cycle
|
|
185
|
+
generation_type: document
|
|
186
|
+
mode_template: "{{mode_templates_path}}/refactor-plan-mode.md"
|
|
187
|
+
artifacts:
|
|
188
|
+
- file: "{{spec_artifacts_path}}/project-essentials.md"
|
|
189
|
+
action: modify
|
|
190
|
+
- name: refactor_document
|
|
191
|
+
info: Update documentation artifacts (README, brand descriptions, landing page, MkDocs)
|
|
192
|
+
description: Update existing documentation files because of new features or improvements, including README, brand descriptions, landing page, and MkDocs configuration. You can also migrate legacy project-guide documentation--it will preserve information while restructuring into standardized sections.
|
|
193
|
+
sequence_or_cycle: cycle
|
|
194
|
+
generation_type: document
|
|
195
|
+
mode_template: "{{mode_templates_path}}/refactor-document-mode.md"
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# Guides Directory
|
|
2
|
+
|
|
3
|
+
**IMPORTANT: Needs update**
|
|
4
|
+
|
|
5
|
+
This directory contains documentation for LLM-assisted development workflows and developer reference materials.
|
|
6
|
+
|
|
7
|
+
## Project Workflow Overview
|
|
8
|
+
|
|
9
|
+
The LLM creates or improves the following documents **in order**, waiting for developer approval after each one:
|
|
10
|
+
|
|
11
|
+
| Step | Document | Purpose |
|
|
12
|
+
|------|----------|---------|
|
|
13
|
+
| 1 | `docs/specs/features.md` | What the project does (requirements, not implementation) |
|
|
14
|
+
| 2 | `docs/specs/tech-spec.md` | How the project is built (architecture, modules, dependencies) |
|
|
15
|
+
| 3 | `docs/specs/stories.md` | Step-by-step implementation plan (phases, stories, checklists) |
|
|
16
|
+
|
|
17
|
+
After all three documents are approved, the LLM proceeds to scaffold the project and implement stories one by one.
|
|
18
|
+
|
|
19
|
+
## Development Mode – Focused LLM Prompts
|
|
20
|
+
|
|
21
|
+
Project-Guide provides structured instructions for LLMs to follow when working on projects focused on the subset of tasks that are needed, called a "mode":
|
|
22
|
+
|
|
23
|
+
- **`project_guide.md`** - Core workflow for LLM-assisted project creation from scratch. Read this at the start of every new project session.
|
|
24
|
+
- **`best_practices_guide.md`** - Diagnostic patterns and anti-patterns for evaluating project quality. Use for occasional audits.
|
|
25
|
+
- **`debug_guide.md`** - Test-driven debugging methodology for fixing bugs in existing projects.
|
|
26
|
+
- **`documentation-setup-guide.md`** - Step-by-step workflow for setting up GitHub Pages documentation with MkDocs and custom landing pages.
|
|
27
|
+
|
|
28
|
+
## Developer-Focused Guides
|
|
29
|
+
|
|
30
|
+
The `developer/` subdirectory contains manual setup instructions and troubleshooting guides for human developers:
|
|
31
|
+
|
|
32
|
+
- Manual service configuration (e.g., Codecov, PyPI trusted publishers)
|
|
33
|
+
- Troubleshooting references
|
|
34
|
+
- One-time setup procedures
|
|
35
|
+
- Production mode workflow and GitHub repository setup
|
|
36
|
+
|
|
37
|
+
These guides are primarily for manual setup tasks, but LLMs may reference excerpts when providing step-by-step instructions or documenting procedures in stories.
|
|
38
|
+
|
|
39
|
+
## Usage
|
|
40
|
+
|
|
41
|
+
**For LLMs:**
|
|
42
|
+
- Consult `go-project_guide.md` at the start of every project session
|
|
43
|
+
|
|
44
|
+
**???**
|
|
45
|
+
- Reference `debug_guide.md` when bugs are reported
|
|
46
|
+
- Use `documentation-setup-guide.md` when setting up public documentation
|
|
47
|
+
- Check `best_practices_guide.md` when auditing project quality
|
|
48
|
+
|
|
49
|
+
**For Developers:**
|
|
50
|
+
- Refer to `developer/` guides for manual setup tasks
|
|
51
|
+
- Use these guides as troubleshooting references
|