Skip to content

Commit 7141b1a

Browse files
authored
Fixes after language edit
1 parent 4eedb5f commit 7141b1a

File tree

1 file changed

+29
-29
lines changed

1 file changed

+29
-29
lines changed

brython/README.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ Most of the examples are found in the article and others are extras that did not
1010
* In the following examples, the API is a simple text file that returns the text "Real Python"
1111
* To test the examples, execute a local web server in the respective directory
1212
* The recommended Python development server is started with: `python -m http.server`
13-
* https://realpython.com/brython-python-in-browser/#asynchronous-development-in-brython
13+
* https://realpython.com/brython-python-in-browser/#applying-asynchronous-development-in-brython
1414

1515
### aio
1616

17-
* Demonstrates the usage of `browser.aio` the substitute to `asyncio` in Brython
17+
* Demonstrates the usage of `browser.aio`, the substitute to `asyncio` in Brython
1818
* This example is in the tutorial: https://realpython.com/brython-python-in-browser/#async-io-in-brython
1919
* https://www.brython.info/static_doc/en/aio.html
2020

@@ -27,23 +27,23 @@ Most of the examples are found in the article and others are extras that did not
2727
### fetch
2828

2929
* Demonstrates the usage of JavaScript `fetch` from Brython
30-
* This example is not in the tutorial and provided as an extra. It is related to section: https://realpython.com/brython-python-in-browser/#asynchronous-development-in-brython
30+
* This example is not in the tutorial and is provided as an extra. It is related to this section: https://realpython.com/brython-python-in-browser/#applying-asynchronous-development-in-brython
3131

32-
## base64
32+
## Base64
3333

34-
Examples demonstrating how to access the DOM API starting from an app that takes a string as input, generates the base64 encoded value of the string, and displays it on the page. Each example is slightly different as stated in the following sections.
34+
Examples demonstrating how to access the DOM API starting from an app that takes a string as input, generates the Base64-encoded value of the string, and displays it on the page. Each example is slightly different as stated in the following sections.
3535

3636
### embed
3737

3838
* The application is a single `index.htm` with embedded Python code. It can be executed by opening the file with an internet browser. Starting a local web server is not required
39-
* The user enters the string to be encoded through the standard prompt message box of the browser
40-
* This example is the same as the following one but with the Python code embedded in HTML
39+
* The user enters the string to be encoded through the standard prompt message box of the browser.
40+
* This example is the same as the following one but with the Python code embedded in HTML.
4141
* It is not in the tutorial in this format, but relates to https://realpython.com/brython-python-in-browser/#the-dom-api-in-brython
4242

4343
### sep
4444

45-
* This project is the same as `embed` but the Python code is a separate file, `main.py`.
46-
* A separate Python file requires to start a local server to test this example (`python3 -m http.server`)
45+
* This project is the same as `embed`, but the Python code is a separate file, `main.py`.
46+
* A separate Python file requires starting a local server to test this example (`python3 -m http.server`).
4747

4848
### form
4949

@@ -54,7 +54,7 @@ Examples demonstrating how to access the DOM API starting from an app that takes
5454
### storage
5555

5656
* This example is an extension of the **form** project demonstrating how to use `localstorage` and save the data between page reload. It requires to start a local web server (`python3 -m http.server`).
57-
* The data is saved as a JSON document associated with a single key of the local storage. The performance is degrading as you add more elements in the JSON file.
57+
* The data is saved as a JSON document associated with a single key of the local storage. The performance is degraded as you add more elements in the JSON file.
5858
* This example is documented in the tutorial: https://realpython.com/brython-python-in-browser/#browser-web-api
5959

6060
### storage_perf
@@ -67,36 +67,36 @@ Examples demonstrating how to access the DOM API starting from an app that takes
6767
### hello_js
6868

6969
* Example of a JavaScript Google Chrome extension
70-
* In the tutorial https://realpython.com/brython-python-in-browser/#hello-world-extension-in-js
70+
* In the tutorial: https://realpython.com/brython-python-in-browser/#hello-world-extension-in-js
7171

7272
### hello_py
7373

7474
* Same example as hello_js using Brython
75-
* In the tutorial https://realpython.com/brython-python-in-browser/#hello-world-extension-in-python
75+
* In the tutorial: https://realpython.com/brython-python-in-browser/#hello-world-extension-in-python
7676

7777
## console
7878

