codemble 0.3.0__py3-none-any.whl
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.
- codemble/__init__.py +4 -0
- codemble/adapters/__init__.py +38 -0
- codemble/adapters/base.py +199 -0
- codemble/adapters/discovery.py +190 -0
- codemble/adapters/project.py +206 -0
- codemble/adapters/python_ast.py +766 -0
- codemble/adapters/typescript_tree_sitter.py +1263 -0
- codemble/checks/__init__.py +19 -0
- codemble/checks/service.py +380 -0
- codemble/cli.py +161 -0
- codemble/graph/__init__.py +17 -0
- codemble/graph/finalize.py +91 -0
- codemble/graph/layout.py +132 -0
- codemble/lens/__init__.py +18 -0
- codemble/lens/javascript_typescript.py +82 -0
- codemble/lens/python.py +71 -0
- codemble/llm/__init__.py +6 -0
- codemble/llm/providers.py +137 -0
- codemble/llm/study.py +439 -0
- codemble/progress/__init__.py +9 -0
- codemble/progress/store.py +160 -0
- codemble/server/__init__.py +6 -0
- codemble/server/app.py +273 -0
- codemble/server/runtime.py +68 -0
- codemble/web_dist/assets/index-DOBVd_-M.css +1 -0
- codemble/web_dist/assets/index-cIG6GGIB.js +5238 -0
- codemble/web_dist/assets/jetbrains-mono-latin-400-normal-6-qcROiO.woff +0 -0
- codemble/web_dist/assets/jetbrains-mono-latin-400-normal-V6pRDFza.woff2 +0 -0
- codemble/web_dist/assets/jetbrains-mono-latin-500-normal-BWZEU5yA.woff2 +0 -0
- codemble/web_dist/assets/jetbrains-mono-latin-500-normal-CJOVTJB7.woff +0 -0
- codemble/web_dist/assets/shippori-mincho-latin-500-normal-C-QwvIb3.woff +0 -0
- codemble/web_dist/assets/shippori-mincho-latin-500-normal-XI1O8euf.woff2 +0 -0
- codemble/web_dist/assets/shippori-mincho-latin-700-normal-CkoCYOiI.woff +0 -0
- codemble/web_dist/assets/shippori-mincho-latin-700-normal-DHcmzUO5.woff2 +0 -0
- codemble/web_dist/assets/zen-kaku-gothic-new-latin-400-normal-BEdayliK.woff2 +0 -0
- codemble/web_dist/assets/zen-kaku-gothic-new-latin-400-normal-CPSmNJAU.woff +0 -0
- codemble/web_dist/index.html +18 -0
- codemble-0.3.0.dist-info/METADATA +417 -0
- codemble-0.3.0.dist-info/RECORD +43 -0
- codemble-0.3.0.dist-info/WHEEL +4 -0
- codemble-0.3.0.dist-info/entry_points.txt +2 -0
- codemble-0.3.0.dist-info/licenses/LICENSE +202 -0
- codemble-0.3.0.dist-info/licenses/NOTICE +2 -0
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
<!doctype html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="UTF-8" />
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover" />
|
|
6
|
+
<meta name="theme-color" content="#0b0d16" />
|
|
7
|
+
<meta
|
|
8
|
+
name="description"
|
|
9
|
+
content="Explore the parser-proven structure of your local project with Codemble."
|
|
10
|
+
/>
|
|
11
|
+
<title>Codemble · Your code, mapped</title>
|
|
12
|
+
<script type="module" crossorigin src="/assets/index-cIG6GGIB.js"></script>
|
|
13
|
+
<link rel="stylesheet" crossorigin href="/assets/index-DOBVd_-M.css">
|
|
14
|
+
</head>
|
|
15
|
+
<body>
|
|
16
|
+
<div id="root"></div>
|
|
17
|
+
</body>
|
|
18
|
+
</html>
|
|
@@ -0,0 +1,417 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: codemble
|
|
3
|
+
Version: 0.3.0
|
|
4
|
+
Summary: A learning game that turns the code AI wrote for you into a galaxy you light up by understanding it.
|
|
5
|
+
Project-URL: Homepage, https://udhawan97.github.io/Codemble/
|
|
6
|
+
Project-URL: Repository, https://github.com/udhawan97/Codemble
|
|
7
|
+
Author-email: Umang Dhawan <umangdhawan97@gmail.com>
|
|
8
|
+
License:
|
|
9
|
+
Apache License
|
|
10
|
+
Version 2.0, January 2004
|
|
11
|
+
http://www.apache.org/licenses/
|
|
12
|
+
|
|
13
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
14
|
+
|
|
15
|
+
1. Definitions.
|
|
16
|
+
|
|
17
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
18
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
19
|
+
|
|
20
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
21
|
+
the copyright owner that is granting the License.
|
|
22
|
+
|
|
23
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
24
|
+
other entities that control, are controlled by, or are under common
|
|
25
|
+
control with that entity. For the purposes of this definition,
|
|
26
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
27
|
+
direction or management of such entity, whether by contract or
|
|
28
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
29
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
30
|
+
|
|
31
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
32
|
+
exercising permissions granted by this License.
|
|
33
|
+
|
|
34
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
35
|
+
including but not limited to software source code, documentation
|
|
36
|
+
source, and configuration files.
|
|
37
|
+
|
|
38
|
+
"Object" form shall mean any form resulting from mechanical
|
|
39
|
+
transformation or translation of a Source form, including but
|
|
40
|
+
not limited to compiled object code, generated documentation,
|
|
41
|
+
and conversions to other media types.
|
|
42
|
+
|
|
43
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
44
|
+
Object form, made available under the License, as indicated by a
|
|
45
|
+
copyright notice that is included in or attached to the work
|
|
46
|
+
(an example is provided in the Appendix below).
|
|
47
|
+
|
|
48
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
49
|
+
form, that is based on (or derived from) the Work and for which the
|
|
50
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
51
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
52
|
+
of this License, Derivative Works shall not include works that remain
|
|
53
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
54
|
+
the Work and Derivative Works thereof.
|
|
55
|
+
|
|
56
|
+
"Contribution" shall mean any work of authorship, including
|
|
57
|
+
the original version of the Work and any modifications or additions
|
|
58
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
59
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
60
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
61
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
62
|
+
means any form of electronic, verbal, or written communication sent
|
|
63
|
+
to the Licensor or its representatives, including but not limited to
|
|
64
|
+
communication on electronic mailing lists, source code control systems,
|
|
65
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
66
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
67
|
+
excluding communication that is conspicuously marked or otherwise
|
|
68
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
69
|
+
|
|
70
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
71
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
72
|
+
subsequently incorporated within the Work.
|
|
73
|
+
|
|
74
|
+
2. Grant of Copyright 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
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
78
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
79
|
+
Work and such Derivative Works in Source or Object form.
|
|
80
|
+
|
|
81
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
82
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
83
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
84
|
+
(except as stated in this section) patent license to make, have made,
|
|
85
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
86
|
+
where such license applies only to those patent claims licensable
|
|
87
|
+
by such Contributor that are necessarily infringed by their
|
|
88
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
89
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
90
|
+
institute patent litigation against any entity (including a
|
|
91
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
92
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
93
|
+
or contributory patent infringement, then any patent licenses
|
|
94
|
+
granted to You under this License for that Work shall terminate
|
|
95
|
+
as of the date such litigation is filed.
|
|
96
|
+
|
|
97
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
98
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
99
|
+
modifications, and in Source or Object form, provided that You
|
|
100
|
+
meet the following conditions:
|
|
101
|
+
|
|
102
|
+
(a) You must give any other recipients of the Work or
|
|
103
|
+
Derivative Works a copy of this License; and
|
|
104
|
+
|
|
105
|
+
(b) You must cause any modified files to carry prominent notices
|
|
106
|
+
stating that You changed the files; and
|
|
107
|
+
|
|
108
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
109
|
+
that You distribute, all copyright, patent, trademark, and
|
|
110
|
+
attribution notices from the Source form of the Work,
|
|
111
|
+
excluding those notices that do not pertain to any part of
|
|
112
|
+
the Derivative Works; and
|
|
113
|
+
|
|
114
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
115
|
+
distribution, then any Derivative Works that You distribute must
|
|
116
|
+
include a readable copy of the attribution notices contained
|
|
117
|
+
within such NOTICE file, excluding those notices that do not
|
|
118
|
+
pertain to any part of the Derivative Works, in at least one
|
|
119
|
+
of the following places: within a NOTICE text file distributed
|
|
120
|
+
as part of the Derivative Works; within the Source form or
|
|
121
|
+
documentation, if provided along with the Derivative Works; or,
|
|
122
|
+
within a display generated by the Derivative Works, if and
|
|
123
|
+
wherever such third-party notices normally appear. The contents
|
|
124
|
+
of the NOTICE file are for informational purposes only and
|
|
125
|
+
do not modify the License. You may add Your own attribution
|
|
126
|
+
notices within Derivative Works that You distribute, alongside
|
|
127
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
128
|
+
that such additional attribution notices cannot be construed
|
|
129
|
+
as modifying the License.
|
|
130
|
+
|
|
131
|
+
You may add Your own copyright statement to Your modifications and
|
|
132
|
+
may provide additional or different license terms and conditions
|
|
133
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
134
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
135
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
136
|
+
the conditions stated in this License.
|
|
137
|
+
|
|
138
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
139
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
140
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
141
|
+
this License, without any additional terms or conditions.
|
|
142
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
143
|
+
the terms of any separate license agreement you may have executed
|
|
144
|
+
with Licensor regarding such Contributions.
|
|
145
|
+
|
|
146
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
147
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
148
|
+
except as required for reasonable and customary use in describing the
|
|
149
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
150
|
+
|
|
151
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
152
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
153
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
154
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
155
|
+
implied, including, without limitation, any warranties or conditions
|
|
156
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
157
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
158
|
+
appropriateness of using or redistributing the Work and assume any
|
|
159
|
+
risks associated with Your exercise of permissions under this License.
|
|
160
|
+
|
|
161
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
162
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
163
|
+
unless required by applicable law (such as deliberate and grossly
|
|
164
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
165
|
+
liable to You for damages, including any direct, indirect, special,
|
|
166
|
+
incidental, or consequential damages of any character arising as a
|
|
167
|
+
result of this License or out of the use or inability to use the
|
|
168
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
169
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
170
|
+
other commercial damages or losses), even if such Contributor
|
|
171
|
+
has been advised of the possibility of such damages.
|
|
172
|
+
|
|
173
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
174
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
175
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
176
|
+
or other liability obligations and/or rights consistent with this
|
|
177
|
+
License. However, in accepting such obligations, You may act only
|
|
178
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
179
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
180
|
+
defend, and hold each Contributor harmless for any liability
|
|
181
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
182
|
+
of your accepting any such warranty or additional liability.
|
|
183
|
+
|
|
184
|
+
END OF TERMS AND CONDITIONS
|
|
185
|
+
|
|
186
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
187
|
+
|
|
188
|
+
To apply the Apache License to your work, attach the following
|
|
189
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
190
|
+
replaced with your own identifying information. (Don't include
|
|
191
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
192
|
+
comment syntax for the file format. We also recommend that a
|
|
193
|
+
file or class name and description of purpose be included on the
|
|
194
|
+
same "printed page" as the copyright notice for easier
|
|
195
|
+
identification within third-party archives.
|
|
196
|
+
|
|
197
|
+
Copyright [yyyy] [name of copyright owner]
|
|
198
|
+
|
|
199
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
200
|
+
you may not use this file except in compliance with the License.
|
|
201
|
+
You may obtain a copy of the License at
|
|
202
|
+
|
|
203
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
204
|
+
|
|
205
|
+
Unless required by applicable law or agreed to in writing, software
|
|
206
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
207
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
208
|
+
See the License for the specific language governing permissions and
|
|
209
|
+
limitations under the License.
|
|
210
|
+
License-File: LICENSE
|
|
211
|
+
License-File: NOTICE
|
|
212
|
+
Requires-Python: >=3.11
|
|
213
|
+
Requires-Dist: fastapi>=0.115
|
|
214
|
+
Requires-Dist: tree-sitter-javascript<0.26,>=0.25
|
|
215
|
+
Requires-Dist: tree-sitter-typescript<0.24,>=0.23.2
|
|
216
|
+
Requires-Dist: tree-sitter<0.27,>=0.25
|
|
217
|
+
Requires-Dist: uvicorn>=0.30
|
|
218
|
+
Provides-Extra: dev
|
|
219
|
+
Requires-Dist: httpx>=0.27; extra == 'dev'
|
|
220
|
+
Requires-Dist: pytest>=8; extra == 'dev'
|
|
221
|
+
Requires-Dist: ruff>=0.6; extra == 'dev'
|
|
222
|
+
Description-Content-Type: text/markdown
|
|
223
|
+
|
|
224
|
+
<!-- Hallmark · pre-emit critique: P5 H5 E5 S5 R5 V4 -->
|
|
225
|
+
|
|
226
|
+
<p align="center">
|
|
227
|
+
<a href="https://udhawan97.github.io/Codemble/">
|
|
228
|
+
<img src="docs-site/public/brand/mark-animated.svg" alt="Codemble — an open lapis ensō whose amber star systems light up" width="152">
|
|
229
|
+
</a>
|
|
230
|
+
</p>
|
|
231
|
+
|
|
232
|
+
<h1 align="center">Codemble</h1>
|
|
233
|
+
|
|
234
|
+
<p align="center"><strong>Turn AI-built code into a galaxy you actually understand.</strong></p>
|
|
235
|
+
|
|
236
|
+
<p align="center">
|
|
237
|
+
Codemble is a local-first learning game for projects built with Claude Code,
|
|
238
|
+
Codex, and other coding agents. It maps real parser evidence into a 3D galaxy,
|
|
239
|
+
then lights each region only after you prove you understand it.
|
|
240
|
+
</p>
|
|
241
|
+
|
|
242
|
+
<p align="center"><strong>Your project · Your key · Your machine · No invented structure</strong></p>
|
|
243
|
+
|
|
244
|
+
<p align="center">
|
|
245
|
+
<a href="https://github.com/udhawan97/Codemble/releases/latest"><img src="https://img.shields.io/github/v/release/udhawan97/Codemble?style=flat-square&label=release&color=2b4d96" alt="Latest release"></a>
|
|
246
|
+
<a href="https://github.com/udhawan97/Codemble/actions/workflows/ci.yml"><img src="https://github.com/udhawan97/Codemble/actions/workflows/ci.yml/badge.svg?branch=main" alt="CI status"></a>
|
|
247
|
+
<img src="https://img.shields.io/badge/Python-3.11+-2b4d96?style=flat-square" alt="Python 3.11 or newer">
|
|
248
|
+
<img src="https://img.shields.io/badge/maps-Python_·_JavaScript_·_TypeScript-3f6ac0?style=flat-square" alt="Maps Python, JavaScript, and TypeScript projects">
|
|
249
|
+
<img src="https://img.shields.io/badge/license-Apache_2.0-070b1c?style=flat-square" alt="Apache 2.0 license">
|
|
250
|
+
</p>
|
|
251
|
+
|
|
252
|
+
<p align="center">
|
|
253
|
+
<a href="#quick-start">Quick start</a> ·
|
|
254
|
+
<a href="#how-the-learning-loop-works">Learning loop</a> ·
|
|
255
|
+
<a href="https://udhawan97.github.io/Codemble/">Documentation</a> ·
|
|
256
|
+
<a href="TESTING.md">Test v0.2.0</a>
|
|
257
|
+
</p>
|
|
258
|
+
|
|
259
|
+
<p align="center">
|
|
260
|
+
<img src="assets/demo.gif" alt="Codemble maps a project, enters Home, runs graph-derived checks, and lights the system" width="960">
|
|
261
|
+
</p>
|
|
262
|
+
|
|
263
|
+
> [!IMPORTANT]
|
|
264
|
+
> **v0.2.0 is the current Phase 1 tester release.** It maps Python,
|
|
265
|
+
> JavaScript, TypeScript, and mixed projects in one parser-proven galaxy. The
|
|
266
|
+
> technical release is complete; unaided learner runs are the evidence still
|
|
267
|
+
> being collected. [Try the ten-minute tester loop](TESTING.md).
|
|
268
|
+
|
|
269
|
+
## Quick start
|
|
270
|
+
|
|
271
|
+
```bash
|
|
272
|
+
uvx codemble # or: pipx install codemble && codemble
|
|
273
|
+
```
|
|
274
|
+
|
|
275
|
+
Codemble opens your browser — pick your project folder there. To skip the
|
|
276
|
+
picker, pass a path: `codemble ./your-ai-built-project`.
|
|
277
|
+
|
|
278
|
+
> Until the first PyPI release (v0.3.0) lands, install from the tag instead —
|
|
279
|
+
> v0.2.0 has no picker yet, so pass your project path:
|
|
280
|
+
>
|
|
281
|
+
> ```bash
|
|
282
|
+
> pipx install git+https://github.com/udhawan97/Codemble.git@v0.2.0
|
|
283
|
+
> codemble ./your-ai-built-project
|
|
284
|
+
> ```
|
|
285
|
+
|
|
286
|
+
The wheel already contains the web app, so Node.js is not required. No API key is needed for the galaxy,
|
|
287
|
+
source viewer, language Lens, checks, lighting, or saved progress. Add your own
|
|
288
|
+
Anthropic or OpenAI key only if you want grounded prose explanations:
|
|
289
|
+
|
|
290
|
+
```bash
|
|
291
|
+
export ANTHROPIC_API_KEY=sk-ant-... # or OPENAI_API_KEY=sk-...
|
|
292
|
+
```
|
|
293
|
+
|
|
294
|
+
[Installation, configuration, and troubleshooting →](https://udhawan97.github.io/Codemble/installation/)
|
|
295
|
+
|
|
296
|
+
## How the learning loop works
|
|
297
|
+
|
|
298
|
+
| Step | What Codemble does | What you gain |
|
|
299
|
+
| --- | --- | --- |
|
|
300
|
+
| **1. Chart** | Parses your project without running its code or package scripts | A deterministic map made from source evidence |
|
|
301
|
+
| **2. Navigate** | Guides you from galaxy → system → study on scripted camera rails | Orientation without getting lost in free flight |
|
|
302
|
+
| **3. Study** | Shows the real source, exact line numbers, neighbors, and parser-detected language idioms | Context tied to code you can inspect |
|
|
303
|
+
| **4. Prove** | Generates and scores checks from the graph—never from the model | A region lights only when understanding is demonstrated |
|
|
304
|
+
| **5. Return** | Saves progress locally; changing one file re-dims only its module | A living map that stays honest as the project changes |
|
|
305
|
+
|
|
306
|
+
No XP. No streaks. No leaderboard. The visible reward is the useful one: more
|
|
307
|
+
of your own code becomes a sky you understand.
|
|
308
|
+
|
|
309
|
+
## Read the galaxy
|
|
310
|
+
|
|
311
|
+
| In the galaxy | In your project |
|
|
312
|
+
| --- | --- |
|
|
313
|
+
| A star system | One source module |
|
|
314
|
+
| A planet | A function or class |
|
|
315
|
+
| The Home system | The selected parser-ranked entrypoint |
|
|
316
|
+
| A route or edge | An import or call; approximate calls are labeled **possible** |
|
|
317
|
+
| Size | Lines of code |
|
|
318
|
+
| Brightness | Structural centrality |
|
|
319
|
+
| Dim → lit | Not yet proven → understood |
|
|
320
|
+
|
|
321
|
+
Python-only, JavaScript-only, TypeScript-only, and mixed projects share the same
|
|
322
|
+
graph contract. Language focus changes only what you are looking at; it never
|
|
323
|
+
changes coordinates, progress, or parser truth.
|
|
324
|
+
|
|
325
|
+
## Honest by construction
|
|
326
|
+
|
|
327
|
+
Codemble is built for learners who may not yet be able to spot a confident
|
|
328
|
+
mistake. Accuracy therefore outranks spectacle:
|
|
329
|
+
|
|
330
|
+
- Structure, entrypoints, concepts, imports, and calls come from parsers.
|
|
331
|
+
- Every explanation points to a real `file:line` and may name only supplied
|
|
332
|
+
identifiers and relationships.
|
|
333
|
+
- Language Lens notes appear only where a parser detected the construct.
|
|
334
|
+
- Check answers come from the graph, never an LLM.
|
|
335
|
+
- Approximate relationships stay visibly uncertain.
|
|
336
|
+
- Provider output that fails grounding validation is withheld instead of being
|
|
337
|
+
softened into a guess.
|
|
338
|
+
|
|
339
|
+
Read the full [correctness contract](https://udhawan97.github.io/Codemble/correctness/).
|
|
340
|
+
A wrong explanation is a highest-severity bug—[report it without mercy](https://github.com/udhawan97/Codemble/issues).
|
|
341
|
+
|
|
342
|
+
## Local-first, with an explicit AI boundary
|
|
343
|
+
|
|
344
|
+
| Stays on your machine | Leaves only when you ask |
|
|
345
|
+
| --- | --- |
|
|
346
|
+
| Project discovery and parsing | The bounded Study context sent to your configured provider |
|
|
347
|
+
| Graph, language Lens, and checks | A request triggered only when you open Study |
|
|
348
|
+
| Local server and packaged web app | Nothing in the background |
|
|
349
|
+
| Progress and explanation cache in `~/.codemble/` | No accounts, telemetry, or Codemble cloud |
|
|
350
|
+
|
|
351
|
+
No key? Codemble remains a complete parser-backed map and learning game; only
|
|
352
|
+
the optional prose narration is unavailable.
|
|
353
|
+
|
|
354
|
+
## Boundaries that keep the map truthful
|
|
355
|
+
|
|
356
|
+
- **Supported source:** Python 3.11+, JavaScript/JSX, TypeScript/TSX, and mixed
|
|
357
|
+
projects. Unsupported languages stay outside the graph rather than being guessed.
|
|
358
|
+
- **Scale:** above roughly 300 supported source files, choose a subdirectory —
|
|
359
|
+
the in-app picker prompts for the scope, or pass
|
|
360
|
+
`codemble --path ./project/subdirectory`.
|
|
361
|
+
- **Ambiguous Home:** choose a parser-ranked entrypoint in the app or pass
|
|
362
|
+
`--entrypoint NODE_ID`.
|
|
363
|
+
- **Broken source:** syntax errors remain visible; Codemble maps safe partial
|
|
364
|
+
evidence instead of crashing or inventing the missing structure.
|
|
365
|
+
- **Rendering:** WebGL is required. There is intentionally no misleading 2D
|
|
366
|
+
fallback in this release.
|
|
367
|
+
|
|
368
|
+
## Help test the release
|
|
369
|
+
|
|
370
|
+
The most valuable contribution right now is not a feature request. It is a
|
|
371
|
+
first run on a real AI-built project:
|
|
372
|
+
|
|
373
|
+
1. Follow the [ten-minute tester guide](TESTING.md).
|
|
374
|
+
2. Light at least one system.
|
|
375
|
+
3. Report confusion verbatim—never paste private source or API keys.
|
|
376
|
+
|
|
377
|
+
[Open an early-tester report →](https://github.com/udhawan97/Codemble/issues/new?template=early_tester.yml)
|
|
378
|
+
|
|
379
|
+
## Develop
|
|
380
|
+
|
|
381
|
+
```bash
|
|
382
|
+
python -m venv .venv && source .venv/bin/activate
|
|
383
|
+
pip install -e ".[dev]"
|
|
384
|
+
pytest && ruff check .
|
|
385
|
+
|
|
386
|
+
(cd web && npm install && npm run check)
|
|
387
|
+
(cd docs-site && npm install && npm run check && npm run build)
|
|
388
|
+
```
|
|
389
|
+
|
|
390
|
+
The load-bearing design and architecture contracts are documented, not implied:
|
|
391
|
+
|
|
392
|
+
- [Architecture](https://udhawan97.github.io/Codemble/architecture/)
|
|
393
|
+
- [Contributing](CONTRIBUTING.md)
|
|
394
|
+
- [Formal Edo design system](docs-site/design.md)
|
|
395
|
+
- [Agent operating guide and current state](CLAUDE.md)
|
|
396
|
+
|
|
397
|
+
## Roadmap
|
|
398
|
+
|
|
399
|
+
| Horizon | Work |
|
|
400
|
+
| --- | --- |
|
|
401
|
+
| **Now** | Collect unaided first-run evidence on v0.2.0 across supported project types |
|
|
402
|
+
| **Next** | Go, Rust, and Java adapters; level-of-detail rendering for larger repositories |
|
|
403
|
+
| **Later** | Read-only share links, new quest types, and the coordinated public launch |
|
|
404
|
+
|
|
405
|
+
The [public roadmap](https://udhawan97.github.io/Codemble/roadmap/) separates
|
|
406
|
+
shipped work from planned work. Milestones move only when their acceptance
|
|
407
|
+
evidence exists.
|
|
408
|
+
|
|
409
|
+
## License
|
|
410
|
+
|
|
411
|
+
Codemble is released under the [Apache License 2.0](LICENSE).
|
|
412
|
+
|
|
413
|
+
---
|
|
414
|
+
|
|
415
|
+
<p align="center"><sub>
|
|
416
|
+
Built for the moment after “AI made it work” and before “I know how it works.”
|
|
417
|
+
</sub></p>
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
codemble/__init__.py,sha256=i2ZbqllYjvARubUEhxay8QCh3XszXyio4OllkaUMhGc,190
|
|
2
|
+
codemble/cli.py,sha256=oYsZ86ncMTOr_X5RWvCzFP2-Kz1Doj1H3nYa_rXEEaE,5600
|
|
3
|
+
codemble/adapters/__init__.py,sha256=MM2hpunGYrd6cPRqT8h_kRPkx7WMiVKK-iuvftireQk,881
|
|
4
|
+
codemble/adapters/base.py,sha256=7Z1HELwvgmTiq24CEVO5cK-RzjkVg7W_-7pA5X5tO9Y,5922
|
|
5
|
+
codemble/adapters/discovery.py,sha256=Cp-bKNDZmFKU_wHComZXR5ehw_7chuVIwdhGQ8zoc6Q,6038
|
|
6
|
+
codemble/adapters/project.py,sha256=0ajtwyHliQaSndZLlLMVlsqSl33Mz9lj53KS1by167Q,7141
|
|
7
|
+
codemble/adapters/python_ast.py,sha256=Z84norQQr_vWSMoCm9xTokG3ILxH7L2SZrMHJ81cYgc,28217
|
|
8
|
+
codemble/adapters/typescript_tree_sitter.py,sha256=OZkXcmW_P9KOSfWLVl_T7QZnsT5lW2Z31lfwtE1lSxU,43653
|
|
9
|
+
codemble/checks/__init__.py,sha256=JwmRdIlJY8RSUAsD9SbuoUVh5ucPkz59cFZyjyaHymw,379
|
|
10
|
+
codemble/checks/service.py,sha256=veFgEtJ4Wpbnp2vHoW1PKp6U_cRxwDbXFp9oiIyCQuo,12286
|
|
11
|
+
codemble/graph/__init__.py,sha256=rZoz-hveZTfCILxVtmJ9dV3GALvp-oiNIQyZZF4SMAc,459
|
|
12
|
+
codemble/graph/finalize.py,sha256=9jL-kHGN_2QkM-EysJWEKJMO4rRKU3dL6h5uggZmzcM,2771
|
|
13
|
+
codemble/graph/layout.py,sha256=B_8Xt1dOv-cjuY1l2jASDMFXIncFakEIzKeXNW4Pkgc,5033
|
|
14
|
+
codemble/lens/__init__.py,sha256=neU7hYiVBeJYnOUdnko3fnd52wuUZBE27EI0ZmY9AGM,662
|
|
15
|
+
codemble/lens/javascript_typescript.py,sha256=1XNM3UWxqntsGqsPLQm6PZXkTKlwx6gU_zZc_wlYEGc,2948
|
|
16
|
+
codemble/lens/python.py,sha256=xkuSHzzlUsR4_xsRJWYPjf8uVyEkhNOjmoh8tT16Sjc,2400
|
|
17
|
+
codemble/llm/__init__.py,sha256=mVvSWFu8on0rcygPz0QVvxmqclmtuu8LZYW3eXCnuTE,259
|
|
18
|
+
codemble/llm/providers.py,sha256=kQJdYM0o0H2WlCkjvnDxbc9xaicnDco3WOqbfugQjkU,4623
|
|
19
|
+
codemble/llm/study.py,sha256=qhPwAiSYGant9gzXrDV1GkmiZipp5GEIGApG6H576nI,16406
|
|
20
|
+
codemble/progress/__init__.py,sha256=gJ5i4xgkdiOXiRJOxMPT-zOkbqPVxSAsKTTIblSKHJE,266
|
|
21
|
+
codemble/progress/store.py,sha256=ficMd7jC2LoaRiv18vbOLP8hdqbnStxrYxWG5pb1jkI,5757
|
|
22
|
+
codemble/server/__init__.py,sha256=SJku8CDGWoRnIbxW26YrXk1M0RKedMm7jwRAntZPLCo,236
|
|
23
|
+
codemble/server/app.py,sha256=bY3-54R3P_bkUyxo9lOeY4D3_5M3o1wgu8rPsujP0q4,10265
|
|
24
|
+
codemble/server/runtime.py,sha256=YYIH3AVmf_uqyrS1ta0gHYqaiu-relBpT-0BQg6KINI,2209
|
|
25
|
+
codemble/web_dist/index.html,sha256=GPWWhYAcFu5XnvFpYihSLn02w_ryov_RbrqNY5TXaJY,613
|
|
26
|
+
codemble/web_dist/assets/index-DOBVd_-M.css,sha256=bSk39iuiO8PLf9D98fpZ35WL7W2mCv5iLLqpZ5HBhFQ,27526
|
|
27
|
+
codemble/web_dist/assets/index-cIG6GGIB.js,sha256=F-xBRFpWPTS8154yBM4Nvl0jVgERzUtonMYHwfmPBEo,1601341
|
|
28
|
+
codemble/web_dist/assets/jetbrains-mono-latin-400-normal-6-qcROiO.woff,sha256=ZYue4HsCSc-RCo1vPYEtRsliuugdc3mgNVsds1xhWG8,27496
|
|
29
|
+
codemble/web_dist/assets/jetbrains-mono-latin-400-normal-V6pRDFza.woff2,sha256=FEJbqcaVdjwVR_SKIGt6pgNQozriPeCfBAeHfz_Nies,21168
|
|
30
|
+
codemble/web_dist/assets/jetbrains-mono-latin-500-normal-BWZEU5yA.woff2,sha256=yxgv7u1NeY_2lh08efcCYnlEj8oGdkOKrssh8_w5VTo,21832
|
|
31
|
+
codemble/web_dist/assets/jetbrains-mono-latin-500-normal-CJOVTJB7.woff,sha256=onDdC_E9kQU7iZm3wSD_rbWWgM_WP-Gms4ihO_KAn-E,28208
|
|
32
|
+
codemble/web_dist/assets/shippori-mincho-latin-500-normal-C-QwvIb3.woff,sha256=EtIu9jfKyfPNSa8UbyOezy7ze66yF1wl1P7X60KHqrU,31132
|
|
33
|
+
codemble/web_dist/assets/shippori-mincho-latin-500-normal-XI1O8euf.woff2,sha256=8p0hIuL893l7pPL8RSfS4hkG40HcF7rS45A6t7_gsoc,28708
|
|
34
|
+
codemble/web_dist/assets/shippori-mincho-latin-700-normal-CkoCYOiI.woff,sha256=yRcJrsEaj91h-BkuSpO1qD4NsEIP_wDjxO7aQXz2ggA,31300
|
|
35
|
+
codemble/web_dist/assets/shippori-mincho-latin-700-normal-DHcmzUO5.woff2,sha256=tyyPVbdTuVsjnn7U2mMxfJlAfh3_3fQjKhbnXUbIs10,28720
|
|
36
|
+
codemble/web_dist/assets/zen-kaku-gothic-new-latin-400-normal-BEdayliK.woff2,sha256=Wxv8NNYDrvZtJHvSK4NE8Z3hZdp-oH0RTYf-f_TNx3A,9752
|
|
37
|
+
codemble/web_dist/assets/zen-kaku-gothic-new-latin-400-normal-CPSmNJAU.woff,sha256=DfgY2kQAF8HkzgIGl_3HHxDvJhclmNYDz3sPjeHWSw4,12540
|
|
38
|
+
codemble-0.3.0.dist-info/METADATA,sha256=rzNakbUJ7n3Laurbjkk7NlfevMeGZuTXvmgb4s3q42I,22274
|
|
39
|
+
codemble-0.3.0.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
|
|
40
|
+
codemble-0.3.0.dist-info/entry_points.txt,sha256=jbIPIw9pBP0MdDvqy-qXCbhjylaGbYrxwi3Q0W6GIxA,47
|
|
41
|
+
codemble-0.3.0.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
|
|
42
|
+
codemble-0.3.0.dist-info/licenses/NOTICE,sha256=k-PzRKlBYNie7ZZ0ffryjDRDcf1LXBexxIR0BW6D1OU,37
|
|
43
|
+
codemble-0.3.0.dist-info/RECORD,,
|