You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+89-21Lines changed: 89 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,18 +1,65 @@
1
-
Python Tutor -- http://pythontutor.com/ -- helps people overcome a fundamental barrier to learning programming: understanding what happens as the computer executes each line of a program's source code. Using this tool, you can write Python, Java, JavaScript, TypeScript, Ruby, C, and C++ programs in your Web browser and visualize what the computer is doing step-by-step as it executes those programs.
Python Tutor helps people overcome a fundamental barrier to learning programming: understanding what happens as the computer executes each line of a program's source code. Using this tool, you can write Python, Java, JavaScript, TypeScript, Ruby, C, and C++ programs in your Web browser and visualize what the computer is doing step-by-step as it executes those programs.
9
+
10
+
This repository makes some small modifications to the original code to provide it as a Docker service
11
+
to embed the interface on UNCode and allow users to visualize their code in Python3, C/C++ and Java.
12
+
13
+
The container is deployed in Docker Hub: [unjudge/onlinepythontutor][unjudge/onlinepythontutor_url].
14
+
15
+
The official website of the project is: <http://pythontutor.com/>.
2
16
3
17
This tool was created by [Philip Guo](http://pgbovine.net/) in January 2010. [See project history](history.txt).
-[Overview for Developers](v3/docs/developer-overview.md)
7
23
8
-
All documentation is viewable online at: https://github.com/pgbovine/OnlinePythonTutor/tree/master/v3/docs
24
+
To view all documentation related to this project check the [docs][py_tutor_docs_url]. For additional documentation,
25
+
please refer to the [Wiki][uncode_wiki_url].
9
26
27
+
## Getting started
10
28
11
-
### Quick Start
29
+
As this repository in only focused on supporting this utility for UNCode, there are two options to deploy and embed
30
+
this on UNCode. This integration is also done in the organization main repository, in the [multilang plugin][multilang_url].
12
31
13
-
BY FAR the most preferred way to use Python Tutor is via the official website, since it contains the latest updates: http://pythontutor.com/
32
+
Check the [iframe embedding documentation][embedding_path] for a better understanding on how this works.
14
33
15
-
You can use [iframe embedding](v3/docs/embedding-HOWTO.md) to easily embed visualizations on your webpage.
34
+
However, it can be hard to run your own visualizer locally for non-Python languages, since it is necessary to deploy
35
+
a service called `cokapi`, check the [documentation][cokapi_url]. This service also needs a backend to run
36
+
C/C++ code, this is located in the repository [opt-cpp-backend][opt_cpp_backend_url].
37
+
38
+
To understand more how to deploy this service, check this [script][deploy_cokapi_url], which automatically deploys it
39
+
when UNCode is deployed automatically.
40
+
41
+
For further directions, see [Overview for Developers](v3/docs/developer-overview.md) or explore the [rest of the docs](v3/docs/).
42
+
43
+
### Running container
44
+
45
+
To run the container, you can either pull it from docker hub:
46
+
47
+
```bash
48
+
docker pull unjudge/onlinepythontutor
49
+
```
50
+
51
+
Or build it:
52
+
53
+
```bash
54
+
docker build -t unjudge/onlinepythontutor ./
55
+
docker run -p 8003:8003 -e PY_CMD=python3 unjudge/onlinepythontutor
56
+
```
57
+
58
+
To visualize python 2.7 code, run the container using the environment variable `PY_CMD` with `python`, rather than `python3`.
59
+
60
+
You should see the visualizer at: http://localhost:8003/visualize.html
61
+
62
+
### Running locally
16
63
17
64
If you want to run locally on your own computer, to run Python visualizations try:
18
65
@@ -22,16 +69,33 @@ cd OnlinePythonTutor/v3/
22
69
python bottle_server.py
23
70
```
24
71
25
-
You should see the visualizer at: http://localhost:8003/visualize.html
72
+
You should see the visualizer at: <http://localhost:8003/visualize.html> and the live programming environment
73
+
at: <http://localhost:8003/live.html>
26
74
27
-
... and the live programming environment at: http://localhost:8003/live.html
75
+
## Roadmap
28
76
29
-
However, it can be hard to run your own visualizer locally for non-Python languages, since there are complex setups in v4-cokapi/ that I haven't yet cleanly packaged up.
77
+
See the [UNCode GitHub Project][project_url] for a list of proposed features for UNCode, known issues and how they are
78
+
being tackled.
30
79
31
-
For further directions, see [Overview for Developers](v3/docs/developer-overview.md) or explore the [rest of the docs](v3/docs/).
80
+
## Contributing
81
+
82
+
Go to [CONTRIBUTING][contributing_url] to see the guidelines and how to start contributing to UNCode.
32
83
84
+
## License
33
85
34
-
### Acknowledgments
86
+
Distributed under the MIT License. See [LICENSE][license_url] for more information.
87
+
88
+
## Contact
89
+
90
+
In case of technical questions, please use the [gitter communication channel][gitter_url].
91
+
92
+
In case you want to host your course on our deployment, email us on: <uncode_fibog@unal.edu.co>
0 commit comments