7979
* Brython console as an iframe embedded in an HTML file. Does not require to run a local web server. Opening `index.html` with a browser is sufficient to test it.
80-
* This is an extra not described in the tutorial
81-
* Check out https://brython.info/console.html to see it online
80+
* This is an extra not described in the tutorial.
81+
* Check out https://brython.info/console.html to see it online.
8282

8383
## github_install
8484

85-
* `index.html` loading the Brython engine from GitHub. You can open the file directly. It only displays a message box with "Hello Real Python"
86-
* In the tutorial https://realpython.com/brython-python-in-browser/#github-install
85+
* `index.html` loading the Brython engine from GitHub. You can open the file directly. It only displays a message box with "Hello Real Python."
86+
* In the tutorial: https://realpython.com/brython-python-in-browser/#github-installation
8787

8888
## hashes
8989

90-
* In the same vein as the Base 64 encode application, this one generate the hash, SHA-1, SHA-256 or SHA-512, of a string. It adds a dropdown to select the desired algorithm (SHA-1, SHA-256, or SHA-512).
91-
* This serves as the basis for a translation to the same application with Vue.js (see **vuejs** project below)
92-
* It requires a local webserver
90+
* In the same vein as the Base64 encode application, this one generates the hash, SHA-1, SHA-256 or SHA-512, of a string. It adds a dropdown to select the desired algorithm (SHA-1, SHA-256, or SHA-512).
91+
* This serves as the basis for a translation to the same application with Vue.js (see **vuejs** project below).
92+
* It requires a local web server.
9393
* This is an extra not described in the tutorial, but serves the bases as the Vue.js example and you can read about it at https://realpython.com/brython-python-in-browser/#web-ui-framework
9494

9595
## import
9696

9797
* Shows how to import an external Python module. The external module is `functional.py`. The main Python code is embedded in the HTML page.
98-
* It requires a local webserver
99-
* Read about it in the tutorial at https://realpython.com/brython-python-in-browser/#import-in-brython
98+
* It requires a local web server.
99+
* Read about it in the tutorial: https://realpython.com/brython-python-in-browser/#import-in-brython
100100

101101
## import_js
102102

@@ -107,28 +107,28 @@ Examples demonstrating how to access the DOM API starting from an app that takes
107107

108108
## npm_install
109109

110-
* Example of a Brython project installed with `npm`. See the corresponding tutorial section for more details.
111-
* Correspond to section https://realpython.com/brython-python-in-browser/#npm-install
110+
* Example of a Brython project installed with npm. See the corresponding tutorial section for more details.
111+
* Tutorial section: https://realpython.com/brython-python-in-browser/#npm-install
112112

113113
## pip_install
114114

115-
* Example of a Brython project installed with `pip`
116-
* Tutorial section: https://realpython.com/brython-python-in-browser/#pypi-install
115+
* Example of a Brython project installed with `pip`.
116+
* Tutorial section: https://realpython.com/brython-python-in-browser/#pypi-install
117117

118118
## sha256
119119

120-
* Application to generate the SHA-256 hash of a given string. The data is stored as JSON in a key of the localstorage to preserver the calculations between page reloads.
121-
* This is an extra not described in the tutorial, but serves the bases as the Vue.js example and you can read about it at https://realpython.com/brython-python-in-browser/#web-ui-framework
120+
* Application to generate the SHA-256 hash of a given string. The data is stored as JSON in a key of the localstorage to preserve the calculations between page reloads.
121+
* This is an extra not described in the tutorial, but serves the basis of the Vue.js example. You can read about it at https://realpython.com/brython-python-in-browser/#web-ui-framework
122122

123123
## vuejs
124124

125-
* Brython and Vue.js implementation of `hashes`. Requires a local webserver to be running.
125+
* Brython and Vue.js implementation of `hashes`. Requires a local web server to be running.
126126
* The Vue.js example is documented at https://realpython.com/brython-python-in-browser/#web-ui-framework
127127

128128
## wasm
129129

130130
* An example demonstrating the generation of a WASM file, the loading of the file, and usage of the function from Brython. The source code of the WASM file is Rust.
131-
* This requires to have the Rust compiler installed on a local machine. Check the detail in the Brython tutorial. A local webserver is needed as it requires to load the wasm file.
131+
* This requires you to have the Rust compiler installed on a local machine. Check the details in the Brython tutorial. A local web server is needed as it requires loading the wasm file.
132132
* The web server can be started in the directory `wasm/op/web`. The debug wasm file is included. This is only for demonstration. The `add` function does not handle negative and big integers.
133133
* Documented in the tutorial at https://realpython.com/brython-python-in-browser/#webassembly
134134

0 commit comments

Comments
 (0)