codejourney 0.1.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.
@@ -0,0 +1,61 @@
1
+ Metadata-Version: 2.4
2
+ Name: codejourney
3
+ Version: 0.1.0
4
+ Summary: Educational Python execution visualization for Jupyter notebooks
5
+ Author: CS1302 Group 09
6
+ License-Expression: MIT
7
+ Project-URL: Homepage, https://github.com/ercch/cs1302-group09-project
8
+ Requires-Python: >=3.9
9
+ Description-Content-Type: text/markdown
10
+
11
+ # CodeJourney
12
+
13
+ CodeJourney is an educational Python execution visualizer for Jupyter
14
+ Notebooks. It helps beginner programmers understand execution through
15
+ source-line highlighting, variable changes, loop-aware navigation, and
16
+ educational warnings. It is not a full debugger or a security sandbox.
17
+
18
+ CodeJourney captures source lines, safe variable snapshots, variable diffs,
19
+ collection changes, aliases, loop iterations, condition previews, and
20
+ educational warnings. `TraceResult` exposes structured Python data and renders
21
+ a self-contained interactive HTML view in Jupyter.
22
+
23
+ Install the published package from PyPI with:
24
+
25
+ ```shell
26
+ pip install codejourney
27
+ ```
28
+
29
+ ```python
30
+ from codejourney import run_viz
31
+
32
+ trace = run_viz("x = 1\nx += 1")
33
+ trace.events
34
+ trace._repr_html_()
35
+ ```
36
+
37
+ Importing `codejourney` in an IPython/Jupyter session registers the `%%pyviz`
38
+ cell magic automatically:
39
+
40
+ ```python
41
+ %%pyviz
42
+ total = 0
43
+ for number in [1, 2, 3]:
44
+ total += number
45
+ ```
46
+
47
+ `run_viz` accepts a `max_steps` limit (default: `500`):
48
+
49
+ ```python
50
+ trace = run_viz("count = 0\nwhile count < 3:\n count += 1", max_steps=100)
51
+ trace.warnings
52
+ ```
53
+
54
+ Execution is **not sandboxed**: analyzed code runs with the Python process's
55
+ normal permissions and may perform I/O or access the network. The step limit
56
+ bounds traced Python lines only; it is not a timeout or security boundary.
57
+
58
+ CodeJourney is an educational visualizer, not a full debugger. It does not
59
+ provide breakpoints or control a live execution session.
60
+
61
+ The project specification and roadmap are in [SPEC.md](./SPEC.md).
@@ -0,0 +1,7 @@
1
+ codejourney/__init__.py,sha256=CbuIBXb_mIXVPrj88xvfH7W433TDzEy_Cbw9aksI8Mc,25470
2
+ codejourney/analysis.py,sha256=TLtygMr5OwjKqa8mKkIICNeamSXWhMhrJdw2ag2aX1o,10956
3
+ codejourney/visualization.py,sha256=R1FC_XzjSXt7-GPm8czkQvp3BCn8BVFYP4w0KcKGOD0,15866
4
+ codejourney-0.1.0.dist-info/METADATA,sha256=DZzk05CWMNZCbFQEWQ7q2mQTUa2CdtYETd2QsviQ_TU,1864
5
+ codejourney-0.1.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
6
+ codejourney-0.1.0.dist-info/top_level.txt,sha256=vxi8uIn4dCJu6PjT-8IP2eJlpWGaB7jHbo8Z3T_U57k,12
7
+ codejourney-0.1.0.dist-info/RECORD,,
@@ -0,0 +1,5 @@
1
+ Wheel-Version: 1.0
2
+ Generator: setuptools (84.2.1)
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
5
+
@@ -0,0 +1 @@
1
+ codejourney