Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit df68449

Browse filesBrowse files
authored
Improve README and and mention the community calls (#1858)
Improve the readme in two ways: - remove the mention to <py-repl>, and shows a quick summary of the various ways of running Python code - add a link to the google calendar which contains the community calls
1 parent 48e3383 commit df68449
Copy full SHA for df68449

File tree

1 file changed

+24
-5
lines changed
Filter options

1 file changed

+24
-5
lines changed

‎README.md

Copy file name to clipboardExpand all lines: README.md
+24-5Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ PyScript is a meta project that aims to combine multiple open technologies into
1616

1717
## Try PyScript
1818

19-
To try PyScript, import the appropriate pyscript files into the `<head>` tag of your html page with:
19+
To try PyScript, import the appropriate pyscript files into the `<head>` tag of your html page:
2020

2121
```html
2222
<head>
@@ -29,21 +29,40 @@ To try PyScript, import the appropriate pyscript files into the `<head>` tag of
2929
src="https://pyscript.net/releases/2023.11.1/core.js"
3030
></script>
3131
</head>
32+
<body>
33+
<script type="py" terminal>
34+
from pyscript import display
35+
display("Hello World!") # this goes to the DOM
36+
print("Hello terminal") # this goes to the terminal
37+
</script>
38+
</body>
3239
```
3340

34-
You can then use PyScript components in your html page. PyScript currently implements the following elements:
41+
You can then use PyScript components in your html page. PyScript currently offers various ways of running Python code:
3542

36-
- `<py-script>`: can be used to define python code that is executable within the web page. The element itself is not rendered to the page and is only used to add logic
37-
- `<py-repl>`: creates a REPL component that is rendered to the page as a code editor and allows users to write executable code
43+
- `<script type="py">`: can be used to define python code that is executable within the web page.
44+
- `<script type="py" src="hello.py">`: same as above, but the python source is fetched from the given URL.
45+
- `<script type="py" terminal>`: same as above, but also creates a terminal where to display stdout and stderr (e.g., the output of `print()`); `input()` does not work.
46+
- `<script type="py" terminal worker>`: run Python inside a web worker: the terminal if fully functional and `input()` works.
47+
- `<py-script>`: same as `<script type="py">`, but it is not recommended because if the code contains HTML tags, they could be parsed wrongly.
48+
- `<script type="mpy">`: same as above but use MicroPython instead of Python.
3849

39-
Check out the [the examples directory](examples) folder for more examples on how to use it, all you need to do is open them in Chrome.
50+
Check out the [official docs](https://docs.pyscript.net) for more detailed documentation.
4051

4152
## How to Contribute
4253

4354
Read the [contributing guide](CONTRIBUTING.md) to learn about our development process, reporting bugs and improvements, creating issues and asking questions.
4455

4556
Check out the [developing process](https://docs.pyscript.net/latest/contributing) documentation for more information on how to setup your development environment.
4657

58+
## Community calls and events
59+
60+
Every Tuesday at 15:30 UTC there is the _PyScript Community Call_ on zoom, where we can talk about PyScript development in the open. Most of the maintainers regularly participate in the call, and everybody is welcome to join.
61+
62+
Every other Thursday at 16:00 UTC there is the _PyScript FUN_ call: this is a call in which everybody is encouraged to show what they did with PyScript.
63+
64+
For more details on how to join the calls and up to date schedule, consult the official [Google calendar](https://calendar.google.com/calendar/u/0/embed?src=d3afdd81f9c132a8c8f3290f5cc5966adebdf61017fca784eef0f6be9fd519e0@group.calendar.google.com&ctz=Europe/Berlin) page (also available in [iCal format](https://calendar.google.com/calendar/ical/d3afdd81f9c132a8c8f3290f5cc5966adebdf61017fca784eef0f6be9fd519e0%40group.calendar.google.com/public/basic.ics)).
65+
4766
## Resources
4867

4968
- [Official docs](https://docs.pyscript.net)

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.