mirror of
https://github.com/pyscript/pyscript.git
synced 2025-12-20 10:47:35 -05:00
Compare commits
368 Commits
2022.09.1
...
fpliger/py
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
20e8c00f79 | ||
|
|
b1aa4d345b | ||
|
|
6f516ed4d1 | ||
|
|
04d117c12d | ||
|
|
579e7ab87a | ||
|
|
10e497c753 | ||
|
|
3b46609614 | ||
|
|
320ca306bd | ||
|
|
e087deef09 | ||
|
|
c3bac976c8 | ||
|
|
4c3e5fabb9 | ||
|
|
e48e6276e1 | ||
|
|
75a57a49f5 | ||
|
|
8a1db288fc | ||
|
|
84dcde188b | ||
|
|
27c91e9703 | ||
|
|
b5a0cd4057 | ||
|
|
77d8fe3562 | ||
|
|
a484aff457 | ||
|
|
c96f5912df | ||
|
|
8a01a56e51 | ||
|
|
2774e49ab9 | ||
|
|
26e7a54f1f | ||
|
|
f0e69cbc36 | ||
|
|
413428f535 | ||
|
|
0c54036466 | ||
|
|
2555833831 | ||
|
|
7e0aceced1 | ||
|
|
77234f6df3 | ||
|
|
45af96aad4 | ||
|
|
184d29055e | ||
|
|
9e73181816 | ||
|
|
0b0e03456c | ||
|
|
c6b5ce7f55 | ||
|
|
a14e701be4 | ||
|
|
7813c3f03f | ||
|
|
3a3cb7b11d | ||
|
|
d7b0731385 | ||
|
|
df8973736f | ||
|
|
9121071ba3 | ||
|
|
bf6470c046 | ||
|
|
3b7099cd3d | ||
|
|
f6dfc5361e | ||
|
|
0a7e1ce0d7 | ||
|
|
d6b1c393f6 | ||
|
|
bccd5e3750 | ||
|
|
6df5905b2b | ||
|
|
6284c02032 | ||
|
|
db27d52352 | ||
|
|
8ba28989fb | ||
|
|
da544929ac | ||
|
|
bb364b0524 | ||
|
|
818614b798 | ||
|
|
50b1a1d7c5 | ||
|
|
7d3b792a79 | ||
|
|
af72e232c3 | ||
|
|
0cdbfbeb30 | ||
|
|
339e40063a | ||
|
|
4467898473 | ||
|
|
17d16b987f | ||
|
|
8e86daac71 | ||
|
|
856720da49 | ||
|
|
8f2c150d1e | ||
|
|
7d8b4c980a | ||
|
|
932756c7a0 | ||
|
|
538aac9a28 | ||
|
|
856bf8f5fb | ||
|
|
e1758ae2e2 | ||
|
|
61b3154461 | ||
|
|
fb9b30d144 | ||
|
|
b0df96b13f | ||
|
|
a469062a32 | ||
|
|
89d5d5c7db | ||
|
|
b8c2d6b05d | ||
|
|
b247864414 | ||
|
|
d3bcd87cfa | ||
|
|
82e5b64bad | ||
|
|
73e0271c23 | ||
|
|
a2dabee0e9 | ||
|
|
6a27c6d9f2 | ||
|
|
213ced0c7f | ||
|
|
5086c23d47 | ||
|
|
ee345a5206 | ||
|
|
f74cddc3b1 | ||
|
|
5b986b8b26 | ||
|
|
14887b9814 | ||
|
|
ecc40315b3 | ||
|
|
e7aed7fcf0 | ||
|
|
cd1aa948f9 | ||
|
|
82613d016a | ||
|
|
3a66be585f | ||
|
|
0a4e36ae09 | ||
|
|
92643539cf | ||
|
|
a1281d1331 | ||
|
|
074ca0ef8f | ||
|
|
464a9633dc | ||
|
|
fc2d91c5bb | ||
|
|
d68169bffb | ||
|
|
7efdb04e1e | ||
|
|
0155e122fd | ||
|
|
eb03f16a77 | ||
|
|
5ac39641ab | ||
|
|
8d1e48e400 | ||
|
|
0021ccb49f | ||
|
|
8590c7e5b8 | ||
|
|
8c5475f78f | ||
|
|
dfa116eb70 | ||
|
|
3a9fd3c074 | ||
|
|
5a92ef3c11 | ||
|
|
d3902f5c93 | ||
|
|
c886f887ae | ||
|
|
fc5089ac59 | ||
|
|
e3602f464b | ||
|
|
f3db6a339c | ||
|
|
c05195c045 | ||
|
|
af981fc719 | ||
|
|
088a264910 | ||
|
|
d7e80ad51b | ||
|
|
b53ddd401f | ||
|
|
e9122bca9d | ||
|
|
b61e8435d1 | ||
|
|
146afb6532 | ||
|
|
854e9d1378 | ||
|
|
689878ce32 | ||
|
|
d7ab177cc5 | ||
|
|
f4c6093c47 | ||
|
|
9fedfe3699 | ||
|
|
26f07246e1 | ||
|
|
3ae4b3c4de | ||
|
|
c8f9f16791 | ||
|
|
88f0738500 | ||
|
|
03c79d5f2f | ||
|
|
e7c3b7bcfe | ||
|
|
c8becca044 | ||
|
|
543a27271f | ||
|
|
a62aba83a0 | ||
|
|
53c6cf5f45 | ||
|
|
89842e20da | ||
|
|
ef793aecf3 | ||
|
|
51d51409d3 | ||
|
|
371b5eac45 | ||
|
|
5319bd13d5 | ||
|
|
e10d055453 | ||
|
|
716254e655 | ||
|
|
4c00b1683f | ||
|
|
37c9db09c6 | ||
|
|
653e2c9be4 | ||
|
|
a2a9613da1 | ||
|
|
e8d92d0d34 | ||
|
|
755b98a8c0 | ||
|
|
13e9252260 | ||
|
|
6a9c27325a | ||
|
|
a1cb78eb85 | ||
|
|
716b57ebd3 | ||
|
|
8e231313b8 | ||
|
|
84e4e361c5 | ||
|
|
41a8d804e3 | ||
|
|
03e798a079 | ||
|
|
34a0205757 | ||
|
|
ba145f04ea | ||
|
|
22fd023635 | ||
|
|
08f34f748b | ||
|
|
7ffe6a598e | ||
|
|
71d24a445e | ||
|
|
6bcbbfb085 | ||
|
|
04fe1348d8 | ||
|
|
3033c779b0 | ||
|
|
4483f0db0f | ||
|
|
727267ae22 | ||
|
|
b5d15c2f7e | ||
|
|
589c614e57 | ||
|
|
4588e90226 | ||
|
|
8665a14dec | ||
|
|
43d598d951 | ||
|
|
68018cf078 | ||
|
|
ef4ab0d7a8 | ||
|
|
e66a2702df | ||
|
|
c57d4a7054 | ||
|
|
a36f08f0f1 | ||
|
|
760a8c75a5 | ||
|
|
740fd921e1 | ||
|
|
065c697070 | ||
|
|
e2c2459290 | ||
|
|
11c79a5344 | ||
|
|
429fe4c356 | ||
|
|
a18b4edfc0 | ||
|
|
b14a2bba5f | ||
|
|
1f825edc28 | ||
|
|
6ed834807a | ||
|
|
9a908e5fd0 | ||
|
|
4c30359b71 | ||
|
|
34dfe2d80b | ||
|
|
25bcff10b7 | ||
|
|
81268d0545 | ||
|
|
8f0a7706d7 | ||
|
|
46150f9b80 | ||
|
|
247745b7e7 | ||
|
|
94cc09b610 | ||
|
|
a210b2d5f5 | ||
|
|
12bf6db331 | ||
|
|
697ac9de9a | ||
|
|
4124bb5edc | ||
|
|
d55340a817 | ||
|
|
0de8cd9ab7 | ||
|
|
4e8281c749 | ||
|
|
357fbc644d | ||
|
|
7947a8a2dc | ||
|
|
35de3aa154 | ||
|
|
1ea687beb8 | ||
|
|
bb5c59307a | ||
|
|
5a3c414c8f | ||
|
|
cc4b460183 | ||
|
|
470c3489dd | ||
|
|
e1b4415193 | ||
|
|
77d98a565e | ||
|
|
412da2de08 | ||
|
|
dbdcd0b3d0 | ||
|
|
5c67384fbf | ||
|
|
35b0f9d377 | ||
|
|
95783bc284 | ||
|
|
4b840f7cbd | ||
|
|
f73d6cd9f2 | ||
|
|
15bb8f03ea | ||
|
|
059dbc88c9 | ||
|
|
c0f36aa047 | ||
|
|
d4120d2af3 | ||
|
|
dd1c008447 | ||
|
|
3721d2cd72 | ||
|
|
e0dda0e547 | ||
|
|
3c7568c72c | ||
|
|
6be1758548 | ||
|
|
25809660ef | ||
|
|
6b9eff45bb | ||
|
|
08e83feaf5 | ||
|
|
4f05b5afc6 | ||
|
|
9a5bf9918e | ||
|
|
1c7cf0ba7d | ||
|
|
ce2d1a4513 | ||
|
|
7d50d7eea0 | ||
|
|
e9411dc796 | ||
|
|
5cf2de16d1 | ||
|
|
e53bcf15a9 | ||
|
|
bec70b60b8 | ||
|
|
8b7fb89c68 | ||
|
|
b2bbdda73d | ||
|
|
ee2f46cfb9 | ||
|
|
4337e6833a | ||
|
|
a73c73b814 | ||
|
|
e8318a98f0 | ||
|
|
94f2ac6204 | ||
|
|
cc6cb4ded0 | ||
|
|
c61d4191c3 | ||
|
|
e284da7c09 | ||
|
|
9992096654 | ||
|
|
c696d92f40 | ||
|
|
af60299324 | ||
|
|
5aa9135a34 | ||
|
|
72e23ac86f | ||
|
|
33d49ad87d | ||
|
|
aa2335ca2e | ||
|
|
b31428006c | ||
|
|
dc1d583791 | ||
|
|
4299a74e40 | ||
|
|
3e408b7baa | ||
|
|
446c131ccb | ||
|
|
b062efcf17 | ||
|
|
30e31a86ef | ||
|
|
182272e8c7 | ||
|
|
06df21e8e3 | ||
|
|
cafebd68f2 | ||
|
|
061d4b3f72 | ||
|
|
6586e79d5e | ||
|
|
cda6c6bc7e | ||
|
|
a628026838 | ||
|
|
6700856b9f | ||
|
|
411aa0bbed | ||
|
|
0d79d31b96 | ||
|
|
cb05a9b067 | ||
|
|
536f359fb9 | ||
|
|
56e888ed33 | ||
|
|
687b93d148 | ||
|
|
0e1c396d7c | ||
|
|
7e24289703 | ||
|
|
0b23310a06 | ||
|
|
41ebaaf366 | ||
|
|
b79ceea7a8 | ||
|
|
b990bcb67a | ||
|
|
3f0f2d9910 | ||
|
|
4333f5f979 | ||
|
|
07e75293b8 | ||
|
|
a9ca7106cb | ||
|
|
da2728e6df | ||
|
|
adfa9a9b05 | ||
|
|
be9b9f66d3 | ||
|
|
9521bc7175 | ||
|
|
b445f8a834 | ||
|
|
3c3dffd5ed | ||
|
|
4c8443fd00 | ||
|
|
06a5a54103 | ||
|
|
0d3c3eef4e | ||
|
|
f0a6fb913f | ||
|
|
5f0c508fed | ||
|
|
16d9657982 | ||
|
|
40d098310e | ||
|
|
1345449d57 | ||
|
|
515858f313 | ||
|
|
2f452e9dc7 | ||
|
|
66119157a7 | ||
|
|
5b671dd1d0 | ||
|
|
1017362eec | ||
|
|
f67b8e0285 | ||
|
|
4c635fe84c | ||
|
|
68e463493e | ||
|
|
f1979d60b7 | ||
|
|
9150ebafec | ||
|
|
9543019336 | ||
|
|
1c53d91c6b | ||
|
|
4850f39b5a | ||
|
|
ab085c2d92 | ||
|
|
bf4d835948 | ||
|
|
214e39537b | ||
|
|
2d33afc195 | ||
|
|
87ea24ebd4 | ||
|
|
5380f8b9b3 | ||
|
|
00121ff8ba | ||
|
|
80e5d20e37 | ||
|
|
58f7c2137d | ||
|
|
f9194cc833 | ||
|
|
d9b8b48972 | ||
|
|
aa85f5f596 | ||
|
|
5341a0be4a | ||
|
|
0cfe20ca65 | ||
|
|
c352b502c4 | ||
|
|
58b4df6b3d | ||
|
|
29ba9436c8 | ||
|
|
2a044e88ad | ||
|
|
63092f9d72 | ||
|
|
0209324d57 | ||
|
|
1587273868 | ||
|
|
beb3aa1574 | ||
|
|
fe708c9fb4 | ||
|
|
e45d8bf973 | ||
|
|
b184c92f01 | ||
|
|
6c8afb05a7 | ||
|
|
d3dd4573cf | ||
|
|
d5cf68391a | ||
|
|
4e54e93450 | ||
|
|
e4f6387f18 | ||
|
|
54cb35b60a | ||
|
|
18ede2b729 | ||
|
|
f138b5a4f4 | ||
|
|
11a517bba4 | ||
|
|
66b57bf812 | ||
|
|
a9357bd97e | ||
|
|
d7c6d42c3d | ||
|
|
4dd1dc28b1 | ||
|
|
1e05ff7c95 | ||
|
|
e8e2e65584 | ||
|
|
3727e60152 | ||
|
|
0254012db6 | ||
|
|
8b97e4757f | ||
|
|
c70e121078 | ||
|
|
a4f97e6e46 | ||
|
|
800145a83c | ||
|
|
c75f885cb4 | ||
|
|
4011a51013 | ||
|
|
f4165dabcf | ||
|
|
de6c26eb05 |
12
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
12
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
@@ -2,7 +2,7 @@ name: Bug Report
|
|||||||
description: Create a report to help us improve
|
description: Create a report to help us improve
|
||||||
labels: ["type: bug", "needs-triage"]
|
labels: ["type: bug", "needs-triage"]
|
||||||
body:
|
body:
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
value: |
|
value: |
|
||||||
Thanks for helping PyScript! 🐍
|
Thanks for helping PyScript! 🐍
|
||||||
@@ -14,7 +14,7 @@ body:
|
|||||||
There are also already a lot of open issues, so please take 2 minutes and search through existing ones to see if what you are experiencing already exists
|
There are also already a lot of open issues, so please take 2 minutes and search through existing ones to see if what you are experiencing already exists
|
||||||
|
|
||||||
Thanks for helping PyScript be amazing. We are nothing without people like you helping build a better community 💐!
|
Thanks for helping PyScript be amazing. We are nothing without people like you helping build a better community 💐!
|
||||||
- type: checkboxes
|
- type: checkboxes
|
||||||
id: checks
|
id: checks
|
||||||
attributes:
|
attributes:
|
||||||
label: Checklist
|
label: Checklist
|
||||||
@@ -26,7 +26,7 @@ body:
|
|||||||
required: true
|
required: true
|
||||||
- label: I already searched in Google and didn't find any good information or help
|
- label: I already searched in Google and didn't find any good information or help
|
||||||
required: true
|
required: true
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: what-happened
|
id: what-happened
|
||||||
attributes:
|
attributes:
|
||||||
label: What happened?
|
label: What happened?
|
||||||
@@ -34,7 +34,7 @@ body:
|
|||||||
placeholder: Tell us what you see!
|
placeholder: Tell us what you see!
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
- type: dropdown
|
- type: dropdown
|
||||||
id: browsers
|
id: browsers
|
||||||
attributes:
|
attributes:
|
||||||
label: What browsers are you seeing the problem on? (if applicable)
|
label: What browsers are you seeing the problem on? (if applicable)
|
||||||
@@ -47,7 +47,7 @@ body:
|
|||||||
- Other
|
- Other
|
||||||
validations:
|
validations:
|
||||||
required: false
|
required: false
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: list
|
id: list
|
||||||
attributes:
|
attributes:
|
||||||
label: Console info
|
label: Console info
|
||||||
@@ -56,7 +56,7 @@ body:
|
|||||||
- Chrome , Firefox, and Edge: Right-click on the page and select *Inspect*. Alternatively you can press F12 on your keyboard.
|
- Chrome , Firefox, and Edge: Right-click on the page and select *Inspect*. Alternatively you can press F12 on your keyboard.
|
||||||
- Safari: Find instructions [here](https://support.apple.com/guide/safari/use-the-developer-tools-in-the-develop-menu-sfri20948/mac).
|
- Safari: Find instructions [here](https://support.apple.com/guide/safari/use-the-developer-tools-in-the-develop-menu-sfri20948/mac).
|
||||||
render: shell
|
render: shell
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: context
|
id: context
|
||||||
attributes:
|
attributes:
|
||||||
label: Additional Context
|
label: Additional Context
|
||||||
|
|||||||
7
.github/ISSUE_TEMPLATE/config.yml
vendored
7
.github/ISSUE_TEMPLATE/config.yml
vendored
@@ -1,5 +1,8 @@
|
|||||||
blank_issues_enabled: true
|
blank_issues_enabled: true
|
||||||
contact_links:
|
contact_links:
|
||||||
- name: Question
|
- name: Feature Proposals
|
||||||
url: https://community.anaconda.cloud/c/tech-topics/pyscript
|
url: https://github.com/pyscript/pyscript/discussions/new?category=proposals
|
||||||
|
about: Create a feature request to make PyScript even better
|
||||||
|
- name: Questions
|
||||||
|
url: https://github.com/pyscript/pyscript/discussions/new?category=q-a
|
||||||
about: For questions or discussions about pyscript
|
about: For questions or discussions about pyscript
|
||||||
|
|||||||
67
.github/ISSUE_TEMPLATE/feature-request.yml
vendored
67
.github/ISSUE_TEMPLATE/feature-request.yml
vendored
@@ -1,67 +0,0 @@
|
|||||||
name: Feature Request
|
|
||||||
description: Create a feature request to make PyScript even better
|
|
||||||
labels: ["type: enhancement", "needs-triage"]
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
### Thanks for helping PyScript! 🐍
|
|
||||||
|
|
||||||
Going through feature requests and issues takes up a lot of time, so please be so kind and take a few minutes to fill out all the areas to the best of your ability.
|
|
||||||
|
|
||||||
There will always be more great ideas than there is time to do them, and so we will need to selectively close issues that don't provide enough information, so everyone can focus our time on helping people like you who fill out the form completely. Thank you for your collaboration!
|
|
||||||
|
|
||||||
There are also already a lot of open requests, so please take 2 minutes and search through existing ones to see if your idea already exists. If you find something close, please upvote that request and comment.
|
|
||||||
|
|
||||||
Thanks for helping PyScript be amazing. We are nothing without people like you helping build a better community 💐!
|
|
||||||
|
|
||||||
### Lets make sure you are in the right place. If you have an idea/request for:
|
|
||||||
|
|
||||||
- #### A specific package/library (such as pandas or scikit learn):
|
|
||||||
|
|
||||||
Search for that respective library on github repo or website. You will have much more success there.
|
|
||||||
|
|
||||||
- #### A general Python question/feature request:
|
|
||||||
|
|
||||||
Try out a forum post [here](https://discuss.python.org/c/users/7)
|
|
||||||
|
|
||||||
- type: checkboxes
|
|
||||||
id: checks
|
|
||||||
attributes:
|
|
||||||
label: Checklist
|
|
||||||
description: Please confirm and check all the following options
|
|
||||||
options:
|
|
||||||
- label: I added a descriptive title
|
|
||||||
required: true
|
|
||||||
- label: I searched for other feature requests and couldn't find a duplicate (including also the ``type-feature`` tag)
|
|
||||||
required: true
|
|
||||||
- label: I confirmed that it's not related to another project area (see the above section)
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: request-idea
|
|
||||||
attributes:
|
|
||||||
label: What is the idea?
|
|
||||||
description: Describe what the feature is and the desired state
|
|
||||||
placeholder: This feature would allow any user of PyScript to type in a simple command in the console and show all variables currently in use
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: why
|
|
||||||
attributes:
|
|
||||||
label: Why is this needed
|
|
||||||
description: |
|
|
||||||
Who would benefit from this and why would this add value to them? What problem does this solve?
|
|
||||||
placeholder: This would benefit users who would like to see what is being used so they can learn and debug faster
|
|
||||||
- type: textarea
|
|
||||||
id: what
|
|
||||||
attributes:
|
|
||||||
label: What should happen?
|
|
||||||
description: |
|
|
||||||
What should be the user experience with the feature? Describe from a user perpective what they would do and see
|
|
||||||
placeholder: A user would type in ``PyScript debug`` in the browser console and see a list of all variables created.
|
|
||||||
- type: textarea
|
|
||||||
id: context
|
|
||||||
attributes:
|
|
||||||
label: Additional Context
|
|
||||||
description: |
|
|
||||||
Is there any other information that you think would be valuable for the team to know?
|
|
||||||
37
.github/ISSUE_TEMPLATE/misc.yml
vendored
37
.github/ISSUE_TEMPLATE/misc.yml
vendored
@@ -1,37 +0,0 @@
|
|||||||
name: Miscellaneous
|
|
||||||
description: For issues that don't belong in other categories
|
|
||||||
labels: ["type: misc", "needs-triage"]
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
Thanks for helping PyScript! 🐍
|
|
||||||
|
|
||||||
This issue is for things that doesn't make sense to put into the other issue categories and we don't want it to get lost.
|
|
||||||
|
|
||||||
Going through issues takes up a lot of time, so please be so kind and take a few minutes to fill out all the areas to the best of your ability.
|
|
||||||
|
|
||||||
There will always be more issues than there is time to do them, and so we will need to selectively close issues that don't provide enough information, so we can focus our time on helping people like you who fill out the issue form completely. Thank you for your collaboration!
|
|
||||||
|
|
||||||
There are also already a lot of open issues, so please take 2 minutes and search through existing ones to see if what you are experiencing already exists
|
|
||||||
|
|
||||||
Thanks for helping PyScript be amazing. We are nothing without people like you helping build a better community 💐!
|
|
||||||
- type: checkboxes
|
|
||||||
id: checks
|
|
||||||
attributes:
|
|
||||||
label: Checklist
|
|
||||||
description: Please confirm and check all the following options.
|
|
||||||
options:
|
|
||||||
- label: I added a descriptive title
|
|
||||||
required: true
|
|
||||||
- label: I searched for other issues and couldn't find a duplication
|
|
||||||
required: true
|
|
||||||
- label: I already searched in Google and didn't find any good information or help
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: what
|
|
||||||
attributes:
|
|
||||||
label: What is the issue/comment/problem?
|
|
||||||
description: This is a miscellaneous issue so this could be just about anything. We simply ask that you provide as many details as you can to help spur discussion or the outcome you want.
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
15
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
15
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
## Description
|
||||||
|
|
||||||
|
<!--Please describe the changes in your pull request in few words here. -->
|
||||||
|
|
||||||
|
## Changes
|
||||||
|
|
||||||
|
<!-- List the changes done to fix a bug or introduce a new feature.Please note both user-facing changes and changes to internal API's here -->
|
||||||
|
|
||||||
|
## Checklist
|
||||||
|
|
||||||
|
<!-- Note: Only user-facing changes require a changelog entry. Internal-only API changes do not require a changelog entry. Changes in documentation do not require a changelog entry. -->
|
||||||
|
|
||||||
|
- [ ] All tests pass locally
|
||||||
|
- [ ] I have updated `docs/changelog.md`
|
||||||
|
- [ ] I have created documentation for this(if applicable)
|
||||||
55
.github/workflows/build-unstable.yml
vendored
55
.github/workflows/build-unstable.yml
vendored
@@ -1,18 +1,20 @@
|
|||||||
name: '[CI] Build Unstable'
|
name: "[CI] Build Unstable"
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push: # Only run on merges into main that modify files under pyscriptjs/
|
push: # Only run on merges into main that modify files under pyscriptjs/ and examples/
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
paths:
|
paths:
|
||||||
- pyscriptjs/**
|
- pyscriptjs/**
|
||||||
- .github/workflows/build-latest.yml # Test that workflow works when changed
|
- examples/**
|
||||||
|
- .github/workflows/build-unstable.yml # Test that workflow works when changed
|
||||||
|
|
||||||
pull_request: # Run on any PR that modifies files under pyscriptjs/
|
pull_request: # Run on any PR that modifies files under pyscriptjs/ and examples/
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
paths:
|
paths:
|
||||||
- pyscriptjs/**
|
- pyscriptjs/**
|
||||||
|
- examples/**
|
||||||
- .github/workflows/build-unstable.yml # Test that workflow works when changed
|
- .github/workflows/build-unstable.yml # Test that workflow works when changed
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
|
|
||||||
@@ -26,7 +28,6 @@ jobs:
|
|||||||
MINICONDA_PYTHON_VERSION: py38
|
MINICONDA_PYTHON_VERSION: py38
|
||||||
MINICONDA_VERSION: 4.11.0
|
MINICONDA_VERSION: 4.11.0
|
||||||
steps:
|
steps:
|
||||||
|
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v3
|
uses: actions/checkout@v3
|
||||||
|
|
||||||
@@ -64,7 +65,10 @@ jobs:
|
|||||||
run: make test-py
|
run: make test-py
|
||||||
|
|
||||||
- name: Integration Tests
|
- name: Integration Tests
|
||||||
run: make test-integration
|
run: make test-integration-parallel
|
||||||
|
|
||||||
|
- name: Examples Tests
|
||||||
|
run: make test-examples
|
||||||
|
|
||||||
- uses: actions/upload-artifact@v3
|
- uses: actions/upload-artifact@v3
|
||||||
with:
|
with:
|
||||||
@@ -74,6 +78,45 @@ jobs:
|
|||||||
if-no-files-found: error
|
if-no-files-found: error
|
||||||
retention-days: 7
|
retention-days: 7
|
||||||
|
|
||||||
|
- uses: actions/upload-artifact@v3
|
||||||
|
if: success() || failure()
|
||||||
|
with:
|
||||||
|
name: test_results
|
||||||
|
path: pyscriptjs/test_results
|
||||||
|
if-no-files-found: error
|
||||||
|
eslint:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
defaults:
|
||||||
|
run:
|
||||||
|
working-directory: pyscriptjs
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Install node
|
||||||
|
uses: actions/setup-node@v3
|
||||||
|
with:
|
||||||
|
node-version: 18.x
|
||||||
|
|
||||||
|
- name: Cache node modules
|
||||||
|
uses: actions/cache@v3
|
||||||
|
env:
|
||||||
|
cache-name: cache-node-modules
|
||||||
|
with:
|
||||||
|
# npm cache files are stored in `~/.npm` on Linux/macOS
|
||||||
|
path: ~/.npm
|
||||||
|
key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
|
||||||
|
restore-keys: |
|
||||||
|
${{ runner.os }}-build-${{ env.cache-name }}-
|
||||||
|
${{ runner.os }}-build-
|
||||||
|
${{ runner.os }}-
|
||||||
|
|
||||||
|
- name: npm install
|
||||||
|
run: npm install
|
||||||
|
|
||||||
|
- name: Eslint
|
||||||
|
run: npx eslint src -c .eslintrc.js
|
||||||
|
|
||||||
Deploy:
|
Deploy:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
needs: BuildAndTest
|
needs: BuildAndTest
|
||||||
|
|||||||
18
.github/workflows/dashboard.yaml
vendored
18
.github/workflows/dashboard.yaml
vendored
@@ -1,18 +0,0 @@
|
|||||||
name: Push issue to Github Project dashboard
|
|
||||||
|
|
||||||
on:
|
|
||||||
issues:
|
|
||||||
types:
|
|
||||||
- opened
|
|
||||||
pull_request_target:
|
|
||||||
types:
|
|
||||||
- opened
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
add_to_project:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/add-to-project@v0.0.3
|
|
||||||
with:
|
|
||||||
project-url: https://github.com/orgs/pyscript/projects/4/
|
|
||||||
github-token: ${{ secrets.PROJECT_TOKEN }}
|
|
||||||
60
.github/workflows/docs-latest.yml
vendored
60
.github/workflows/docs-latest.yml
vendored
@@ -1,60 +0,0 @@
|
|||||||
name: '[Docs] Build Latest'
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
paths:
|
|
||||||
- docs/**
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
build:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
id-token: write
|
|
||||||
env:
|
|
||||||
SPHINX_HTML_BASE_URL: https://docs.pyscript.net/
|
|
||||||
steps:
|
|
||||||
|
|
||||||
- name: Checkout
|
|
||||||
uses: actions/checkout@v3
|
|
||||||
with:
|
|
||||||
persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal access token.
|
|
||||||
fetch-depth: 0 # otherwise, there would be errors pushing refs to the destination repository.
|
|
||||||
|
|
||||||
- name: Setup
|
|
||||||
uses: conda-incubator/setup-miniconda@v2
|
|
||||||
with:
|
|
||||||
auto-update-conda: true
|
|
||||||
activate-environment: docs
|
|
||||||
environment-file: docs/environment.yml
|
|
||||||
python-version: '3.9'
|
|
||||||
|
|
||||||
- name: Build
|
|
||||||
shell: bash -l {0}
|
|
||||||
run: |
|
|
||||||
cd docs/
|
|
||||||
make html
|
|
||||||
|
|
||||||
- name: Upload artifacts
|
|
||||||
uses: actions/upload-artifact@v3
|
|
||||||
with:
|
|
||||||
name: pyscript-docs-latest
|
|
||||||
path: docs/_build/html/
|
|
||||||
|
|
||||||
# Deploy to S3
|
|
||||||
- name: Configure AWS credentials
|
|
||||||
uses: aws-actions/configure-aws-credentials@v1.6.1
|
|
||||||
with:
|
|
||||||
aws-region: ${{ secrets.AWS_REGION }}
|
|
||||||
role-to-assume: ${{ secrets.AWS_OIDC_RUNNER_ROLE }}
|
|
||||||
|
|
||||||
- name: Copy redirect file
|
|
||||||
run: aws s3 cp --quiet ./docs/_build/html/_static/redirect.html s3://docs.pyscript.net/index.html
|
|
||||||
|
|
||||||
# - name: Delete latest directory
|
|
||||||
# run: aws s3 rm --recursive s3://docs.pyscript.net/latest/
|
|
||||||
|
|
||||||
- name: Sync to S3
|
|
||||||
run: aws s3 sync --quiet ./docs/_build/html/ s3://docs.pyscript.net/latest/
|
|
||||||
17
.github/workflows/docs-release.yml
vendored
17
.github/workflows/docs-release.yml
vendored
@@ -1,4 +1,4 @@
|
|||||||
name: '[Docs] Build Release'
|
name: "[Docs] Build Release"
|
||||||
|
|
||||||
on:
|
on:
|
||||||
release:
|
release:
|
||||||
@@ -13,7 +13,6 @@ jobs:
|
|||||||
env:
|
env:
|
||||||
SPHINX_HTML_BASE_URL: https://docs.pyscript.net/
|
SPHINX_HTML_BASE_URL: https://docs.pyscript.net/
|
||||||
steps:
|
steps:
|
||||||
|
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v3
|
uses: actions/checkout@v3
|
||||||
with:
|
with:
|
||||||
@@ -26,7 +25,7 @@ jobs:
|
|||||||
auto-update-conda: true
|
auto-update-conda: true
|
||||||
activate-environment: docs
|
activate-environment: docs
|
||||||
environment-file: docs/environment.yml
|
environment-file: docs/environment.yml
|
||||||
python-version: '3.9'
|
python-version: "3.9"
|
||||||
|
|
||||||
- name: Build
|
- name: Build
|
||||||
shell: bash -l {0}
|
shell: bash -l {0}
|
||||||
@@ -50,8 +49,14 @@ jobs:
|
|||||||
- name: Copy redirect file
|
- name: Copy redirect file
|
||||||
run: aws s3 cp --quiet ./docs/_build/html/_static/redirect.html s3://docs.pyscript.net/index.html
|
run: aws s3 cp --quiet ./docs/_build/html/_static/redirect.html s3://docs.pyscript.net/index.html
|
||||||
|
|
||||||
# - name: Delete release directory
|
|
||||||
# run: aws s3 rm --recursive s3://docs.pyscript.net/${{ github.ref_name }}/
|
|
||||||
|
|
||||||
- name: Sync to S3
|
- name: Sync to S3
|
||||||
run: aws s3 sync --quiet ./docs/_build/html/ s3://docs.pyscript.net/${{ github.ref_name }}/
|
run: aws s3 sync --quiet ./docs/_build/html/ s3://docs.pyscript.net/${{ github.ref_name }}/
|
||||||
|
|
||||||
|
# Make sure to remove the latest folder so we sync the full docs upon release
|
||||||
|
- name: Delete latest directory
|
||||||
|
run: aws s3 rm --recursive s3://docs.pyscript.net/latest/
|
||||||
|
|
||||||
|
# Note that the files are the same as above, but we want to have folders with
|
||||||
|
# /<tag name>/ AND /latest/ which latest will always point to the latest release
|
||||||
|
- name: Sync to /latest
|
||||||
|
run: aws s3 sync --quiet ./docs/_build/html/ s3://docs.pyscript.net/latest/
|
||||||
|
|||||||
30
.github/workflows/docs-review.yml
vendored
30
.github/workflows/docs-review.yml
vendored
@@ -1,9 +1,9 @@
|
|||||||
name: '[Docs] Build Review'
|
name: "[Docs] Build Review"
|
||||||
|
|
||||||
on:
|
on:
|
||||||
pull_request:
|
pull_request:
|
||||||
branches:
|
branches:
|
||||||
- '*'
|
- "*"
|
||||||
paths:
|
paths:
|
||||||
- docs/**
|
- docs/**
|
||||||
|
|
||||||
@@ -26,7 +26,6 @@ jobs:
|
|||||||
env:
|
env:
|
||||||
SPHINX_HTML_BASE_URL: https://docs.pyscript.net/
|
SPHINX_HTML_BASE_URL: https://docs.pyscript.net/
|
||||||
steps:
|
steps:
|
||||||
|
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v3
|
uses: actions/checkout@v3
|
||||||
with:
|
with:
|
||||||
@@ -39,7 +38,7 @@ jobs:
|
|||||||
auto-update-conda: true
|
auto-update-conda: true
|
||||||
activate-environment: docs
|
activate-environment: docs
|
||||||
environment-file: docs/environment.yml
|
environment-file: docs/environment.yml
|
||||||
python-version: '3.9'
|
python-version: "3.9"
|
||||||
|
|
||||||
- name: Build
|
- name: Build
|
||||||
shell: bash -l {0}
|
shell: bash -l {0}
|
||||||
@@ -52,26 +51,3 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
name: pyscript-docs-review-${{ github.event.number }}
|
name: pyscript-docs-review-${{ github.event.number }}
|
||||||
path: docs/_build/html/
|
path: docs/_build/html/
|
||||||
|
|
||||||
# Deploy to S3
|
|
||||||
- name: Configure AWS credentials
|
|
||||||
uses: aws-actions/configure-aws-credentials@v1.6.1
|
|
||||||
with:
|
|
||||||
aws-region: ${{ secrets.AWS_REGION }}
|
|
||||||
role-to-assume: ${{ secrets.AWS_OIDC_RUNNER_ROLE }}
|
|
||||||
|
|
||||||
- name: Copy redirect file
|
|
||||||
run: aws s3 cp --quiet ./docs/_build/html/_static/redirect.html s3://docs.pyscript.net/index.html
|
|
||||||
|
|
||||||
# - name: Delete review directory
|
|
||||||
# run: aws s3 rm --recursive s3://docs.pyscript.net/review/${{ github.event.number }}/
|
|
||||||
|
|
||||||
- name: Sync to S3
|
|
||||||
run: aws s3 sync --quiet ./docs/_build/html/ s3://docs.pyscript.net/review/${{ github.event.number }}/
|
|
||||||
|
|
||||||
- name: Adding step summary
|
|
||||||
run: |
|
|
||||||
echo "### Review documentation" >> $GITHUB_STEP_SUMMARY
|
|
||||||
echo "As with any pull request, you can find the rendered documentation version for pull request ${{ github.event.number }} here:"
|
|
||||||
echo "" >> $GITHUB_STEP_SUMMARY # this is a blank line
|
|
||||||
echo "https://docs.pyscript.net/review/${{ github.event.number }}/" >> $GITHUB_STEP_SUMMARY
|
|
||||||
|
|||||||
58
.github/workflows/docs-unstable.yml
vendored
Normal file
58
.github/workflows/docs-unstable.yml
vendored
Normal file
@@ -0,0 +1,58 @@
|
|||||||
|
name: "[Docs] Build Latest"
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
paths:
|
||||||
|
- docs/**
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
id-token: write
|
||||||
|
env:
|
||||||
|
SPHINX_HTML_BASE_URL: https://docs.pyscript.net/
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v3
|
||||||
|
with:
|
||||||
|
persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal access token.
|
||||||
|
fetch-depth: 0 # otherwise, there would be errors pushing refs to the destination repository.
|
||||||
|
|
||||||
|
- name: Setup
|
||||||
|
uses: conda-incubator/setup-miniconda@v2
|
||||||
|
with:
|
||||||
|
auto-update-conda: true
|
||||||
|
activate-environment: docs
|
||||||
|
environment-file: docs/environment.yml
|
||||||
|
python-version: "3.9"
|
||||||
|
|
||||||
|
- name: Build
|
||||||
|
shell: bash -l {0}
|
||||||
|
run: |
|
||||||
|
cd docs/
|
||||||
|
make html
|
||||||
|
|
||||||
|
- name: Upload artifacts
|
||||||
|
uses: actions/upload-artifact@v3
|
||||||
|
with:
|
||||||
|
name: pyscript-docs-latest
|
||||||
|
path: docs/_build/html/
|
||||||
|
|
||||||
|
# Deploy to S3
|
||||||
|
- name: Configure AWS credentials
|
||||||
|
uses: aws-actions/configure-aws-credentials@v1.6.1
|
||||||
|
with:
|
||||||
|
aws-region: ${{ secrets.AWS_REGION }}
|
||||||
|
role-to-assume: ${{ secrets.AWS_OIDC_RUNNER_ROLE }}
|
||||||
|
|
||||||
|
# Sync will only copy changed files
|
||||||
|
- name: Sync Error
|
||||||
|
run: aws s3 cp --quiet ./docs/_static/s3_error.html s3://docs.pyscript.net/error.html
|
||||||
|
|
||||||
|
# Sync will only copy changed files
|
||||||
|
- name: Sync to S3
|
||||||
|
run: aws s3 sync --quiet ./docs/_build/html/ s3://docs.pyscript.net/unstable/
|
||||||
9
.github/workflows/prepare-release.yml
vendored
9
.github/workflows/prepare-release.yml
vendored
@@ -1,9 +1,9 @@
|
|||||||
name: '[CI] Prepare Release'
|
name: "[CI] Prepare Release"
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
tags:
|
tags:
|
||||||
- '[0-9][0-9][0-9][0-9].[0-9][0-9].[0-9]+' # YYYY.MM.MICRO
|
- "[0-9][0-9][0-9][0-9].[0-9][0-9].[0-9]+" # YYYY.MM.MICRO
|
||||||
|
|
||||||
env:
|
env:
|
||||||
MINICONDA_PYTHON_VERSION: py38
|
MINICONDA_PYTHON_VERSION: py38
|
||||||
@@ -17,7 +17,6 @@ jobs:
|
|||||||
build:
|
build:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
|
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v3
|
uses: actions/checkout@v3
|
||||||
|
|
||||||
@@ -48,9 +47,13 @@ jobs:
|
|||||||
- name: Build and Test
|
- name: Build and Test
|
||||||
run: make test
|
run: make test
|
||||||
|
|
||||||
|
- name: Zip build folder
|
||||||
|
run: zip -r -q ./build.zip ./build
|
||||||
|
|
||||||
- name: Prepare Release
|
- name: Prepare Release
|
||||||
uses: softprops/action-gh-release@v1
|
uses: softprops/action-gh-release@v1
|
||||||
with:
|
with:
|
||||||
draft: true
|
draft: true
|
||||||
prerelease: true
|
prerelease: true
|
||||||
generate_release_notes: true
|
generate_release_notes: true
|
||||||
|
files: ./build.zip
|
||||||
|
|||||||
5
.github/workflows/publish-release.yml
vendored
5
.github/workflows/publish-release.yml
vendored
@@ -1,4 +1,4 @@
|
|||||||
name: '[CI] Publish Release'
|
name: "[CI] Publish Release"
|
||||||
|
|
||||||
on:
|
on:
|
||||||
release:
|
release:
|
||||||
@@ -57,6 +57,7 @@ jobs:
|
|||||||
role-to-assume: ${{ secrets.AWS_OIDC_RUNNER_ROLE }}
|
role-to-assume: ${{ secrets.AWS_OIDC_RUNNER_ROLE }}
|
||||||
|
|
||||||
- name: Sync to S3
|
- name: Sync to S3
|
||||||
run: | # Update /latest and create an explicitly versioned directory under releases/YYYY.MM.MICRO/
|
run:
|
||||||
|
| # Update /latest and create an explicitly versioned directory under releases/YYYY.MM.MICRO/
|
||||||
aws s3 sync --quiet ./build/ s3://pyscript.net/latest/
|
aws s3 sync --quiet ./build/ s3://pyscript.net/latest/
|
||||||
aws s3 sync --quiet ./build/ s3://pyscript.net/releases/${{ github.ref_name }}/
|
aws s3 sync --quiet ./build/ s3://pyscript.net/releases/${{ github.ref_name }}/
|
||||||
|
|||||||
4
.github/workflows/publish-snapshot.yml
vendored
4
.github/workflows/publish-snapshot.yml
vendored
@@ -1,11 +1,11 @@
|
|||||||
name: '[CI] Publish Snapshot'
|
name: "[CI] Publish Snapshot"
|
||||||
# Copy /unstable/ to /snapshots/2022.09.1.RC1/
|
# Copy /unstable/ to /snapshots/2022.09.1.RC1/
|
||||||
|
|
||||||
on:
|
on:
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
inputs:
|
inputs:
|
||||||
snapshot_version:
|
snapshot_version:
|
||||||
description: 'The calver version of this snapshot: 2022.09.1 or 2022.09.1.RC1'
|
description: "The calver version of this snapshot: 2022.09.1 or 2022.09.1.RC1"
|
||||||
type: string
|
type: string
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
|
|||||||
6
.github/workflows/sync-examples.yml
vendored
6
.github/workflows/sync-examples.yml
vendored
@@ -1,4 +1,4 @@
|
|||||||
name: '[CI] Sync Examples'
|
name: "[CI] Sync Examples"
|
||||||
|
|
||||||
on:
|
on:
|
||||||
release:
|
release:
|
||||||
@@ -15,7 +15,6 @@ jobs:
|
|||||||
working-directory: examples
|
working-directory: examples
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
|
|
||||||
# Deploy to S3
|
# Deploy to S3
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v3
|
uses: actions/checkout@v3
|
||||||
@@ -24,6 +23,7 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
aws-region: ${{ secrets.AWS_REGION }}
|
aws-region: ${{ secrets.AWS_REGION }}
|
||||||
role-to-assume: ${{ secrets.AWS_OIDC_RUNNER_ROLE }}
|
role-to-assume: ${{ secrets.AWS_OIDC_RUNNER_ROLE }}
|
||||||
- name: Sync to S3
|
- name:
|
||||||
|
Sync to S3
|
||||||
# Sync outdated or new files, delete ones no longer in source
|
# Sync outdated or new files, delete ones no longer in source
|
||||||
run: aws s3 sync --quiet --delete . s3://pyscript.net/examples/ # Sync directory, delete what is not in source
|
run: aws s3 sync --quiet --delete . s3://pyscript.net/examples/ # Sync directory, delete what is not in source
|
||||||
|
|||||||
74
.github/workflows/test-next.yml
vendored
Normal file
74
.github/workflows/test-next.yml
vendored
Normal file
@@ -0,0 +1,74 @@
|
|||||||
|
name: "[CI] Test Next"
|
||||||
|
|
||||||
|
on:
|
||||||
|
push: # Only run on merges into main that modify files under pyscriptjs/ and examples/
|
||||||
|
branches:
|
||||||
|
- next
|
||||||
|
paths:
|
||||||
|
- pyscript.core/**
|
||||||
|
- .github/workflows/test-next.yml # Test that workflow works when changed
|
||||||
|
|
||||||
|
pull_request: # Run on any PR that modifies files under pyscriptjs/ and examples/
|
||||||
|
branches:
|
||||||
|
- next
|
||||||
|
paths:
|
||||||
|
- pyscript.core/**
|
||||||
|
- .github/workflows/test-next.yml # Test that workflow works when changed
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
TestNext:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
defaults:
|
||||||
|
run:
|
||||||
|
working-directory: pyscript.core
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Install node
|
||||||
|
uses: actions/setup-node@v3
|
||||||
|
with:
|
||||||
|
node-version: 20.x
|
||||||
|
|
||||||
|
- name: Cache node modules
|
||||||
|
uses: actions/cache@v3
|
||||||
|
env:
|
||||||
|
cache-name: cache-node-modules
|
||||||
|
with:
|
||||||
|
# npm cache files are stored in `~/.npm` on Linux/macOS
|
||||||
|
path: ~/.npm
|
||||||
|
key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
|
||||||
|
restore-keys: |
|
||||||
|
${{ runner.os }}-build-${{ env.cache-name }}-
|
||||||
|
${{ runner.os }}-build-
|
||||||
|
${{ runner.os }}-
|
||||||
|
|
||||||
|
# TODO: this will likely change soon to pyscript.next
|
||||||
|
# - name: install next deps
|
||||||
|
# working-directory: pyscript.core
|
||||||
|
# run: npm i; npx playwright install
|
||||||
|
|
||||||
|
# - name: build next
|
||||||
|
# working-directory: pyscript.core
|
||||||
|
# run: npm run build
|
||||||
|
|
||||||
|
# - name: Run next tests
|
||||||
|
# working-directory: pyscript.core
|
||||||
|
# run: npm run test
|
||||||
|
|
||||||
|
# TODO: DO we want to upload next yet?
|
||||||
|
# - uses: actions/upload-artifact@v3
|
||||||
|
# with:
|
||||||
|
# name: pyscript
|
||||||
|
# path: |
|
||||||
|
# pyscriptjs/build/
|
||||||
|
# if-no-files-found: error
|
||||||
|
# retention-days: 7
|
||||||
|
|
||||||
|
# - uses: actions/upload-artifact@v3
|
||||||
|
# if: success() || failure()
|
||||||
|
# with:
|
||||||
|
# name: test_results
|
||||||
|
# path: pyscriptjs/test_results
|
||||||
|
# if-no-files-found: error
|
||||||
16
.github/workflows/test_report.yml
vendored
Normal file
16
.github/workflows/test_report.yml
vendored
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
name: Test Report
|
||||||
|
on:
|
||||||
|
workflow_run:
|
||||||
|
workflows: ['\[CI\] Build Unstable']
|
||||||
|
types:
|
||||||
|
- completed
|
||||||
|
jobs:
|
||||||
|
report:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: dorny/test-reporter@v1.6.0
|
||||||
|
with:
|
||||||
|
artifact: test_results
|
||||||
|
name: Test reports
|
||||||
|
path: "*.xml"
|
||||||
|
reporter: java-junit
|
||||||
3
.gitignore
vendored
3
.gitignore
vendored
@@ -138,3 +138,6 @@ dmypy.json
|
|||||||
node_modules/
|
node_modules/
|
||||||
|
|
||||||
coverage/
|
coverage/
|
||||||
|
|
||||||
|
# junit xml for test results
|
||||||
|
test_results
|
||||||
|
|||||||
@@ -1,90 +1,63 @@
|
|||||||
# This is the configuration for pre-commit, a local framework for managing pre-commit hooks
|
# This is the configuration for pre-commit, a local framework for managing pre-commit hooks
|
||||||
# Check out the docs at: https://pre-commit.com/
|
# Check out the docs at: https://pre-commit.com/
|
||||||
|
ci:
|
||||||
|
skip: [eslint]
|
||||||
|
autoupdate_schedule: monthly
|
||||||
|
|
||||||
default_stages: [commit]
|
default_stages: [commit]
|
||||||
repos:
|
repos:
|
||||||
- repo: https://github.com/pre-commit/pre-commit-hooks
|
- repo: https://github.com/pre-commit/pre-commit-hooks
|
||||||
rev: v4.3.0
|
rev: v4.4.0
|
||||||
hooks:
|
hooks:
|
||||||
- id: check-builtin-literals
|
- id: check-builtin-literals
|
||||||
- id: check-case-conflict
|
- id: check-case-conflict
|
||||||
- id: check-docstring-first
|
- id: check-docstring-first
|
||||||
- id: check-executables-have-shebangs
|
- id: check-executables-have-shebangs
|
||||||
- id: check-json
|
- id: check-json
|
||||||
exclude: tsconfig.json
|
exclude: tsconfig\.json
|
||||||
- id: check-toml
|
- id: check-toml
|
||||||
- id: check-xml
|
- id: check-xml
|
||||||
- id: check-yaml
|
- id: check-yaml
|
||||||
- id: detect-private-key
|
- id: detect-private-key
|
||||||
- id: end-of-file-fixer
|
- id: end-of-file-fixer
|
||||||
exclude: \.min\.js$
|
exclude: pyscript\.core/core.*|\.min\.js$
|
||||||
- id: trailing-whitespace
|
- id: trailing-whitespace
|
||||||
|
|
||||||
- repo: https://github.com/PyCQA/bandit
|
- repo: https://github.com/charliermarsh/ruff-pre-commit
|
||||||
rev: 1.7.4
|
rev: v0.0.257
|
||||||
hooks:
|
hooks:
|
||||||
- id: bandit
|
- id: ruff
|
||||||
args:
|
exclude: pyscript\.core/test|pyscript\.core/src/display.py
|
||||||
- --skip=B101,B201
|
args: [--fix]
|
||||||
|
|
||||||
- repo: https://github.com/psf/black
|
- repo: https://github.com/psf/black
|
||||||
rev: 22.8.0
|
rev: 23.1.0
|
||||||
hooks:
|
hooks:
|
||||||
- id: black
|
- id: black
|
||||||
|
|
||||||
|
- repo: https://github.com/codespell-project/codespell
|
||||||
- repo: https://github.com/codespell-project/codespell
|
rev: v2.2.4
|
||||||
rev: v2.2.1
|
|
||||||
hooks:
|
hooks:
|
||||||
- id: codespell # See 'setup.cfg' for args
|
- id: codespell # See 'pyproject.toml' for args
|
||||||
|
exclude: \.js\.map$
|
||||||
|
additional_dependencies:
|
||||||
|
- tomli
|
||||||
|
|
||||||
- repo: https://github.com/PyCQA/flake8
|
- repo: https://github.com/hoodmane/pyscript-prettier-precommit
|
||||||
rev: 5.0.4
|
rev: "v3.0.0-alpha.6"
|
||||||
hooks:
|
hooks:
|
||||||
- id: flake8 # See 'setup.cfg' for args
|
- id: prettier
|
||||||
additional_dependencies: [flake8-bugbear, flake8-comprehensions]
|
exclude: pyscript\.core/test|pyscript\.core/core.*|pyscript\.core/types/|pyscript\.sw/
|
||||||
|
args: [--tab-width, "4"]
|
||||||
|
|
||||||
- repo: https://github.com/pycqa/isort
|
- repo: https://github.com/pre-commit/mirrors-eslint
|
||||||
rev: 5.10.1
|
rev: v8.36.0
|
||||||
hooks:
|
|
||||||
- id: isort
|
|
||||||
name: isort (python)
|
|
||||||
args: [--profile, black]
|
|
||||||
|
|
||||||
- repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
|
|
||||||
rev: v2.4.0
|
|
||||||
hooks:
|
|
||||||
- id: pretty-format-yaml
|
|
||||||
args: [--autofix, --indent, '4']
|
|
||||||
exclude: .github/ISSUE_TEMPLATE/.*\.yml$
|
|
||||||
|
|
||||||
- repo: https://github.com/asottile/pyupgrade
|
|
||||||
rev: v2.38.2
|
|
||||||
hooks:
|
|
||||||
- id: pyupgrade
|
|
||||||
args:
|
|
||||||
- --py310-plus
|
|
||||||
|
|
||||||
- repo: https://github.com/pre-commit/mirrors-eslint
|
|
||||||
rev: v8.24.0
|
|
||||||
hooks:
|
hooks:
|
||||||
- id: eslint
|
- id: eslint
|
||||||
files: pyscriptjs/src/.*\.[jt]sx?$ # *.js, *.jsx, *.ts and *.tsx
|
files: pyscriptjs/src/.*\.[jt]sx?$ # *.js, *.jsx, *.ts and *.tsx
|
||||||
types: [file]
|
types: [file]
|
||||||
additional_dependencies:
|
additional_dependencies:
|
||||||
- eslint
|
- eslint@8.25.0
|
||||||
- eslint-plugin-svelte3
|
- typescript@5.0.4
|
||||||
- typescript
|
- "@typescript-eslint/eslint-plugin@5.58.0"
|
||||||
- '@typescript-eslint/eslint-plugin'
|
- "@typescript-eslint/parser@5.58.0"
|
||||||
- '@typescript-eslint/parser'
|
|
||||||
|
|
||||||
# Commented out until mdformat-myst supports custom extensions
|
|
||||||
# See https://github.com/executablebooks/mdformat-myst/pull/9
|
|
||||||
# - repo: https://github.com/executablebooks/mdformat
|
|
||||||
# rev: 0.7.14 # Use the ref you want to point at
|
|
||||||
# hooks:
|
|
||||||
# - id: mdformat
|
|
||||||
# additional_dependencies:
|
|
||||||
# - mdformat-gfm
|
|
||||||
# - mdformat-myst
|
|
||||||
# - mdformat-black
|
|
||||||
|
|||||||
5
.prettierignore
Normal file
5
.prettierignore
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
ISSUE_TEMPLATE
|
||||||
|
*.min.*
|
||||||
|
package-lock.json
|
||||||
|
docs
|
||||||
|
examples/panel.html
|
||||||
202
CONTRIBUTING.md
202
CONTRIBUTING.md
@@ -4,17 +4,24 @@ Thank you for wanting to contribute to the PyScript project!
|
|||||||
|
|
||||||
## Table of contents
|
## Table of contents
|
||||||
|
|
||||||
* [Code of Conduct](#code-of-conduct)
|
- [Contributing to PyScript](#contributing-to-pyscript)
|
||||||
* [Contributing](#contributing)
|
- [Table of contents](#table-of-contents)
|
||||||
* [Reporting bugs](#reporting-bugs)
|
- [Code of Conduct](#code-of-conduct)
|
||||||
* [Reporting security issues](#reporting-security-issues)
|
- [Contributing](#contributing)
|
||||||
* [Asking questions](#asking-questions)
|
- [Reporting bugs](#reporting-bugs)
|
||||||
* [Setting up your local environment](#setting-up-your-local-environment)
|
- [Creating useful issues](#creating-useful-issues)
|
||||||
* [Places to start](#places-to-start)
|
- [Reporting security issues](#reporting-security-issues)
|
||||||
* [Submitting a change](#submitting-a-change)
|
- [Asking questions](#asking-questions)
|
||||||
* [License terms for contributions](#license-terms-for-contributions)
|
- [Setting up your local environment and developing](#setting-up-your-local-environment-and-developing)
|
||||||
* [Becoming a maintainer](#becoming-a-maintainer)
|
- [Developing](#developing)
|
||||||
* [Trademarks](#trademarks)
|
- [Rebasing changes](#rebasing-changes)
|
||||||
|
- [Building the docs](#building-the-docs)
|
||||||
|
- [Places to start](#places-to-start)
|
||||||
|
- [Setting up your local environment and developing](#setting-up-your-local-environment-and-developing)
|
||||||
|
- [Submitting a change](#submitting-a-change)
|
||||||
|
- [License terms for contributions](#license-terms-for-contributions)
|
||||||
|
- [Becoming a maintainer](#becoming-a-maintainer)
|
||||||
|
- [Trademarks](#trademarks)
|
||||||
|
|
||||||
# Code of Conduct
|
# Code of Conduct
|
||||||
|
|
||||||
@@ -28,10 +35,10 @@ Bugs are tracked on the [project issues page](https://github.com/pyscript/pyscri
|
|||||||
|
|
||||||
## Creating useful issues
|
## Creating useful issues
|
||||||
|
|
||||||
* Use a clear and descriptive title.
|
- Use a clear and descriptive title.
|
||||||
* Describe the specific steps that reproduce the problem with as many details as possible so that someone can verify the issue.
|
- Describe the specific steps that reproduce the problem with as many details as possible so that someone can verify the issue.
|
||||||
* Describe the behavior you observed, and the behavior you had expected.
|
- Describe the behavior you observed, and the behavior you had expected.
|
||||||
* Include screenshots if they help make the issue clear.
|
- Include screenshots if they help make the issue clear.
|
||||||
|
|
||||||
## Reporting security issues
|
## Reporting security issues
|
||||||
|
|
||||||
@@ -41,173 +48,25 @@ If you aren't confident that it is appropriate to submit a security issue using
|
|||||||
|
|
||||||
If you have questions about the project, using PyScript, or anything else, please ask in the [PyScript forum](https://community.anaconda.cloud/c/tech-topics/pyscript).
|
If you have questions about the project, using PyScript, or anything else, please ask in the [PyScript forum](https://community.anaconda.cloud/c/tech-topics/pyscript).
|
||||||
|
|
||||||
## Setting up your local environment
|
|
||||||
|
|
||||||
* Fork the repository - [quicklink](https://github.com/pyscript/pyscript/fork)
|
|
||||||
|
|
||||||
* Clone your fork of the project
|
|
||||||
|
|
||||||
```
|
|
||||||
git clone https://github.com/<your username>/pyscript
|
|
||||||
```
|
|
||||||
|
|
||||||
* Add the original project as your upstream (this will allow you to pull the latest changes)
|
|
||||||
|
|
||||||
```
|
|
||||||
git remote add upstream git@github.com:pyscript/pyscript.git
|
|
||||||
```
|
|
||||||
|
|
||||||
* cd into the `pyscriptjs` folder using the line below in your terminal (if your terminal is already in pyscript then use **cd pyscriptjs** instead)
|
|
||||||
```
|
|
||||||
cd pyscript/pyscriptjs
|
|
||||||
```
|
|
||||||
* Install the dependencies with the command below
|
|
||||||
|
|
||||||
```
|
|
||||||
make setup
|
|
||||||
```
|
|
||||||
**NOTE**: If `make setup` gives a node/npm version required error then go to [troubleshooting](https://github.com/pyscript/pyscript/blob/main/TROUBLESHOOTING.md)
|
|
||||||
|
|
||||||
* You can also run the examples locally by running the command below in your terminal
|
|
||||||
```
|
|
||||||
make examples
|
|
||||||
```
|
|
||||||
* Run ***npm run dev*** to build and run the dev server. This will also watch for changes and rebuild when a file is saved.
|
|
||||||
```
|
|
||||||
npm run dev
|
|
||||||
```
|
|
||||||
**NOTE**: To access your local build paste `http://localhost:8080` into your browser
|
|
||||||
|
|
||||||
|
|
||||||
Now that node and npm have both been updated `make setup` should work, and you can continue [setting up your local environment](#setting-up-your-local-environment) without problems (hopefully).
|
|
||||||
|
|
||||||
### Developing
|
|
||||||
|
|
||||||
* First, make sure you are using the latest version of the pyscript main branch
|
|
||||||
|
|
||||||
```
|
|
||||||
git pull upstream main
|
|
||||||
```
|
|
||||||
|
|
||||||
* Update your fork with the latest changes
|
|
||||||
|
|
||||||
```
|
|
||||||
git push origin main
|
|
||||||
```
|
|
||||||
|
|
||||||
* Activate the conda environment (this environment will contain all the necessary dependencies)
|
|
||||||
|
|
||||||
```
|
|
||||||
conda activate pyscriptjs/env/
|
|
||||||
```
|
|
||||||
**NOTE**: We are assuming you are in the root folder. If you are in the pyscriptjs you can run `conda activate env/` instead.
|
|
||||||
|
|
||||||
* Install pre-commit (you only need to do this once)
|
|
||||||
|
|
||||||
```
|
|
||||||
pre-commit install
|
|
||||||
```
|
|
||||||
**NOTE**: On first run, pre-commit installs a bunch of hooks that will be run when you commit changes to your branch - this will make sure that your code is following our style (it will also lint your code automatically).
|
|
||||||
|
|
||||||
* Create a branch for the issue that you want to work on
|
|
||||||
|
|
||||||
```
|
|
||||||
git checkout -b <your branch name>
|
|
||||||
```
|
|
||||||
|
|
||||||
* Work on your change
|
|
||||||
|
|
||||||
**NOTE**: If you are working on a python file, you may encounter linting issues when pre-commit runs. Pyscript uses [black](https://black.readthedocs.io/en/stable/) to fix any linting problems automatically. All you need to do is add the changes again and commit using your previous commit message (the previous one that failed didn't complete due to black formatting files).
|
|
||||||
|
|
||||||
* Run tests before pushing the changes
|
|
||||||
|
|
||||||
```
|
|
||||||
make tests
|
|
||||||
```
|
|
||||||
|
|
||||||
* When you make changes locally, double check that your contribution follows the PyScript formatting rules by running `npm run lint`. Note that in this case you're looking for the errors, <u>**NOT**</u> the warnings (Unless the warning is created by a local change). If an error is found by lint you should fix it <u>**before**</u> creating a pull request
|
|
||||||
|
|
||||||
#### Rebasing changes
|
|
||||||
|
|
||||||
Sometimes you might be asked to rebase main into your branch. You can do such by:
|
|
||||||
|
|
||||||
* Checkout into your main branch and pull the upstream changes
|
|
||||||
|
|
||||||
```
|
|
||||||
git checkout main
|
|
||||||
git pull upstream main
|
|
||||||
```
|
|
||||||
|
|
||||||
* Checkout your branch and rebase on main
|
|
||||||
|
|
||||||
```
|
|
||||||
git rebase -i main
|
|
||||||
```
|
|
||||||
|
|
||||||
If you have conflicts, you must fix them by comparing yours and incoming changes. Your editor can probably help you with this, but do ask for help if you need it!
|
|
||||||
|
|
||||||
* Once all conflicts have been fixed
|
|
||||||
|
|
||||||
```
|
|
||||||
git rebase --continue
|
|
||||||
```
|
|
||||||
**NOTE**: You may see more conflicts that you need to address until all are resolved.
|
|
||||||
|
|
||||||
* Force push the fixed conflicts
|
|
||||||
|
|
||||||
```
|
|
||||||
git push -f origin <your branch name>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
### Building the docs
|
|
||||||
|
|
||||||
To build the documentation locally first make sure you are in the `docs` directory.
|
|
||||||
|
|
||||||
You'll need `make` and `conda` installed in your machine. The rest of the environment should be automatically download and created for you once you use the command:
|
|
||||||
|
|
||||||
```
|
|
||||||
make setup
|
|
||||||
```
|
|
||||||
|
|
||||||
Use `conda activate $environment_name` to activate your environment.
|
|
||||||
|
|
||||||
To add new information to the documentation make sure you conform with PyScript's code of conduct and with the general principles of Diataxis. Don't worry about reading too much on it, just do your best to keep your contributions on the correct axis.
|
|
||||||
|
|
||||||
Write your documentation files using [Markedly Structured Text](https://myst-parser.readthedocs.io/en/latest/syntax/optional.html), which is very similar to vanilla Markdown but with some addons to create the documentation infrastructure.
|
|
||||||
|
|
||||||
Once done, initialize a server to check your work:
|
|
||||||
|
|
||||||
```
|
|
||||||
make livehtml
|
|
||||||
```
|
|
||||||
|
|
||||||
Visible here: http:///127.0.0.1:8000
|
|
||||||
|
|
||||||
## Places to start
|
## Places to start
|
||||||
|
|
||||||
If you would like to contribute to PyScript, but you aren't sure where to begin, here are some suggestions.
|
If you would like to contribute to PyScript, but you aren't sure where to begin, here are some suggestions:
|
||||||
|
|
||||||
* **Read over the existing documentation.** Are there things missing, or could they be clearer? Make some changes/additions to those documents.
|
- **Read over the existing documentation.** Are there things missing, or could they be clearer? Make some changes/additions to those documents.
|
||||||
* **Review the open issues.** Are they clear? Can you reproduce them? You can add comments, clarifications, or additions to those issues. If you think you have an idea of how to address the issue, submit a fix!
|
- **Review the open issues.** Are they clear? Can you reproduce them? You can add comments, clarifications, or additions to those issues. If you think you have an idea of how to address the issue, submit a fix!
|
||||||
* **Look over the open pull requests.** Do you have comments or suggestions for the proposed changes? Add them.
|
- **Look over the open pull requests.** Do you have comments or suggestions for the proposed changes? Add them.
|
||||||
* **Check out the examples.** Is there a use case that would be good to have sample code for? Create an example for it.
|
- **Check out the examples.** Is there a use case that would be good to have sample code for? Create an example for it.
|
||||||
|
|
||||||
# Submitting a change
|
## Setting up your local environment and developing
|
||||||
|
|
||||||
All contributions must be licensed Apache 2.0, and all files must have a copy of the boilerplate license comment (can be copied from an existing file).
|
If you would like to contribute to PyScript, you will need to set up a local development environment. The [following instructions](https://docs.pyscript.net/latest/development/setting-up-environment.html) will help you get started.
|
||||||
|
|
||||||
To create a change for PyScript, you can follow the process described [here](https://docs.github.com/en/get-started/quickstart/contributing-to-projects).
|
You can also read about PyScript's [development process](https://docs.pyscript.net/latest/development/developing.html) to learn how to contribute code to PyScript, how to run tests and what's the PR etiquette of the community!
|
||||||
|
|
||||||
* Follow the steps in [setting your local environment](#setting-up-your-local-environment) and [developing](#developing)
|
|
||||||
* Make the changes you would like (don't forget to test them with `make test`)
|
|
||||||
* Open a pull request back to the PyScript project and address any comments/questions from the maintainers and other contributors.
|
|
||||||
|
|
||||||
## License terms for contributions
|
## License terms for contributions
|
||||||
|
|
||||||
This Project welcomes contributions, suggestions, and feedback. All contributions, suggestions, and feedback you submitted are accepted under the [Apache 2.0](./LICENSE) license. You represent that if you do not own copyright in the code that you have the authority to submit it under the [Apache 2.0](./LICENSE) license. All feedback, suggestions, or contributions are not confidential.
|
This Project welcomes contributions, suggestions, and feedback. All contributions, suggestions, and feedback you submitted are accepted under the [Apache 2.0](./LICENSE) license. You represent that if you do not own copyright in the code that you have the authority to submit it under the [Apache 2.0](./LICENSE) license. All feedback, suggestions, or contributions are not confidential.
|
||||||
|
|
||||||
|
|
||||||
## Becoming a maintainer
|
## Becoming a maintainer
|
||||||
|
|
||||||
Contributors are invited to be maintainers of the project by demonstrating good decision making in their contributions, a commitment to the goals of the project, and consistent adherence to the [code of conduct](https://github.com/pyscript/governance/blob/main/CODE-OF-CONDUCT.md). New maintainers are invited by a 3/4 vote of the existing maintainers.
|
Contributors are invited to be maintainers of the project by demonstrating good decision making in their contributions, a commitment to the goals of the project, and consistent adherence to the [code of conduct](https://github.com/pyscript/governance/blob/main/CODE-OF-CONDUCT.md). New maintainers are invited by a 3/4 vote of the existing maintainers.
|
||||||
@@ -217,5 +76,6 @@ Contributors are invited to be maintainers of the project by demonstrating good
|
|||||||
The Project abides by the Organization's [trademark policy](https://github.com/pyscript/governance/blob/main/TRADEMARKS.md).
|
The Project abides by the Organization's [trademark policy](https://github.com/pyscript/governance/blob/main/TRADEMARKS.md).
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
Part of MVG-0.1-beta.
|
Part of MVG-0.1-beta.
|
||||||
Made with love by GitHub. Licensed under the [CC-BY 4.0 License](https://creativecommons.org/licenses/by-sa/4.0/).
|
Made with love by GitHub. Licensed under the [CC-BY 4.0 License](https://creativecommons.org/licenses/by-sa/4.0/).
|
||||||
|
|||||||
@@ -41,5 +41,6 @@ Any names, trademarks, logos, or goodwill developed by and associated with the P
|
|||||||
Amendments to this governance policy may be made by affirmative vote of 2/3 of all Maintainers, with approval by the Organization's Steering Committee.
|
Amendments to this governance policy may be made by affirmative vote of 2/3 of all Maintainers, with approval by the Organization's Steering Committee.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
Part of MVG-0.1-beta.
|
Part of MVG-0.1-beta.
|
||||||
Made with love by GitHub. Licensed under the [CC-BY 4.0 License](https://creativecommons.org/licenses/by-sa/4.0/).
|
Made with love by GitHub. Licensed under the [CC-BY 4.0 License](https://creativecommons.org/licenses/by-sa/4.0/).
|
||||||
|
|||||||
@@ -9,14 +9,16 @@ This document lists the Maintainers of the Project. Maintainers may be added onc
|
|||||||
| Philipp Rudiger | Anaconda, Inc |
|
| Philipp Rudiger | Anaconda, Inc |
|
||||||
| Peter Wang | Anaconda, Inc |
|
| Peter Wang | Anaconda, Inc |
|
||||||
| Kevin Goldsmith | Anaconda, Inc |
|
| Kevin Goldsmith | Anaconda, Inc |
|
||||||
| Mariana Meireles | Anaconda, Inc |
|
| Mariana Meireles | |
|
||||||
| Nicholas H.Tollervey | Anaconda, Inc |
|
| Nicholas H.Tollervey | Anaconda, Inc |
|
||||||
| Madhur Tandon | Anaconda, Inc |
|
| Madhur Tandon | Anaconda, Inc |
|
||||||
| Ted Patrick | Anaconda, Inc |
|
| Ted Patrick | Anaconda, Inc |
|
||||||
| Jeff Glass | --- |
|
| Jeff Glass | |
|
||||||
| --- | --- |
|
| Paul Everitt | |
|
||||||
|
| Fabio Rosado | Anaconda, Inc |
|
||||||
|
| Andrea Giammarchi | Anaconda, Inc |
|
||||||
|
|
||||||
______________________________________________________________________
|
---
|
||||||
|
|
||||||
Part of MVG-0.1-beta.
|
Part of MVG-0.1-beta.
|
||||||
Made with love by GitHub. Licensed under the [CC-BY 4.0 License](https://creativecommons.org/licenses/by-sa/4.0/).
|
Made with love by GitHub. Licensed under the [CC-BY 4.0 License](https://creativecommons.org/licenses/by-sa/4.0/).
|
||||||
|
|||||||
27
README.md
27
README.md
@@ -11,21 +11,24 @@ To get started see the [getting started tutorial](docs/tutorials/getting-started
|
|||||||
For examples see [here](examples).
|
For examples see [here](examples).
|
||||||
|
|
||||||
### Longer Version
|
### Longer Version
|
||||||
|
|
||||||
PyScript is a meta project that aims to combine multiple open technologies into a framework that allows users to create sophisticated browser applications with Python. It integrates seamlessly with the way the DOM works in the browser and allows users to add Python logic in a way that feels natural both to web and Python developers.
|
PyScript is a meta project that aims to combine multiple open technologies into a framework that allows users to create sophisticated browser applications with Python. It integrates seamlessly with the way the DOM works in the browser and allows users to add Python logic in a way that feels natural both to web and Python developers.
|
||||||
|
|
||||||
## Try PyScript
|
## Try PyScript
|
||||||
|
|
||||||
To try PyScript, import the appropriate pyscript files into the ```<head>``` tag of your html page with:
|
To try PyScript, import the appropriate pyscript files into the `<head>` tag of your html page with:
|
||||||
|
|
||||||
```html
|
```html
|
||||||
<head>
|
<head>
|
||||||
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
||||||
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
</head>
|
</head>
|
||||||
```
|
```
|
||||||
|
|
||||||
You can then use PyScript components in your html page. PyScript currently implements the following elements:
|
You can then use PyScript components in your html page. PyScript currently implements the following elements:
|
||||||
|
|
||||||
* `<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
|
- `<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
|
||||||
* `<py-repl>`: creates a REPL component that is rendered to the page as a code editor and allows users to write executable code
|
- `<py-repl>`: creates a REPL component that is rendered to the page as a code editor and allows users to write executable code
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
@@ -33,16 +36,20 @@ Check out the [the examples directory](examples) folder for more examples on how
|
|||||||
|
|
||||||
Read the [contributing guide](CONTRIBUTING.md) to learn about our development process, reporting bugs and improvements, creating issues and asking questions.
|
Read the [contributing guide](CONTRIBUTING.md) to learn about our development process, reporting bugs and improvements, creating issues and asking questions.
|
||||||
|
|
||||||
|
Check out the [developing process](https://docs.pyscript.net/latest/development/developing.html) documentation for more information on how to setup your development environment.
|
||||||
|
|
||||||
## Resources
|
## Resources
|
||||||
|
|
||||||
* [Discussion board](https://community.anaconda.cloud/c/tech-topics/pyscript)
|
- [Official docs](https://docs.pyscript.net)
|
||||||
* [Home Page](https://pyscript.net/)
|
- [Discussion board](https://community.anaconda.cloud/c/tech-topics/pyscript)
|
||||||
* [Blog Post](https://engineering.anaconda.com/2022/04/welcome-pyscript.html)
|
- [Home Page](https://pyscript.net/)
|
||||||
|
- [Blog Post](https://engineering.anaconda.com/2022/04/welcome-pyscript.html)
|
||||||
|
- [Discord Channel](https://discord.gg/BYB2kvyFwm)
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
* This is an extremely experimental project, so expect things to break!
|
- This is an extremely experimental project, so expect things to break!
|
||||||
* PyScript has been only tested on Chrome at the moment.
|
- PyScript has been only tested on Chrome at the moment.
|
||||||
|
|
||||||
## Governance
|
## Governance
|
||||||
|
|
||||||
|
|||||||
@@ -3,7 +3,8 @@
|
|||||||
This page is meant for troubleshooting common problems with PyScript.
|
This page is meant for troubleshooting common problems with PyScript.
|
||||||
|
|
||||||
## Table of contents:
|
## Table of contents:
|
||||||
* [Make Setup](#make-setup)
|
|
||||||
|
- [Make Setup](#make-setup)
|
||||||
|
|
||||||
## Make setup
|
## Make setup
|
||||||
|
|
||||||
|
|||||||
@@ -30,7 +30,7 @@ shell:
|
|||||||
@export CONDA_ENV_PROMPT='<{name}>'
|
@export CONDA_ENV_PROMPT='<{name}>'
|
||||||
@echo 'conda activate $(env)'
|
@echo 'conda activate $(env)'
|
||||||
|
|
||||||
htmlserve:
|
htmlserve: html
|
||||||
@echo 'visit docs at http://localhost:8080'
|
@echo 'visit docs at http://localhost:8080'
|
||||||
python -m http.server -d "$(BUILDDIR)/html/" 8080
|
python -m http.server -d "$(BUILDDIR)/html/" 8080
|
||||||
|
|
||||||
|
|||||||
@@ -29,3 +29,26 @@ static files like templates and themes, to build the static end result.
|
|||||||
### Build
|
### Build
|
||||||
|
|
||||||
To learn how to build the docs, head over the [CONTRIBUTING](../CONTRIBUTING.md) page.
|
To learn how to build the docs, head over the [CONTRIBUTING](../CONTRIBUTING.md) page.
|
||||||
|
|
||||||
|
|
||||||
|
## Cross-referencing
|
||||||
|
|
||||||
|
You can link to other pages in the documentation by using the `{doc}` role. For example, to link to the `docs/README.md` file, you would use:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
{doc}`docs/README.md`
|
||||||
|
```
|
||||||
|
|
||||||
|
You can also cross-reference the python glossary by using the `{term}` role. For example, to link to the `iterable` term, you would use:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
{term}`iterable`
|
||||||
|
```
|
||||||
|
|
||||||
|
You can also cross-reference functions, methods or data attributes by using the `{attr}` for example:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
{py:func}`repr`
|
||||||
|
```
|
||||||
|
|
||||||
|
This would link to the `repr` function in the python builtins.
|
||||||
|
|||||||
16
docs/_static/examples/what-is-pyscript.html
vendored
16
docs/_static/examples/what-is-pyscript.html
vendored
@@ -3,6 +3,10 @@
|
|||||||
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
||||||
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
<style>
|
<style>
|
||||||
|
h1 {
|
||||||
|
color: #459db9;
|
||||||
|
}
|
||||||
|
|
||||||
.pulse {
|
.pulse {
|
||||||
animation: pulse 2s cubic-bezier(0.4, 0, 0.6, 1) infinite;
|
animation: pulse 2s cubic-bezier(0.4, 0, 0.6, 1) infinite;
|
||||||
}
|
}
|
||||||
@@ -16,10 +20,6 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
</style>
|
</style>
|
||||||
<py-env>
|
|
||||||
- numpy
|
|
||||||
- matplotlib
|
|
||||||
</py-env>
|
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body>
|
<body>
|
||||||
@@ -29,6 +29,14 @@
|
|||||||
<p style='font-family: monospace sans-serif;'><big><big><big><big>❰py❱</big></big></big></big></p>
|
<p style='font-family: monospace sans-serif;'><big><big><big><big>❰py❱</big></big></big></big></p>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<py-config>
|
||||||
|
packages = [
|
||||||
|
"numpy",
|
||||||
|
"matplotlib"
|
||||||
|
]
|
||||||
|
</py-config>
|
||||||
|
|
||||||
<py-script>
|
<py-script>
|
||||||
import matplotlib.pyplot as plt
|
import matplotlib.pyplot as plt
|
||||||
import numpy as np
|
import numpy as np
|
||||||
|
|||||||
BIN
docs/_static/images/avatar.jpg
vendored
BIN
docs/_static/images/avatar.jpg
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 11 KiB |
16
docs/_static/images/pyscript.svg
vendored
Normal file
16
docs/_static/images/pyscript.svg
vendored
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
<svg width="100%" viewBox="0 0 2057 974" xmlns="http://www.w3.org/2000/svg">
|
||||||
|
<g fill="#fda703" stroke="none" transform="translate(0 100)">
|
||||||
|
<path
|
||||||
|
d="M 1092.534 158.364 C 1095.764 169.589 1102.374 179.795 1107.224 190.364 C 1119.104 216.243 1131.874 241.728 1144.274 267.364 C 1179.204 339.56 1214.064 411.844 1248.314 484.364 C 1260.474 510.112 1273.154 535.617 1285.314 561.364 C 1290.014 571.319 1299.154 583.378 1300.684 594.364 C 1301.444 599.785 1296.944 606.478 1294.984 611.364 C 1289.004 626.289 1282.004 640.557 1273.734 654.364 C 1265.284 668.483 1256.704 683.257 1245.444 695.364 C 1237.304 704.123 1228.664 712.851 1218.534 719.31 C 1176.654 746.023 1130.104 739.811 1084.534 729.364 L 1084.534 796.364 C 1137.744 803.235 1191.744 806.988 1241.534 782.094 C 1291.224 757.25 1321.144 708.125 1345.794 660.364 C 1391.424 571.949 1425.474 477.074 1463.954 385.364 C 1484.774 335.759 1505.144 285.968 1525.954 236.364 C 1532.804 220.048 1539.454 203.643 1546.384 187.364 C 1550.314 178.14 1555.824 168.274 1557.534 158.364 L 1503.534 158.364 C 1498.104 158.364 1487.624 156.363 1482.924 159.392 C 1477.284 163.031 1474.824 176.375 1472.254 182.364 C 1463.294 203.198 1455.174 224.401 1446.524 245.364 C 1422.624 303.289 1398.764 361.248 1375.334 419.364 C 1365.024 444.923 1349.894 471.569 1343.534 498.364 L 1341.534 498.364 L 1326.784 467.364 L 1300.794 414.364 L 1219.784 248.364 L 1188.284 184.364 L 1174.894 159.392 L 1152.534 158.364 L 1092.534 158.364 Z">
|
||||||
|
</path>
|
||||||
|
<path
|
||||||
|
d="M 100.534 391.364 C 109.625 398.897 122.97 403.329 133.534 408.611 L 197.534 440.611 L 405.534 544.611 C 436.606 560.147 467.458 576.073 498.534 591.611 C 511.98 598.334 527.713 609.722 542.534 612.364 L 542.534 563.364 L 541.506 543.754 L 518.534 531.117 L 460.534 502.117 L 307.534 425.117 L 240.534 391.364 L 307.534 358.117 L 459.534 282.611 L 518.534 253.117 L 541.506 240.727 L 542.534 221.364 L 542.534 171.364 C 527.073 174.12 510.565 186.102 496.534 193.117 L 398.534 242.117 L 200.534 341.117 C 167.367 357.701 132.553 372.676 100.534 391.364 Z">
|
||||||
|
</path>
|
||||||
|
<path
|
||||||
|
d="M 1600.534 171.364 L 1600.534 220.364 C 1600.534 225.605 1598.654 235.422 1601.564 239.974 C 1605.194 245.662 1617.614 249.159 1623.534 252.117 L 1680.534 280.611 C 1730.924 305.806 1781.134 331.41 1831.534 356.611 C 1853.974 367.829 1877.404 384.412 1901.534 391.364 L 1901.534 393.364 C 1875.624 400.829 1849.674 418.049 1825.534 430.117 L 1679.534 503.117 C 1661.964 511.903 1644.564 521.567 1626.534 529.364 C 1619.964 532.203 1605.494 536.596 1601.564 542.754 C 1598.654 547.306 1600.534 557.122 1600.534 562.364 L 1600.534 612.364 L 1655.534 585.611 L 1763.534 531.611 L 1947.534 439.611 L 2041.534 392.364 C 2031.474 382.202 2012.324 376.511 1999.534 370.117 L 1907.534 324.117 L 1701.534 221.117 L 1635.534 188.117 C 1624.294 182.495 1612.624 174.847 1600.534 171.364 Z">
|
||||||
|
</path>
|
||||||
|
<path
|
||||||
|
d="M 704.534 384.364 C 704.534 374.13 702.051 360.064 705.503 350.364 C 710.589 336.071 722.183 321.459 731.164 309.364 C 737.516 300.809 743.992 292.429 750.959 284.364 C 786.81 242.863 854.576 189.488 905.519 239.403 C 931.848 265.201 939.204 301.065 941.623 336.364 C 946.631 409.413 926.04 491.22 860.534 532.928 C 811.862 563.917 757.912 556.382 704.534 545.364 Z M 705.534 259.364 L 704.534 259.364 L 704.534 158.364 L 628.534 158.364 L 628.534 789.364 L 704.534 789.364 L 704.534 613.364 C 728.157 613.38 751.915 618.29 775.534 619.325 C 816.206 621.106 857.009 614.508 893.534 596.116 C 989.069 548.011 1025.008 434.77 1024.535 335.364 C 1024.298 285.5 1013.766 232.452 979.364 194.364 C 968.209 182.013 954.851 171.287 940.534 162.816 C 875.388 124.27 794.704 158.21 745.534 207.364 C 730.887 222.007 713.84 240.114 705.534 259.364 Z">
|
||||||
|
</path>
|
||||||
|
</g>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 3.8 KiB |
4
docs/_static/s3_error.html
vendored
Normal file
4
docs/_static/s3_error.html
vendored
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
<html><head><meta http-equiv="refresh" content="5; URL='/latest/'" /></head><body>
|
||||||
|
<h1>404 - File not found</h1>
|
||||||
|
<p>You will be redirected to the latest documentation in 5 seconds.</p>
|
||||||
|
</body></html>
|
||||||
94
docs/changelog.md
Normal file
94
docs/changelog.md
Normal file
@@ -0,0 +1,94 @@
|
|||||||
|
# Release Notes
|
||||||
|
|
||||||
|
2023.XX.X
|
||||||
|
=========
|
||||||
|
|
||||||
|
|
||||||
|
Features
|
||||||
|
--------
|
||||||
|
|
||||||
|
- Added the `xterm` attribute to `py-config`. When set to `True` or `xterm`, an (output-only) [xterm.js](http://xtermjs.org/) terminal will be used in place of the default py-terminal.
|
||||||
|
- The default version of Pyodide is now `0.23.2`. See the [Pyodide Changelog](https://pyodide.org/en/stable/project/changelog.html#version-0-23-2) for a detailed list of changes.
|
||||||
|
- Added the `@when` decorator for attaching Python functions as event handlers
|
||||||
|
- The `py-mount` attribute on HTML elements has been deprecated, and will be removed in a future release.
|
||||||
|
|
||||||
|
|
||||||
|
### Runtime py- attributes
|
||||||
|
|
||||||
|
- Added logic to react to `py-*` attributes changes, removal, `py-*` attributes added to already live nodes but also `py-*` attributes added or defined via injected nodes (either appended or via `innerHTML` operations). ([#1435](https://github.com/pyscript/pyscript/pull/1435))
|
||||||
|
|
||||||
|
### <script type="py">
|
||||||
|
- Added the ability to optionally use `<script type="py">`, `<script type="pyscript">` or `<script type="py-script">` instead of a `<py-script>` custom element, in order to tackle cases where the content of the `<py-script>` tag, inevitably parsed by browsers, could accidentally contain *HTML* able to break the surrounding page layout. ([#1396](https://github.com/pyscript/pyscript/pull/1396))
|
||||||
|
|
||||||
|
### <py-terminal>
|
||||||
|
- Added a `docked` field and attribute for the `<py-terminal>` custom element, enabled by default when the terminal is in `auto` mode, and able to dock the terminal at the bottom of the page with auto scroll on new code execution.
|
||||||
|
|
||||||
|
### <py-script>
|
||||||
|
- Restored the `output` attribute of `py-script` tags to route `sys.stdout` to a DOM element with the given ID. ([#1063](https://github.com/pyscript/pyscript/pull/1063))
|
||||||
|
- Added a `stderr` attribute of `py-script` tags to route `sys.stderr` to a DOM element with the given ID. ([#1063](https://github.com/pyscript/pyscript/pull/1063))
|
||||||
|
|
||||||
|
### <py-repl>
|
||||||
|
- The `output` attribute of `py-repl` tags now specifies the id of the DOM element that `sys.stdout`, `sys.stderr`, and the results of a REPL execution are written to. It no longer affects the location of calls to `display()`
|
||||||
|
- Added a `stderr` attribute of `py-repl` tags to route `sys.stderr` to a DOM element with the given ID. ([#1106](https://github.com/pyscript/pyscript/pull/1106))
|
||||||
|
- Resored the `output-mode` attribute of `py-repl` tags. If `output-mode` == 'append', the DOM element where output is printed is _not_ cleared before writing new results.
|
||||||
|
- Load code from the attribute src of py-repl and preload it into the corresponding py-repl tag by use the attribute `str` in your `py-repl` tag([#1292](https://github.com/pyscript/pyscript/pull/1292))
|
||||||
|
|
||||||
|
### Plugins
|
||||||
|
- Plugins may now implement the `beforePyReplExec()` and `afterPyReplExec()` hooks, which are called immediately before and after code in a `py-repl` tag is executed. ([#1106](https://github.com/pyscript/pyscript/pull/1106))
|
||||||
|
|
||||||
|
### Web worker support
|
||||||
|
- introduced the new experimental `execution_thread` config option: if you set `execution_thread = "worker"`, the python interpreter runs inside a web worker
|
||||||
|
- worker support is still **very** experimental: not everything works, use it at your own risk
|
||||||
|
|
||||||
|
Bug fixes
|
||||||
|
---------
|
||||||
|
|
||||||
|
- Fixes [#1280](https://github.com/pyscript/pyscript/issues/1280), which describes the errors on the PyRepl tests related to having auto-gen tags that shouldn't be there.
|
||||||
|
|
||||||
|
Enhancements
|
||||||
|
------------
|
||||||
|
|
||||||
|
- Py-REPL tests now run on both osx and non osx OSs
|
||||||
|
- migrated from *rollup* to *esbuild* to create artifacts
|
||||||
|
- updated `@codemirror` dependency to its latest
|
||||||
|
|
||||||
|
Docs
|
||||||
|
----
|
||||||
|
|
||||||
|
- Add docs for event handlers
|
||||||
|
|
||||||
|
2023.01.1
|
||||||
|
=========
|
||||||
|
|
||||||
|
|
||||||
|
Features
|
||||||
|
--------
|
||||||
|
|
||||||
|
Bug fixes
|
||||||
|
---------
|
||||||
|
|
||||||
|
- Fixed an issue where `pyscript` would not be available when using the minified version of PyScript. ([#1054](https://github.com/pyscript/pyscript/pull/1054))
|
||||||
|
- Fixed missing closing tag when rendering an image with `display`. ([#1058](https://github.com/pyscript/pyscript/pull/1058))
|
||||||
|
- Fixed a bug where Python plugins methods were being executed twice. ([#1064](https://github.com/pyscript/pyscript/pull/1064))
|
||||||
|
|
||||||
|
Enhancements
|
||||||
|
------------
|
||||||
|
|
||||||
|
- When adding a `py-` attribute to an element but didn't added an `id` attribute, PyScript will now generate a random ID for the element instead of throwing an error which caused the splash screen to not shutdown. ([#1122](https://github.com/pyscript/pyscript/pull/1122))
|
||||||
|
- You can now disable the splashscreen by setting `enabled = false` in your `py-config` under the `[splashscreen]` configuration section. ([#1138](https://github.com/pyscript/pyscript/pull/1138))
|
||||||
|
|
||||||
|
Documentation
|
||||||
|
-------------
|
||||||
|
|
||||||
|
- Fixed 'Direct usage of document is deprecated' warning in the getting started guide. ([#1052](https://github.com/pyscript/pyscript/pull/1052))
|
||||||
|
- Added reference documentation for the `py-splashscreen` plugin ([#1138](https://github.com/pyscript/pyscript/pull/1138))
|
||||||
|
- Adds doc for installing tests ([#1156](https://github.com/pyscript/pyscript/pull/1156))
|
||||||
|
- Adds docs for custom Pyscript attributes (`py-*`) that allow you to add event listeners to an element ([#1125](https://github.com/pyscript/pyscript/pull/1125))
|
||||||
|
|
||||||
|
Deprecations and Removals
|
||||||
|
-------------------------
|
||||||
|
|
||||||
|
- The py-config `runtimes` to specify an interpreter has been deprecated. The `interpreters` config should be used instead. ([#1082](https://github.com/pyscript/pyscript/pull/1082))
|
||||||
|
- The attributes `pys-onClick` and `pys-onKeyDown` have been deprecated, but the warning was only shown in the console. An alert banner will now be shown on the page if the attributes are used. They will be removed in the next release. ([#1084](https://github.com/pyscript/pyscript/pull/1084))
|
||||||
|
- The pyscript elements `py-button`, `py-inputbox`, `py-box` and `py-title` have now completed their deprecation cycle and have been removed. ([#1084](https://github.com/pyscript/pyscript/pull/1084))
|
||||||
|
- The attributes `pys-onClick` and `pys-onKeyDown` have been removed. Use `py-click` and `py-keydown` instead ([#1361](https://github.com/pyscript/pyscript/pull/1361))
|
||||||
@@ -19,7 +19,7 @@ import os
|
|||||||
# -- Project information -----------------------------------------------------
|
# -- Project information -----------------------------------------------------
|
||||||
|
|
||||||
project = "PyScript"
|
project = "PyScript"
|
||||||
copyright = "(c) 2022, Anaconda, Inc."
|
copyright = "(c) 2023, Anaconda, Inc."
|
||||||
author = "Anaconda, Inc."
|
author = "Anaconda, Inc."
|
||||||
language = "en"
|
language = "en"
|
||||||
|
|
||||||
@@ -36,8 +36,13 @@ extensions = [
|
|||||||
"sphinx_sitemap",
|
"sphinx_sitemap",
|
||||||
"sphinxemoji.sphinxemoji",
|
"sphinxemoji.sphinxemoji",
|
||||||
"sphinxcontrib.youtube",
|
"sphinxcontrib.youtube",
|
||||||
|
"sphinx.ext.intersphinx",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
intersphinx_mapping = {
|
||||||
|
"python": ("https://docs.python.org/3.10", None),
|
||||||
|
}
|
||||||
|
|
||||||
# Add any paths that contain templates here, relative to this directory.
|
# Add any paths that contain templates here, relative to this directory.
|
||||||
templates_path = ["_templates"]
|
templates_path = ["_templates"]
|
||||||
|
|
||||||
@@ -54,7 +59,7 @@ exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "_env", "README.md"]
|
|||||||
#
|
#
|
||||||
html_theme = "pydata_sphinx_theme"
|
html_theme = "pydata_sphinx_theme"
|
||||||
|
|
||||||
html_logo = "_static/images/avatar.jpg"
|
html_logo = "_static/images/pyscript.svg"
|
||||||
|
|
||||||
# Add any paths that contain custom static files (such as style sheets) here,
|
# Add any paths that contain custom static files (such as style sheets) here,
|
||||||
# relative to this directory. They are copied after the builtin static files,
|
# relative to this directory. They are copied after the builtin static files,
|
||||||
|
|||||||
38
docs/development/deprecation-cycle.md
Normal file
38
docs/development/deprecation-cycle.md
Normal file
@@ -0,0 +1,38 @@
|
|||||||
|
# Deprecation Cycle
|
||||||
|
|
||||||
|
Pyscript is under heavy development, which means that some things may change, and some features might need to be deprecated so you can use different alternative implementations.
|
||||||
|
|
||||||
|
This page describes the deprecation cycle for pyscript.
|
||||||
|
|
||||||
|
## Deprecation Steps
|
||||||
|
|
||||||
|
1. Remove usage of deprecated features from all examples.
|
||||||
|
2. Add warnings to all elements/features marked for deprecation.
|
||||||
|
3. Release a new version of pyscript with the deprecation warnings.
|
||||||
|
4. Next release, remove the deprecated features.
|
||||||
|
|
||||||
|
## Deprecation Warnings
|
||||||
|
|
||||||
|
Deprecation warnings are added to the codebase using the `showWarning` function from the `pyscriptjs.utils` module.
|
||||||
|
|
||||||
|
This function creates a warning banner on the page if any of the deprecated features was used. You can use HTML to write the message; ideally, you should provide an alternative to the deprecated feature.
|
||||||
|
|
||||||
|
### Example
|
||||||
|
|
||||||
|
```js
|
||||||
|
import {showWarning} from './utils'
|
||||||
|
|
||||||
|
showWarning(`
|
||||||
|
<p>
|
||||||
|
The <code>py-deprecated</code> tag is deprecated. Please use the <code>py-actual</code> tag instead. Please refer to <a href="#">this documentation page</a> for more information.
|
||||||
|
</p>
|
||||||
|
`, "html")
|
||||||
|
```
|
||||||
|
|
||||||
|
## Deprecation History
|
||||||
|
|
||||||
|
This section tracks deprecations of specific features, both for historical record and to help the development team remember to actually remove deprecated features in future releases.
|
||||||
|
|
||||||
|
|Attribute/Object/Functionality|Deprecated In|Removed In|
|
||||||
|
|-|-|-|
|
||||||
|
|`py-mount` attribute | (Release following 2023.03.1) | -|
|
||||||
222
docs/development/developing.md
Normal file
222
docs/development/developing.md
Normal file
@@ -0,0 +1,222 @@
|
|||||||
|
# Development Process
|
||||||
|
|
||||||
|
This document is intended to help you get started in developing software for the PyScript project. It assumes that you have [a working development environment](setting-up-environment.md). It also assumes you have a remote named `upstream` pointing to PyScript's repository and one named `origin` pointing to your own repository.
|
||||||
|
|
||||||
|
* First, make sure you are using the latest version of the pyscript main branch
|
||||||
|
|
||||||
|
```
|
||||||
|
git pull upstream main
|
||||||
|
```
|
||||||
|
|
||||||
|
* Update your fork with the latest changes
|
||||||
|
|
||||||
|
```
|
||||||
|
git push origin main
|
||||||
|
```
|
||||||
|
|
||||||
|
* Activate the conda environment (this environment will contain all the necessary dependencies)
|
||||||
|
|
||||||
|
```
|
||||||
|
conda activate pyscriptjs/env/
|
||||||
|
```
|
||||||
|
**NOTE**: We are assuming you are in the root folder. If you are in the pyscriptjs you can run `conda activate env/` instead.
|
||||||
|
|
||||||
|
* Install pre-commit (you only need to do this once)
|
||||||
|
|
||||||
|
```
|
||||||
|
pre-commit install
|
||||||
|
```
|
||||||
|
**NOTE**: On first run, pre-commit installs a bunch of hooks that will be run when you commit changes to your branch - this will make sure that your code is following our style (it will also lint your code automatically).
|
||||||
|
|
||||||
|
* Create a branch for the issue that you want to work on
|
||||||
|
|
||||||
|
```
|
||||||
|
git checkout -b <your branch name>
|
||||||
|
```
|
||||||
|
|
||||||
|
* Work on your changes
|
||||||
|
|
||||||
|
**NOTE**: If you are working on a python file, you may encounter linting issues when pre-commit runs. Pyscript uses [black](https://black.readthedocs.io/en/stable/) to fix any linting problems automatically. All you need to do is add the changes again and commit using your previous commit message (the previous one that failed didn't complete due to black formatting files).
|
||||||
|
|
||||||
|
* Run tests before pushing the changes
|
||||||
|
|
||||||
|
```
|
||||||
|
make test
|
||||||
|
```
|
||||||
|
|
||||||
|
To learn more about tests please refer to the session [Quick guide to pytest](## Quick guide to pytest).
|
||||||
|
|
||||||
|
* When you make changes locally, double check that your contribution follows the PyScript formatting rules by running `npm run lint`. Note that in this case you're looking for the errors, <u>**NOT**</u> the warnings (Unless the warning is created by a local change). If an error is found by the linter you should fix it <u>**before**</u> creating a pull request.
|
||||||
|
|
||||||
|
#### Rebasing changes
|
||||||
|
|
||||||
|
Sometimes you might be asked to rebase the main branch into your local branch. Please refer to this [section on git rebase from GitHub docs](https://docs.github.com/en/get-started/using-git/about-git-rebase).
|
||||||
|
|
||||||
|
If you need help with anything, feel free to reach out and ask for help!
|
||||||
|
|
||||||
|
|
||||||
|
## Updating the changelog
|
||||||
|
|
||||||
|
As you work on your changes, please update the changelog file `changelog.md` with a short description of the changes you made. This will help us keep track of what has changed in each release.
|
||||||
|
|
||||||
|
You can look at the [changelog](../changelog.md) for examples on how to add your changes to the changelog. But here's a quick example:
|
||||||
|
|
||||||
|
```
|
||||||
|
2023.02.01
|
||||||
|
=========
|
||||||
|
|
||||||
|
Bug fixes
|
||||||
|
---------
|
||||||
|
|
||||||
|
- Fixed a bug that was causing the app to crash when you tried to do something #PR_NUMBER
|
||||||
|
|
||||||
|
Enhancements
|
||||||
|
------------
|
||||||
|
|
||||||
|
- Made awesome new feature #PR_NUMBER
|
||||||
|
|
||||||
|
Documentation
|
||||||
|
-------------
|
||||||
|
|
||||||
|
- Added a new section to the docs #PR_NUMBER
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
## Quick guide to pytest
|
||||||
|
|
||||||
|
We make heavy usage of `pytest`. Here is a quick guide and collection of
|
||||||
|
useful options:
|
||||||
|
|
||||||
|
- To run all tests in the current directory and subdirectories: `pytest`
|
||||||
|
|
||||||
|
- To run tests in a specific directory or file: `pytest path/to/dir/test_foo.py`
|
||||||
|
|
||||||
|
- `-s`: disables output capturing
|
||||||
|
|
||||||
|
- `--pdb`: in case of exception, enter a `(Pdb)` prompt so that you can
|
||||||
|
inspect what went wrong.
|
||||||
|
|
||||||
|
- `-v`: verbose mode
|
||||||
|
|
||||||
|
- `-x`: stop the execution as soon as one test fails
|
||||||
|
|
||||||
|
- `-k foo`: run only the tests whose full name contains `foo`
|
||||||
|
|
||||||
|
- `-k 'foo and bar'`
|
||||||
|
|
||||||
|
- `-k 'foo and not bar'`
|
||||||
|
|
||||||
|
|
||||||
|
### Running integration tests under pytest
|
||||||
|
|
||||||
|
`make test` is useful to run all the tests, but during the development is
|
||||||
|
useful to have more control on how tests are run. The following guide assumes
|
||||||
|
that you are in the directory `pyscriptjs/tests/integration/`.
|
||||||
|
|
||||||
|
#### To run all the integration tests, single or multi core
|
||||||
|
|
||||||
|
```
|
||||||
|
$ pytest -xv
|
||||||
|
...
|
||||||
|
|
||||||
|
test_00_support.py::TestSupport::test_basic[chromium] PASSED [ 0%]
|
||||||
|
test_00_support.py::TestSupport::test_console[chromium] PASSED [ 1%]
|
||||||
|
test_00_support.py::TestSupport::test_check_js_errors_simple[chromium] PASSED [ 2%]
|
||||||
|
test_00_support.py::TestSupport::test_check_js_errors_expected[chromium] PASSED [ 3%]
|
||||||
|
test_00_support.py::TestSupport::test_check_js_errors_expected_but_didnt_raise[chromium] PASSED [ 4%]
|
||||||
|
test_00_support.py::TestSupport::test_check_js_errors_multiple[chromium] PASSED [ 5%]
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
`-x` means "stop at the first failure". `-v` means "verbose", so that you can
|
||||||
|
see all the test names one by one. We try to keep tests in a reasonable order,
|
||||||
|
from most basic to most complex. This way, if you introduced some bug in very
|
||||||
|
basic things, you will notice immediately.
|
||||||
|
|
||||||
|
If you have the `pytest-xdist` plugin installed, you can run all the
|
||||||
|
integration tests on 4 cores in parallel:
|
||||||
|
```
|
||||||
|
$ pytest -n 4
|
||||||
|
```
|
||||||
|
|
||||||
|
#### To run a single test, headless
|
||||||
|
```
|
||||||
|
$ pytest test_01_basic.py -k test_pyscript_hello -s
|
||||||
|
...
|
||||||
|
[ 0.00 page.goto ] pyscript_hello.html
|
||||||
|
[ 0.01 request ] 200 - fake_server - http://fake_server/pyscript_hello.html
|
||||||
|
...
|
||||||
|
[ 0.17 console.info ] [py-loader] Downloading pyodide-x.y.z...
|
||||||
|
[ 0.18 request ] 200 - CACHED - https://cdn.jsdelivr.net/pyodide/vx.y.z/full/pyodide.js
|
||||||
|
...
|
||||||
|
[ 3.59 console.info ] [pyscript/main] PyScript page fully initialized
|
||||||
|
[ 3.60 console.log ] hello pyscript
|
||||||
|
```
|
||||||
|
|
||||||
|
`-k` selects tests by pattern matching as described above. `-s` instructs
|
||||||
|
`pytest` to show the output to the terminal instead of capturing it. In the
|
||||||
|
output you can see various useful things, including network requests and JS
|
||||||
|
console messages.
|
||||||
|
|
||||||
|
#### To run a single test, headed
|
||||||
|
```
|
||||||
|
$ pytest test_01_basic.py -k test_pyscript_hello -s --headed
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
Same as above, but with `--headed` the browser is shown in a window, and you
|
||||||
|
can interact with it. The browser uses a fake server, which means that HTTP
|
||||||
|
requests are cached.
|
||||||
|
|
||||||
|
Unfortunately, in this mode source maps does not seem to work, and you cannot
|
||||||
|
debug the original typescript source code. This seems to be a bug in
|
||||||
|
playwright, for which we have a workaround:
|
||||||
|
|
||||||
|
```
|
||||||
|
$ pytest test_01_basic.py -k test_pyscript_hello -s --headed --no-fake-server
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
As the name implies, `-no-fake-server` disables the fake server: HTTP requests
|
||||||
|
are not cached, but source-level debugging works.
|
||||||
|
|
||||||
|
Finally:
|
||||||
|
|
||||||
|
```
|
||||||
|
$ pytest test_01_basic.py -k test_pyscript_hello -s --dev
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
`--dev` implies `--headed --no-fake-server`. In addition, it also
|
||||||
|
automatically open chrome dev tools.
|
||||||
|
|
||||||
|
#### To run only main thread or worker tests
|
||||||
|
|
||||||
|
By default, we run each test twice: one with `execution_thread = "main"` and
|
||||||
|
one with `execution_thread = "worker"`. If you want to run only half of them,
|
||||||
|
you can use `-m`:
|
||||||
|
|
||||||
|
```
|
||||||
|
$ pytest -m main # run only the tests in the main thread
|
||||||
|
$ pytest -m worker # ron only the tests in the web worker
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fake server, HTTP cache
|
||||||
|
|
||||||
|
By default, our test machinery uses a playwright router which intercepts and
|
||||||
|
cache HTTP requests, so that for example you don't have to download pyodide
|
||||||
|
again and again. This also enables the possibility of running tests in
|
||||||
|
parallel on multiple cores.
|
||||||
|
|
||||||
|
The cache is stored using the `pytest-cache` plugin, which means that it
|
||||||
|
survives across sessions.
|
||||||
|
|
||||||
|
If you want to temporarily disable the cache, the easiest thing is to use
|
||||||
|
`--no-fake-server`, which bypasses it completely.
|
||||||
|
|
||||||
|
If you want to clear the cache, you can use the special option
|
||||||
|
`--clear-http-cache`:
|
||||||
|
|
||||||
|
**NOTE**: this works only if you are inside `tests/integration`, or if you
|
||||||
|
explicitly specify `tests/integration` from the command line. This is due to
|
||||||
|
how `pytest` decides to search for and load the various `conftest.py`.
|
||||||
12
docs/development/index.md
Normal file
12
docs/development/index.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# Development
|
||||||
|
|
||||||
|
This section contains various topics related to pyscript development.
|
||||||
|
|
||||||
|
```{toctree}
|
||||||
|
---
|
||||||
|
maxdepth: 1
|
||||||
|
---
|
||||||
|
setting-up-environment
|
||||||
|
deprecation-cycle
|
||||||
|
developing
|
||||||
|
```
|
||||||
285
docs/development/setting-up-environment.md
Normal file
285
docs/development/setting-up-environment.md
Normal file
@@ -0,0 +1,285 @@
|
|||||||
|
# Setting up your development environment
|
||||||
|
|
||||||
|
These steps will help you set up your development environment. We suggest completing each step before going to the next step, as some parts have dependencies on previous commands.
|
||||||
|
|
||||||
|
## Prepare your repository
|
||||||
|
|
||||||
|
* Create a fork of the [PyScript github repository](https://github.com/pyscript/pyscript/fork) to your github.
|
||||||
|
|
||||||
|
* In your development machine, clone your fork of PyScript. Use this command in your terminal.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
git clone https://github.com/<your username>/pyscript
|
||||||
|
```
|
||||||
|
|
||||||
|
* With the following command, add the original project as your upstream. This will allow you to pull the latest changes.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
git remote add upstream https://github.com/pyscript/pyscript.git
|
||||||
|
git pull upstream main
|
||||||
|
```
|
||||||
|
|
||||||
|
* If the above fails, try this alternative:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
git remote remove upstream
|
||||||
|
git remote add upstream git@github.com:pyscript/pyscript.git
|
||||||
|
git pull upstream main
|
||||||
|
```
|
||||||
|
|
||||||
|
## Install the dependencies
|
||||||
|
|
||||||
|
* change directory into `pyscriptjs` using this command:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
cd pyscript/pyscriptjs
|
||||||
|
```
|
||||||
|
|
||||||
|
We need to ensure that we have installed `conda`, `nodejs` >= 16 and `make`, before we can continue.
|
||||||
|
|
||||||
|
* Install `conda` by downloading one of the following packages that include it [MiniConda](https://docs.conda.io/en/latest/miniconda.html) or [Anaconda](https://www.anaconda.com/download/).
|
||||||
|
|
||||||
|
* Install `nodejs` with at least version 16. This can be downloaded at [https://nodejs.org](https://nodejs.org)
|
||||||
|
|
||||||
|
* Ensure that `make` is available on your system:
|
||||||
|
|
||||||
|
* *Linux*. `make` is usually installed by default in most Linux distributions. In the case it is not installed, run the terminal command `sudo apt install make`.
|
||||||
|
|
||||||
|
* *OS X*. Install Apple Developer Tools. `make` is included in this package.
|
||||||
|
|
||||||
|
* *Windows*. It is recommended to use either Windows Subsystem for Linux (WSL) or GNUWin32 for installing `make`. Instructions can be found [in this StackOverflow question](https://stackoverflow.com/questions/32127524/how-to-install-and-use-make-in-windows).
|
||||||
|
|
||||||
|
* The following command will download and install the rest of the PyScript dependencies:
|
||||||
|
|
||||||
|
```
|
||||||
|
make setup
|
||||||
|
```
|
||||||
|
|
||||||
|
* **NOTE**: If `make setup` gives an error on an incompatible version for node or npm, please refer to [troubleshooting](https://github.com/pyscript/pyscript/blob/main/TROUBLESHOOTING.md).
|
||||||
|
|
||||||
|
## Activating the environment
|
||||||
|
|
||||||
|
* After the above `make setup` command is completed, it will print out the command for activating the environment using the following format. Use this to work on the development environment:
|
||||||
|
|
||||||
|
```
|
||||||
|
conda activate <environment name>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Deactivating the environment
|
||||||
|
|
||||||
|
* To deactivate the environment, use the following command:
|
||||||
|
```
|
||||||
|
conda deactivate
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
# Running PyScript examples server
|
||||||
|
|
||||||
|
The examples server is used to view and edit the example files.
|
||||||
|
|
||||||
|
* change directory into `pyscriptjs` using this command:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
cd pyscript/pyscriptjs
|
||||||
|
```
|
||||||
|
|
||||||
|
* To build the examples, run this command:
|
||||||
|
|
||||||
|
```
|
||||||
|
make examples
|
||||||
|
```
|
||||||
|
|
||||||
|
* To serve the examples, run this command:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
python -m http.server 8080 --directory examples
|
||||||
|
```
|
||||||
|
|
||||||
|
* Alternately, you can also run this command if conda is not activated:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
conda run -p <environment name> python -m http.server 8080 --directory examples
|
||||||
|
```
|
||||||
|
|
||||||
|
* You can access the examples server by visiting the following url in your browser: [http://localhost:8080](http://localhost:8080)
|
||||||
|
|
||||||
|
|
||||||
|
# Running the PyScript development server
|
||||||
|
|
||||||
|
The PyScript development server will regularly check for any changes in the src directory. If any changes were detected, the server will rebuild itself to reflect the changes. This is useful for development with PyScript.
|
||||||
|
|
||||||
|
* change directory into `pyscriptjs` using this command:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
cd pyscript/pyscriptjs
|
||||||
|
```
|
||||||
|
|
||||||
|
* Use the following command to build and run the PyScript dev server.
|
||||||
|
|
||||||
|
```
|
||||||
|
npm run dev
|
||||||
|
```
|
||||||
|
|
||||||
|
* You can access the PyScript development server by visiting the following url in your browser: [http://localhost:8080](http://localhost:8080)
|
||||||
|
|
||||||
|
# Setting up the test environment
|
||||||
|
|
||||||
|
A key to good development is to perform tests before sending a Pull Request for your changes.
|
||||||
|
|
||||||
|
## Install the dependencies
|
||||||
|
|
||||||
|
* change directory into `pyscriptjs` using this command:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
cd pyscript/pyscriptjs
|
||||||
|
```
|
||||||
|
|
||||||
|
* The following command will download the dependencies needed for running the tests:
|
||||||
|
|
||||||
|
```
|
||||||
|
make setup
|
||||||
|
```
|
||||||
|
|
||||||
|
* If you are not using a conda environment, or wish to install the dependencies manually, here are the packages needed:
|
||||||
|
* `pillow`
|
||||||
|
* `requests`
|
||||||
|
* `numpy`
|
||||||
|
* `playwright`
|
||||||
|
* `pytest-playwright`. Note that this is only available as a `pip` package.
|
||||||
|
|
||||||
|
## Activating the environment
|
||||||
|
|
||||||
|
* After the above `make setup` command is completed, it will print out the command for activating the environment using the following format:
|
||||||
|
|
||||||
|
```
|
||||||
|
conda activate <environment name>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Deactivating the environment
|
||||||
|
|
||||||
|
* To deactivate the environment, use the following command:
|
||||||
|
```
|
||||||
|
conda deactivate
|
||||||
|
```
|
||||||
|
|
||||||
|
## Running the tests
|
||||||
|
|
||||||
|
* After setting up the test environment and while the environment is activated, you can run the tests with the following command:
|
||||||
|
|
||||||
|
```
|
||||||
|
make test
|
||||||
|
```
|
||||||
|
|
||||||
|
For more information about PyScript's testing framework, head over to the [development process](developing.md) page.
|
||||||
|
|
||||||
|
# Setting up your documentation environment
|
||||||
|
|
||||||
|
The documentation environment is separate from the development environment. It is used for updating and reviewing the documentation before deployment.
|
||||||
|
|
||||||
|
## Installing the dependencies
|
||||||
|
|
||||||
|
* change directory into the `docs` using this command:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
cd pyscript/docs
|
||||||
|
```
|
||||||
|
|
||||||
|
* The following command will download, install the dependencies, and create the environment for you:
|
||||||
|
|
||||||
|
```
|
||||||
|
make setup
|
||||||
|
```
|
||||||
|
|
||||||
|
(activating-documentation-environment)=
|
||||||
|
## Activating the environment
|
||||||
|
|
||||||
|
* After the above `make setup` command is completed, it will print out the command for activating the environment using the following format:
|
||||||
|
|
||||||
|
```
|
||||||
|
conda activate <docs environment name>
|
||||||
|
```
|
||||||
|
|
||||||
|
Note that the docs environment path is different from the developer's environment path.
|
||||||
|
|
||||||
|
## Deactivating the environment
|
||||||
|
|
||||||
|
* To deactivate the environment, use the following command:
|
||||||
|
```
|
||||||
|
conda deactivate
|
||||||
|
```
|
||||||
|
|
||||||
|
## Contributing to the documentation
|
||||||
|
|
||||||
|
* Before sending a pull request, we recommend that your documentation conforms with [PyScript's code of conduct](https://github.com/pyscript/governance/blob/main/CODE-OF-CONDUCT.md) and with the general principles of [Diataxis](https://diataxis.fr/). Don't worry about reading too much on it, just do your best to keep your contributions on the correct axis.
|
||||||
|
|
||||||
|
* Write your documentation files using [Markedly Structured Text](https://myst-parser.readthedocs.io/en/latest/syntax/optional.html). This is similar to Markdown but with some addons to create the documentation infrastructure.
|
||||||
|
|
||||||
|
## Reviewing your work
|
||||||
|
|
||||||
|
* Before sending a Pull Request, review your work by starting the documentation server. To do this, use the following command:
|
||||||
|
|
||||||
|
```
|
||||||
|
make livehtml
|
||||||
|
```
|
||||||
|
|
||||||
|
You can visit the documentation server by opening a browser and visiting [http://127.0.0.1:8000](http://127.0.0.1:8000).
|
||||||
|
|
||||||
|
* Alternately, you can open a static documentation server. Unlike the above, this will not automatically update any changes done after running this server. To see the changes done, you will need to manually stop and restart the server. To do this, use the following command:
|
||||||
|
|
||||||
|
```
|
||||||
|
make htmlserve
|
||||||
|
```
|
||||||
|
|
||||||
|
You can visit the documentation server by opening a browser and visiting [http://127.0.0.1:8080](http://127.0.0.1:8080).
|
||||||
|
|
||||||
|
* To stop either server, press `ctrl+C` or `command+C` while the shell running the command is active.
|
||||||
|
|
||||||
|
* Note: If the above make commands failed, you need to activate the documentation environment first before running any of the commands. Refer to [Activating the environment](#activating-documentation-environment) section above.
|
||||||
|
|
||||||
|
# PyScript Demonstrator
|
||||||
|
|
||||||
|
A simple webapp to demonstrate the capabilities of PyScript.
|
||||||
|
|
||||||
|
## Getting started
|
||||||
|
|
||||||
|
1. If you don't already have Node.js, install it. The official installer for the
|
||||||
|
LTS version of Node is available from [nodejs.org](https://nodejs.org/).
|
||||||
|
|
||||||
|
2. If you don't already have Rollup, install it. Rollup can be installed as a
|
||||||
|
global resource using:
|
||||||
|
|
||||||
|
$ npm install --global rollup
|
||||||
|
|
||||||
|
3. Install the demo apps requirements:
|
||||||
|
|
||||||
|
$ npm install
|
||||||
|
|
||||||
|
4. Start the server:
|
||||||
|
|
||||||
|
$ npm run dev
|
||||||
|
|
||||||
|
This will compile the resources for the app, and start the development server.
|
||||||
|
|
||||||
|
5. When the compilation completes, it will display something like:
|
||||||
|
|
||||||
|
Your application is ready~! 🚀
|
||||||
|
|
||||||
|
- Local: http://localhost:8080
|
||||||
|
- Network: Add `--host` to expose
|
||||||
|
|
||||||
|
────────────────── LOGS ──────────────────
|
||||||
|
|
||||||
|
Once this is visible, open a browser at
|
||||||
|
[http://localhost:8080](http://localhost:8080). This will provide a list of
|
||||||
|
demos that you can run.
|
||||||
|
|
||||||
|
## More information
|
||||||
|
|
||||||
|
For more information:
|
||||||
|
|
||||||
|
* [Discussion board](https://community.anaconda.cloud/c/tech-topics/pyscript)
|
||||||
|
* [Home Page](https://pyscript.net/)
|
||||||
|
* [Blog Post](https://engineering.anaconda.com/2022/04/welcome-pyscript.html)
|
||||||
|
* [Discord Channel](https://discord.gg/BYB2kvyFwm)
|
||||||
|
|
||||||
|
We use Discord as the main place for our discussions
|
||||||
@@ -10,6 +10,7 @@ dependencies:
|
|||||||
- sphinx-copybutton
|
- sphinx-copybutton
|
||||||
- sphinx-design
|
- sphinx-design
|
||||||
- sphinx-togglebutton
|
- sphinx-togglebutton
|
||||||
|
- nodejs=16
|
||||||
|
|
||||||
- pip:
|
- pip:
|
||||||
- sphinxemoji
|
- sphinxemoji
|
||||||
|
|||||||
3
docs/error.md
Normal file
3
docs/error.md
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
# Not found!
|
||||||
|
|
||||||
|
The page that you looked for could not be found. If you think this is a mistake, please [open an issue](https://github.com/pyscript/pyscript/issues/new/)
|
||||||
35
docs/guides/asyncio.md
Normal file
35
docs/guides/asyncio.md
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
# Using Async/Await and Asyncio
|
||||||
|
|
||||||
|
## {bdg-warning-line}`Deprecated` Implicit Coroutine Scheduling / Top-Level Await
|
||||||
|
|
||||||
|
In PyScript versions 2022.09.1 and earlier, \<py-script\> tags could be written in a way that enabled "Implicit Coroutine Scheduling." The keywords `await`, `async for` and `await with` were permitted to be used outside of `async` functions. Any \<py-script\> tags with these keywords at the top level were compiled into coroutines and automatically scheuled to run in the browser's event loop. This functionality was deprecated, and these keywords are no longer allowed outside of `async` functions.
|
||||||
|
|
||||||
|
To transition code from using top-level await statements to the currently-acceptable syntax, wrap the code into a coroutine using `async def()` and schedule it to run in the browser's event looping using `asyncio.ensure_future()` or `asyncio.create_task()`.
|
||||||
|
|
||||||
|
The following two pieces of code are functionally equivalent - the first only works in versions 2022.09.1, the latter is the currently acceptable equivalent.
|
||||||
|
|
||||||
|
```python
|
||||||
|
# This version is deprecated, since
|
||||||
|
# it uses 'await' outside an async function
|
||||||
|
<py-script>
|
||||||
|
import asyncio
|
||||||
|
|
||||||
|
for i in range(3):
|
||||||
|
print(i)
|
||||||
|
await asyncio.sleep(1)
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
|
|
||||||
|
```python
|
||||||
|
# This version is acceptable
|
||||||
|
<py-script>
|
||||||
|
import asyncio
|
||||||
|
|
||||||
|
async def main():
|
||||||
|
for i in range(3):
|
||||||
|
print(i)
|
||||||
|
await asyncio.sleep(1)
|
||||||
|
|
||||||
|
asyncio.ensure_future(main())
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
225
docs/guides/custom-plugins.md
Normal file
225
docs/guides/custom-plugins.md
Normal file
@@ -0,0 +1,225 @@
|
|||||||
|
# Creating custom pyscript plugins
|
||||||
|
|
||||||
|
Pyscript has a few built-in plugins, but you can also create your own ones. This guide will show you how to develop both Javascript and Python plugins.
|
||||||
|
|
||||||
|
```{warning}
|
||||||
|
Pyscript plugins are currently under active development. The API is likely to go through breaking changes between releases.
|
||||||
|
```
|
||||||
|
|
||||||
|
You can add your custom plugins to the `<py-config>` tag on your page. For example:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<py-config>
|
||||||
|
plugins = ["http://example.com/hello-world.py"]
|
||||||
|
</py-config>
|
||||||
|
```
|
||||||
|
|
||||||
|
Currently, only single files with the extension `.py` and `.js` files can be used as plugins.
|
||||||
|
|
||||||
|
## Python plugins
|
||||||
|
|
||||||
|
Python plugins allow you to write plugins in pure Python. We first need to import `Plugin` from `pyscript` and create a new instance of it.
|
||||||
|
|
||||||
|
```python
|
||||||
|
from pyscript import Plugin
|
||||||
|
|
||||||
|
plugin = Plugin("PyHelloWorld")
|
||||||
|
```
|
||||||
|
|
||||||
|
We can now create a new class containing our plugin code to add the text "Hello World" to the page.
|
||||||
|
|
||||||
|
```python
|
||||||
|
from pyscript import Plugin, js
|
||||||
|
|
||||||
|
plugin = Plugin("PyHelloWorld")
|
||||||
|
|
||||||
|
class PyHelloWorld:
|
||||||
|
def __init__(self, element):
|
||||||
|
self.element = element
|
||||||
|
|
||||||
|
|
||||||
|
def connect(self):
|
||||||
|
self.element.innerHTML = "<h1>Hello World!</h1>"
|
||||||
|
```
|
||||||
|
|
||||||
|
Let's now create our `index.html` page and add the plugin.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
||||||
|
|
||||||
|
<title>Python Plugin</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="https://pyscript.net/unstable/pyscript.css" />
|
||||||
|
<script defer src="https://pyscript.net/unstable/pyscript.js"></script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<py-config>
|
||||||
|
plugins = ["./hello-world.py"]
|
||||||
|
</py-config>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
Now we need to start a live server to serve our page. You can use Python's `http.server` module for this.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python -m http.server
|
||||||
|
```
|
||||||
|
|
||||||
|
Now you can open your browser and go to `http://localhost:8000` to see the page. You might be surprised that the text "Hello World" is not on the page. This is because we need to do a few more things to make our plugin work.
|
||||||
|
|
||||||
|
First, we must create a custom element that our plugin will use. We can use a decorator in our `PyHelloWorld` class.
|
||||||
|
|
||||||
|
```python
|
||||||
|
from pyscript import Plugin, js
|
||||||
|
|
||||||
|
plugin = Plugin("PyHelloWorld")
|
||||||
|
|
||||||
|
@plugin.register_custom_element("py-hello-world")
|
||||||
|
class PyHelloWorld:
|
||||||
|
def __init__(self, element):
|
||||||
|
self.element = element
|
||||||
|
|
||||||
|
def connect(self):
|
||||||
|
self.element.innerHTML = "<div id='hello'>Hello World!</div>"
|
||||||
|
```
|
||||||
|
|
||||||
|
Now that we have registered our custom element, we can use the custom tag `<py-hello-world>` to add our plugin to the page.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
||||||
|
|
||||||
|
<title>Python Plugin</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="https://pyscript.net/unstable/pyscript.css" />
|
||||||
|
<script defer src="https://pyscript.net/unstable/pyscript.js"></script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<py-config>
|
||||||
|
plugins = ["./hello-world.py"]
|
||||||
|
</py-config>
|
||||||
|
|
||||||
|
<py-hello-world></py-hello-world>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
Now, if you go to `http://localhost:8000` you should see the text "Hello World" on the page.
|
||||||
|
|
||||||
|
Writing plugins in Python is an excellent way if you want to use PyScript's API's. However, if you want to write plugins in Javascript, you can do that too.
|
||||||
|
|
||||||
|
## Javascript plugins
|
||||||
|
|
||||||
|
Javascript plugins need to have a specific structure to be loaded by PyScript. The plugin export a default class with the following method, which may implement any, all, or none of the [Plugin lifecycle methods](https://github.com/pyscript/pyscript/blob/main/pyscriptjs/src/plugin.ts#L9-L65). These method will be called at the corresponding points in lifecycle of PyScript as it loads, configures itself and its Python interpreter, and executes `<py-script>` and `<py-repl>` tags.
|
||||||
|
|
||||||
|
```{note}
|
||||||
|
You need to specify the file extension `.js` when adding your custom plugin to the `<py-config>` tag.
|
||||||
|
```
|
||||||
|
|
||||||
|
### Creating a Hello World plugin
|
||||||
|
|
||||||
|
Let's create a simple plugin that will add the text "Hello World" to the page. We will create a `hello-world.js` file and write the plugin class.
|
||||||
|
|
||||||
|
```js
|
||||||
|
export default class HelloWorldPlugin {
|
||||||
|
afterStartup(runtime) {
|
||||||
|
// Code goes here
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Now we need to add the code that will add the text to the page.
|
||||||
|
|
||||||
|
```js
|
||||||
|
export default class HelloWorldPlugin {
|
||||||
|
afterStartup(runtime) {
|
||||||
|
const elem = document.createElement("h1");
|
||||||
|
elem.innerText = "Hello World";
|
||||||
|
document.body.appendChild(elem);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Finally, we need to add the plugin to our page's `<py-config>` tag.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
||||||
|
|
||||||
|
<title>Javascript Plugin</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="https://pyscript.net/unstable/pyscript.css" />
|
||||||
|
<script defer src="https://pyscript.net/unstable/pyscript.js"></script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<py-config>
|
||||||
|
plugins = ["./hello-world.js"]
|
||||||
|
</py-config>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
Now we need to start a live server to serve our page. You can use Python's `http.server` module for this.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python -m http.server
|
||||||
|
```
|
||||||
|
|
||||||
|
Now you can open your browser and go to `http://localhost:8000` to see the page. You should see the text "Hello World" on the page.
|
||||||
|
|
||||||
|
```{note}
|
||||||
|
Because we are using a local file, you must start a live server. Otherwise, Pyscript will not be able to fetch the file.
|
||||||
|
```
|
||||||
|
|
||||||
|
### Expanding the Hello World plugin
|
||||||
|
|
||||||
|
As you can see, we could build all our plugin logic inside the `afterStartup` method. You may also want to create a custom html element for your plugin. Let's see how we can do that.
|
||||||
|
|
||||||
|
First, we need to create a custom html element. Let's start by creating our `PyHelloWorld` class that extends the `HTMLElement` class.
|
||||||
|
|
||||||
|
|
||||||
|
```js
|
||||||
|
class PyHelloWorld extends HTMLElement {
|
||||||
|
constructor() {
|
||||||
|
super();
|
||||||
|
}
|
||||||
|
|
||||||
|
connectedCallback() {
|
||||||
|
this.innerHTML = `<h1>Hello, world!</h1>`;
|
||||||
|
this.mount_name = this.id;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
We can now register our custom element in the `afterStartup` method of our `HelloWorldPlugin` class. We will also add the custom tag `py-hello-world` to the page.
|
||||||
|
|
||||||
|
```js
|
||||||
|
export default class HelloWorldPlugin {
|
||||||
|
afterStartup(runtime) {
|
||||||
|
// Create a custom element called <py-hello-world>
|
||||||
|
customElements.define("py-hello-world", PyHelloWorld);
|
||||||
|
|
||||||
|
// Add the custom element to the page so we can see it
|
||||||
|
const elem = document.createElement('py-hello-world');
|
||||||
|
document.body.append(elem);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Now we can open our page and see the custom element on the page.
|
||||||
|
|
||||||
|
By now, you should have a good idea for creating a custom plugin. Also, how powerful it can be to create custom elements that other users could use in their PyScript pages.
|
||||||
179
docs/guides/event-handlers.md
Normal file
179
docs/guides/event-handlers.md
Normal file
@@ -0,0 +1,179 @@
|
|||||||
|
# Event handlers in PyScript
|
||||||
|
|
||||||
|
PyScript offer two ways to subscribe to Javascript event handlers:
|
||||||
|
|
||||||
|
## Subscribe to event with `py-*` attributes
|
||||||
|
|
||||||
|
The value of the attribute contains python code which will be executed when the event is fired. A very common pattern is to call a function which does further work, for example:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<button id="noParam" py-click="say_hello_no_param()">
|
||||||
|
No Event - No Params py-click
|
||||||
|
</button>
|
||||||
|
<button id="withParam" py-click="say_hello_with_param('World')">
|
||||||
|
No Event - With Params py-click
|
||||||
|
</button>
|
||||||
|
```
|
||||||
|
|
||||||
|
```python
|
||||||
|
<py-script>
|
||||||
|
def say_hello_no_param():
|
||||||
|
print("Hello!")
|
||||||
|
|
||||||
|
def say_hello_with_param(name):
|
||||||
|
print("Hello " + name + "!")
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
|
|
||||||
|
Note that py-\* attributes need a _function call_
|
||||||
|
|
||||||
|
Supported py-\* attributes can be seen in the [PyScript API reference](<[../api-reference.md](https://github.com/pyscript/pyscript/blob/66b57bf812dcc472ed6ffee075ace5ced89bbc7c/pyscriptjs/src/components/pyscript.ts#L119-L260)>).
|
||||||
|
|
||||||
|
## Subscribe to event with `addEventListener`
|
||||||
|
|
||||||
|
You can also subscribe to an event using the `addEventListener` method of the DOM element. This is useful if you want to pass event object to the event handler.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<button id="two">add_event_listener passes event</button>
|
||||||
|
```
|
||||||
|
|
||||||
|
```python
|
||||||
|
<py-script>
|
||||||
|
from js import console, document
|
||||||
|
from pyodide.ffi.wrappers import add_event_listener
|
||||||
|
|
||||||
|
def hello_args(*args):
|
||||||
|
console.log(f"Hi! I got some args! {args}")
|
||||||
|
|
||||||
|
add_event_listener(document.getElementById("two"), "click", hello_args)
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
|
|
||||||
|
or using the `addEventListener` method of the DOM element:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<button id="three">add_event_listener passes event</button>
|
||||||
|
```
|
||||||
|
|
||||||
|
```python
|
||||||
|
<py-script>
|
||||||
|
from js import console, document
|
||||||
|
from pyodide.ffi import create_proxy
|
||||||
|
|
||||||
|
def hello_args(*args):
|
||||||
|
console.log(f"Hi! I got some args! {args}")
|
||||||
|
|
||||||
|
document.getElementById("three").addEventListener("click", create_proxy(hello_args))
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
|
|
||||||
|
or using the PyScript Element class:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<button id="four">add_event_listener passes event</button>
|
||||||
|
```
|
||||||
|
|
||||||
|
```python
|
||||||
|
<py-script>
|
||||||
|
from js import console
|
||||||
|
from pyodide.ffi import create_proxy
|
||||||
|
|
||||||
|
def hello_args(*args):
|
||||||
|
console.log(f"Hi! I got some args! {args}")
|
||||||
|
|
||||||
|
Element("four").element.addEventListener("click", create_proxy(hello_args))
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
|
|
||||||
|
## JavaScript to PyScript and From PyScript to JavaScript
|
||||||
|
|
||||||
|
If you're wondering about how to pass objects from JavaScript to PyScript and/or the other way around head over to the [Passing Objects](passing-objects.md) page.
|
||||||
|
|
||||||
|
|
||||||
|
### Exporting all Global Python Objects
|
||||||
|
|
||||||
|
We can use our new `createObject` function to "export" the entire Python global object dictionary as a JavaScript object:
|
||||||
|
|
||||||
|
```python
|
||||||
|
<py-script>
|
||||||
|
from js import createObject
|
||||||
|
from pyodide.ffi import create_proxy
|
||||||
|
createObject(create_proxy(globals()), "pyodideGlobals")
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
|
|
||||||
|
This will make all Python global variables available in JavaScript with `pyodideGlobals.get('my_variable_name')`.
|
||||||
|
|
||||||
|
(Since PyScript tags evaluate _after_ all JavaScript on the page, we can't just dump a `console.log(...)` into a `<script>` tag, since that tag will evaluate before any PyScript has a chance to. We need to delay accessing the Python variable in JavaScript until after the Python code has a chance to run. The following example uses a button with `id="do-math"` to achieve this, but any method would be valid.)
|
||||||
|
|
||||||
|
```python
|
||||||
|
<py-script>
|
||||||
|
# create some Python objects:
|
||||||
|
symbols = {'pi': 3.1415926, 'e': 2.7182818}
|
||||||
|
|
||||||
|
def rough_exponential(x):
|
||||||
|
return symbols['e']**x
|
||||||
|
|
||||||
|
class Circle():
|
||||||
|
def __init__(self, radius):
|
||||||
|
self.radius = radius
|
||||||
|
|
||||||
|
@property
|
||||||
|
def area:
|
||||||
|
return symbols['pi'] * self.radius**2
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
|
|
||||||
|
```html
|
||||||
|
<input type="button" value="Log Python Variables" id="do-mmath" />
|
||||||
|
<script>
|
||||||
|
document.getElementById("do-math").addEventListener("click", () => {
|
||||||
|
const exp = pyodideGlobals.get("rough_exponential");
|
||||||
|
console.log("e squared is about ${exp(2)}");
|
||||||
|
const c = pyodideGlobals.get("Circle")(4);
|
||||||
|
console.log("The area of c is ${c.area}");
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
```
|
||||||
|
|
||||||
|
### Exporting Individual Python Objects
|
||||||
|
|
||||||
|
We can also export individual Python objects to the JavaScript global scope if we wish.
|
||||||
|
|
||||||
|
(As above, the following example uses a button to delay the execution of the `<script>` until after the PyScript has run.)
|
||||||
|
|
||||||
|
```python
|
||||||
|
<py-script>
|
||||||
|
import js
|
||||||
|
from pyodide.ffi import create_proxy
|
||||||
|
|
||||||
|
# Create 3 python objects
|
||||||
|
language = "Python 3"
|
||||||
|
animals = ['dog', 'cat', 'bird']
|
||||||
|
multiply3 = lambda a, b, c: a * b * c
|
||||||
|
|
||||||
|
# js object can be named the same as Python objects...
|
||||||
|
js.createObject(language, "language")
|
||||||
|
|
||||||
|
# ...but don't have to be
|
||||||
|
js.createObject(create_proxy(animals), "animals_from_py")
|
||||||
|
|
||||||
|
# functions are objects too, in both Python and Javascript
|
||||||
|
js.createObject(create_proxy(multiply3), "multiply")
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
|
|
||||||
|
```html
|
||||||
|
<input type="button" value="Log Python Variables" id="log-python-variables" />
|
||||||
|
<script>
|
||||||
|
document
|
||||||
|
.getElementById("log-python-variables")
|
||||||
|
.addEventListener("click", () => {
|
||||||
|
console.log(`Nice job using ${language}`);
|
||||||
|
for (const animal of animals_from_py) {
|
||||||
|
console.log(`Do you like ${animal}s? `);
|
||||||
|
}
|
||||||
|
console.log(`2 times 3 times 4 is ${multiply(2, 3, 4)}`);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
```
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
# How to make HTTP requests using `PyScript`, in pure Python
|
# How to make HTTP requests using `PyScript`, in pure Python
|
||||||
|
|
||||||
[Pyodide](https://pyodide.org), the runtime that underlies `PyScript`, does not have the `requests` module
|
[Pyodide](https://pyodide.org), the interpreter that underlies `PyScript`, does not have the `requests` module
|
||||||
(or other similar modules) available by default, which are traditionally used to make HTTP requests in Python.
|
(or other similar modules) available by default, which are traditionally used to make HTTP requests in Python.
|
||||||
However, it is possible to make HTTP requests in Pyodide using the modern `JavaScript` `fetch` API
|
However, it is possible to make HTTP requests in Pyodide using the modern `JavaScript` `fetch` API
|
||||||
([docs](https://developer.mozilla.org/en-US/docs/Web/API/fetch)). This example shows how to make common HTTP request
|
([docs](https://developer.mozilla.org/en-US/docs/Web/API/fetch)). This example shows how to make common HTTP request
|
||||||
@@ -14,14 +14,18 @@ from `PyScript` using Python, since currently, the common tools such as `request
|
|||||||
|
|
||||||
The `fetch` API is a modern way to make HTTP requests. It is available in all modern browsers, and in Pyodide.
|
The `fetch` API is a modern way to make HTTP requests. It is available in all modern browsers, and in Pyodide.
|
||||||
|
|
||||||
Although there are two ways to use `fetch`, 1) using `JavaScript` from `PyScript`, and 2) using Pyodide's Python wrapper,
|
Although there are two ways to use `fetch`:
|
||||||
`Pyodide.http.pyfetch`, this example will only show how to use the Python wrapper. Still, the
|
1) using `JavaScript` from `PyScript`
|
||||||
|
2) using Pyodide's Python wrapper,
|
||||||
|
`pyodide.http.pyfetch`
|
||||||
|
|
||||||
|
This example will only show how to use the Python wrapper. Still, the
|
||||||
[fetch documentation](https://developer.mozilla.org/en-US/docs/Web/API/fetch#parameters) is a useful reference, as its
|
[fetch documentation](https://developer.mozilla.org/en-US/docs/Web/API/fetch#parameters) is a useful reference, as its
|
||||||
parameters can be called from Python using the `pyfetch` wrapper.
|
parameters can be called from Python using the `pyfetch` wrapper.
|
||||||
|
|
||||||
## Pyodide.http, pyfetch, and FetchResponse
|
## Pyodide.http, pyfetch, and FetchResponse
|
||||||
|
|
||||||
[Pyodide.http module](https://pyodide.org/en/stable/usage/api/python-api/http.html#module-pyodide.http) is a Python API
|
The [pyodide.http module](https://pyodide.org/en/stable/usage/api/python-api/http.html#module-pyodide.http) is a Python API
|
||||||
for dealing with HTTP requests. It provides the `pyfetch` function as a wrapper for the `fetch` API,
|
for dealing with HTTP requests. It provides the `pyfetch` function as a wrapper for the `fetch` API,
|
||||||
which returns a `FetchResponse` object whenever a request is made. Extra keyword arguments can be passed to `pyfetch`
|
which returns a `FetchResponse` object whenever a request is made. Extra keyword arguments can be passed to `pyfetch`
|
||||||
which will be passed to the `fetch` API.
|
which will be passed to the `fetch` API.
|
||||||
@@ -31,7 +35,8 @@ for dealing with the response, such as `json()` or `status`. See the
|
|||||||
[FetchResponse documentation](https://pyodide.org/en/stable/usage/api/python-api/http.html#pyodide.http.FetchResponse)
|
[FetchResponse documentation](https://pyodide.org/en/stable/usage/api/python-api/http.html#pyodide.http.FetchResponse)
|
||||||
for more information.
|
for more information.
|
||||||
|
|
||||||
# Example
|
## Example
|
||||||
|
|
||||||
We will make async HTTP requests to [JSONPlaceholder](https://jsonplaceholder.typicode.com/)'s fake API using `pyfetch`.
|
We will make async HTTP requests to [JSONPlaceholder](https://jsonplaceholder.typicode.com/)'s fake API using `pyfetch`.
|
||||||
First we write a helper function in pure Python that makes a request and returns the response. This function
|
First we write a helper function in pure Python that makes a request and returns the response. This function
|
||||||
makes it easier to make specific types of requests with the most common parameters.
|
makes it easier to make specific types of requests with the most common parameters.
|
||||||
@@ -66,6 +71,7 @@ async def request(url: str, method: str = "GET", body: Optional[str] = None,
|
|||||||
response = await pyfetch(url, **kwargs)
|
response = await pyfetch(url, **kwargs)
|
||||||
return response
|
return response
|
||||||
```
|
```
|
||||||
|
|
||||||
This function is a wrapper for `pyfetch`, which is a wrapper for the `fetch` API. It is a coroutine function,
|
This function is a wrapper for `pyfetch`, which is a wrapper for the `fetch` API. It is a coroutine function,
|
||||||
so it must be awaited. It also has type hints, which are not required, but are useful for IDEs and other tools.
|
so it must be awaited. It also has type hints, which are not required, but are useful for IDEs and other tools.
|
||||||
The basic idea is that the `PyScript` will import and call this function, then await the response. Therefore,
|
The basic idea is that the `PyScript` will import and call this function, then await the response. Therefore,
|
||||||
@@ -92,13 +98,13 @@ concluding html code.
|
|||||||
<title>GET, POST, PUT, DELETE example</title>
|
<title>GET, POST, PUT, DELETE example</title>
|
||||||
|
|
||||||
<link rel="icon" type="image/png" href="favicon.png" />
|
<link rel="icon" type="image/png" href="favicon.png" />
|
||||||
<link rel="stylesheet" href="../build/pyscript.css" />
|
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
||||||
|
|
||||||
<script defer src="../build/pyscript.js"></script>
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
<py-env>
|
<py-config>
|
||||||
- paths:
|
[[fetch]]
|
||||||
- /request.py
|
files = ["/request.py"]
|
||||||
</py-env>
|
</py-config>
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body><p>
|
<body><p>
|
||||||
@@ -106,34 +112,33 @@ concluding html code.
|
|||||||
Here is the output of your request:
|
Here is the output of your request:
|
||||||
</p>
|
</p>
|
||||||
<py-script>
|
<py-script>
|
||||||
```
|
import asyncio
|
||||||
```python
|
import json
|
||||||
import asyncio # important!!
|
from request import request # import our request function.
|
||||||
import json
|
|
||||||
from request import request # import our request function.
|
|
||||||
|
|
||||||
baseurl = "https://jsonplaceholder.typicode.com/"
|
async def main():
|
||||||
|
baseurl = "https://jsonplaceholder.typicode.com"
|
||||||
|
|
||||||
# GET
|
# GET
|
||||||
headers = {"Content-type": "application/json"}
|
headers = {"Content-type": "application/json"}
|
||||||
response = await request(baseurl+"posts/2", method="GET", headers=headers)
|
response = await request(f"{baseurl}/posts/2", method="GET", headers=headers)
|
||||||
print(f"GET request=> status:{response.status}, json:{await response.json()}")
|
print(f"GET request=> status:{response.status}, json:{await response.json()}")
|
||||||
|
|
||||||
# POST
|
# POST
|
||||||
body = json.dumps({"title": "test_title", "body": "test body", "userId": 1})
|
body = json.dumps({"title": "test_title", "body": "test body", "userId": 1})
|
||||||
new_post = await request(baseurl+"posts", body=body, method="POST", headers=headers)
|
new_post = await request(f"{baseurl}/posts", body=body, method="POST", headers=headers)
|
||||||
print(f"POST request=> status:{new_post.status}, json:{await new_post.json()}")
|
print(f"POST request=> status:{new_post.status}, json:{await new_post.json()}")
|
||||||
|
|
||||||
# PUT
|
# PUT
|
||||||
body = json.dumps({"id": 1, "title": "test_title", "body": "test body", "userId": 2})
|
body = json.dumps({"id": 1, "title": "test_title", "body": "test body", "userId": 2})
|
||||||
new_post = await request(baseurl+"posts/1", body=body, method="PUT", headers=headers)
|
new_post = await request(f"{baseurl}/posts/1", body=body, method="PUT", headers=headers)
|
||||||
print(f"PUT request=> status:{new_post.status}, json:{await new_post.json()}")
|
print(f"PUT request=> status:{new_post.status}, json:{await new_post.json()}")
|
||||||
|
|
||||||
# DELETE
|
# DELETE
|
||||||
new_post = await request(baseurl+"posts/1", method="DELETE", headers=headers)
|
new_post = await request(f"{baseurl}/posts/1", method="DELETE", headers=headers)
|
||||||
print(f"DELETE request=> status:{new_post.status}, json:{await new_post.json()}")
|
print(f"DELETE request=> status:{new_post.status}, json:{await new_post.json()}")
|
||||||
```
|
|
||||||
```html
|
asyncio.ensure_future(main())
|
||||||
</py-script>
|
</py-script>
|
||||||
|
|
||||||
<div>
|
<div>
|
||||||
@@ -153,11 +158,12 @@ print(f"DELETE request=> status:{new_post.status}, json:{await new_post.json()}"
|
|||||||
```
|
```
|
||||||
|
|
||||||
## Explanation
|
## Explanation
|
||||||
### `py-env` tag for importing our Python code
|
### `py-config` tag for importing our Python code
|
||||||
The very first thing to notice is the `py-env` tag. This tag is used to import Python files into the `PyScript`.
|
The very first thing to notice is the `py-config` tag. This tag is used to import Python files into the `PyScript`.
|
||||||
In this case, we are importing the `request.py` file, which contains the `request` function we wrote above.
|
In this case, we are importing the `request.py` file, which contains the `request` function we wrote above.
|
||||||
|
|
||||||
### `py-script` tag for making async HTTP requests.
|
### `py-script` tag for making async HTTP requests
|
||||||
|
|
||||||
Next, the `py-script` tag contains the actual Python code where we import `asyncio` and `json`,
|
Next, the `py-script` tag contains the actual Python code where we import `asyncio` and `json`,
|
||||||
which are required or helpful for the `request` function.
|
which are required or helpful for the `request` function.
|
||||||
The `# GET`, `# POST`, `# PUT`, `# DELETE` blocks show examples of how to use the `request` function to make basic
|
The `# GET`, `# POST`, `# PUT`, `# DELETE` blocks show examples of how to use the `request` function to make basic
|
||||||
@@ -166,6 +172,7 @@ HTTP requests. The `await` keyword is required not only for the `request` functi
|
|||||||
faster ones.
|
faster ones.
|
||||||
|
|
||||||
### HTTP Requests
|
### HTTP Requests
|
||||||
|
|
||||||
HTTP requests are a very common way to communicate with a server. They are used for everything from getting data from
|
HTTP requests are a very common way to communicate with a server. They are used for everything from getting data from
|
||||||
a database, to sending emails, to authorization, and more. Due to safety concerns, files loaded from the
|
a database, to sending emails, to authorization, and more. Due to safety concerns, files loaded from the
|
||||||
local file system are not accessible by `PyScript`. Therefore, the proper way to load data into `PyScript` is also
|
local file system are not accessible by `PyScript`. Therefore, the proper way to load data into `PyScript` is also
|
||||||
@@ -179,32 +186,39 @@ function or to `pyfetch`. See the
|
|||||||
HTTP requests are defined by standards-setting bodies in [RFC 1945](https://www.rfc-editor.org/info/rfc1945) and
|
HTTP requests are defined by standards-setting bodies in [RFC 1945](https://www.rfc-editor.org/info/rfc1945) and
|
||||||
[RFC 9110](https://www.rfc-editor.org/info/rfc9110).
|
[RFC 9110](https://www.rfc-editor.org/info/rfc9110).
|
||||||
|
|
||||||
# Conclusion
|
## Conclusion
|
||||||
|
|
||||||
This tutorial demonstrates how to make HTTP requests using `pyfetch` and the `FetchResponse` objects. Importing Python
|
This tutorial demonstrates how to make HTTP requests using `pyfetch` and the `FetchResponse` objects. Importing Python
|
||||||
code/files into the `PyScript` using the `py-env` tag is also covered.
|
code/files into the `PyScript` using the `py-config` tag is also covered.
|
||||||
|
|
||||||
Although a simple example, the principals here can be used to create complex web applications inside of `PyScript`,
|
Although a simple example, the principals here can be used to create complex web applications inside of `PyScript`,
|
||||||
or load data into `PyScript` for use by an application, all served as a static HTML page, which is pretty amazing!
|
or load data into `PyScript` for use by an application, all served as a static HTML page, which is pretty amazing!
|
||||||
|
|
||||||
|
## API Quick Reference
|
||||||
|
|
||||||
# API Quick Reference
|
|
||||||
## pyodide.http.pyfetch
|
## pyodide.http.pyfetch
|
||||||
### Usage
|
|
||||||
|
### pyfetch Usage
|
||||||
|
|
||||||
```python
|
```python
|
||||||
await pyodide.http.pyfetch(url: str, **kwargs: Any) -> FetchResponse
|
await pyodide.http.pyfetch(url: str, **kwargs: Any) -> FetchResponse
|
||||||
```
|
```
|
||||||
|
|
||||||
Use `pyfetch` to make HTTP requests in `PyScript`. This is a wrapper around the `fetch` API. Returns a `FetchResponse`.
|
Use `pyfetch` to make HTTP requests in `PyScript`. This is a wrapper around the `fetch` API. Returns a `FetchResponse`.
|
||||||
|
|
||||||
### [`pyfetch` Docs.](https://pyodide.org/en/stable/usage/api/python-api/http.html#pyodide.http.pyfetch)
|
- [`pyfetch` Docs.](https://pyodide.org/en/stable/usage/api/python-api/http.html#pyodide.http.pyfetch)
|
||||||
|
|
||||||
## pyodide.http.FetchResponse
|
## pyodide.http.FetchResponse
|
||||||
### Usage
|
|
||||||
|
### FetchResponse Usage
|
||||||
|
|
||||||
```python
|
```python
|
||||||
response: pyodide.http.FetchResponse = await <pyfetch call>
|
response: pyodide.http.FetchResponse = await <pyfetch call>
|
||||||
status = response.status
|
status = response.status
|
||||||
json = await response.json()
|
json = await response.json()
|
||||||
```
|
```
|
||||||
|
|
||||||
Class for handling HTTP responses. This is a wrapper around the `JavaScript` fetch `Response`. Contains common (async)
|
Class for handling HTTP responses. This is a wrapper around the `JavaScript` fetch `Response`. Contains common (async)
|
||||||
methods and properties for handling HTTP responses, such as `json()`, `url`, `status`, `headers`, etc.
|
methods and properties for handling HTTP responses, such as `json()`, `url`, `status`, `headers`, etc.
|
||||||
|
|
||||||
### [`FetchResponse` Docs.](https://pyodide.org/en/stable/usage/api/python-api/http.html#pyodide.http.FetchResponse)
|
- [`FetchResponse` Docs.](https://pyodide.org/en/stable/usage/api/python-api/http.html#pyodide.http.FetchResponse)
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# How-to guides
|
# Guides
|
||||||
|
|
||||||
Welcome to the how-to documentation section for PyScript. If you've already
|
Welcome to the how-to documentation section for PyScript. If you've already
|
||||||
gained some experience with PyScript before and just need practical guides
|
gained some experience with PyScript before and just need practical guides
|
||||||
@@ -16,4 +16,7 @@ caption: 'Contents:'
|
|||||||
---
|
---
|
||||||
passing-objects
|
passing-objects
|
||||||
http-requests
|
http-requests
|
||||||
|
asyncio
|
||||||
|
custom-plugins
|
||||||
|
event-handlers
|
||||||
```
|
```
|
||||||
295
docs/guides/passing-objects.md
Normal file
295
docs/guides/passing-objects.md
Normal file
@@ -0,0 +1,295 @@
|
|||||||
|
# How to Pass Objects from PyScript to Javascript (and Vice Versa)
|
||||||
|
|
||||||
|
[Pyodide](https://pyodide.org), the interpreter that underlies PyScript, does a lot of work under the hood to translate objects between Python and JavaScript. This allows code in one language to access objects defined in the other.
|
||||||
|
|
||||||
|
This guide discusses how to pass objects between JavaScript and Python within PyScript. For more details on how Pyodide handles translating and proxying objects between the two languages, see the [Pyodide Type Translations Page](https://pyodide.org/en/stable/usage/type-conversions.html).
|
||||||
|
|
||||||
|
For our purposes, an 'object' is anything that can be bound to a variable (a number, string, object, [function](https://developer.mozilla.org/en-US/docs/Glossary/First-class_Function), etc).
|
||||||
|
|
||||||
|
## JavaScript to PyScript
|
||||||
|
|
||||||
|
We can use the syntax `from js import ...` to import JavaScript objects directly into PyScript. Simple JavaScript objects are converted to equivalent Python types; these are called [implicit conversions](https://pyodide.org/en/stable/usage/type-conversions.html#implicit-conversions). More complicated objects are wrapped in [JSProxy](https://pyodide.org/en/stable/usage/type-conversions.html) objects to make them behave like Python objects.
|
||||||
|
|
||||||
|
`import js` and `from js import ...` [in Pyodide](https://pyodide.org/en/stable/usage/type-conversions.html#type-translations-using-js-obj-from-py) get objects from the [JavaScript globalThis scope](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/globalThis), so keep the[ rules of JavaScript variable scoping](https://www.freecodecamp.org/news/var-let-and-const-whats-the-difference/) in mind.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<script>
|
||||||
|
name = "Guido" //A JS variable
|
||||||
|
|
||||||
|
// Define a JS Function
|
||||||
|
function addTwoNumbers(x, y){
|
||||||
|
return x + y;
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
```
|
||||||
|
```python
|
||||||
|
<py-script>
|
||||||
|
# Import and use JS function and variable into Python
|
||||||
|
from js import name, addTwoNumbers
|
||||||
|
|
||||||
|
print(f"Hello {name}")
|
||||||
|
print("Adding 1 and 2 in Javascript: " + str(addTwoNumbers(1, 2)))
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
|
|
||||||
|
## PyScript to JavaScript
|
||||||
|
|
||||||
|
### Using Pyodide's globals access
|
||||||
|
|
||||||
|
The [PyScript JavaScript module](../reference/modules/pyscript.md) exposes its underlying Pyodide interpreter as `PyScript.interpreter`, and maintains a reference to the [globals()](https://docs.python.org/3/library/functions.html#globals) dictionary of the Python namespace. Thus, any global variables in python are accessible in JavaScript at `PyScript.interpreter.globals.get('my_variable_name')`
|
||||||
|
|
||||||
|
```html
|
||||||
|
<body>
|
||||||
|
<py-script>x = 42</py-script>
|
||||||
|
|
||||||
|
<button onclick="showX()">Click Me to Get 'x' from Python</button>
|
||||||
|
<script>
|
||||||
|
function showX(){
|
||||||
|
console.log(`In Python right now, x = ${pyscript.interpreter.globals.get('x')}`)
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
</body>
|
||||||
|
```
|
||||||
|
|
||||||
|
Since [everything is an object](https://docs.python.org/3/reference/datamodel.html) in Python, this applies not only to user created variables, but also to classes, functions, built-ins, etc. If we want, we can even apply Python functions to JavaScript data and variables:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<body>
|
||||||
|
<!-- Click this button to log 'Apple', 'Banana', 'Candy', 'Donut' by sorting in Python-->
|
||||||
|
<button onclick="sortInPython(['Candy', 'Donut', 'Apple', 'Banana'])">Sort In Python And Log</button>
|
||||||
|
<script>
|
||||||
|
function sortInPython(data){
|
||||||
|
js_sorted = pyscript.interpreter.globals.get('sorted') //grab python's 'sorted' function
|
||||||
|
const sorted_data = js_sorted(data) //apply the function to the 'data' argument
|
||||||
|
for (const item of sorted_data){
|
||||||
|
console.log(item)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
</body>
|
||||||
|
```
|
||||||
|
|
||||||
|
### Using JavaScript's eval()
|
||||||
|
|
||||||
|
There may be some situations where it isn't possible or ideal to use `PyScript.interpreter.globals.get()` to retrieve a variable from the Pyodide global dictionary. For example, some JavaScript frameworks may take a function/Callable as an html attribute in a context where code execution isn't allowed (i.e. `get()` fails). In these cases, you can create JavaScript proxies of Python objects more or less "manually" using [JavaScript's eval() function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/eval), which executes a string as code much like [Python's eval()](https://docs.python.org/3/library/functions.html#eval).
|
||||||
|
|
||||||
|
First, we create a JS function `createObject` which takes an object and a string, then uses `eval()` to create a variable named after the string and bind it to that object. By calling this function from PyScript (where we have access to the Pyodide global namespace), we can bind JavaScript variables to Python objects without having direct access to that global namespace.
|
||||||
|
|
||||||
|
Include the following script tag anywhere in your html document:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<script>
|
||||||
|
function createObject(object, variableName){
|
||||||
|
//Bind a variable whose name is the string variableName
|
||||||
|
// to the object called 'object'
|
||||||
|
let execString = variableName + " = object"
|
||||||
|
console.log("Running '" + execString + "'");
|
||||||
|
eval(execString)
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
```
|
||||||
|
|
||||||
|
This function takes a Python Object and creates a variable pointing to it in the JavaScript global scope.
|
||||||
|
|
||||||
|
### Exporting all Global Python Objects
|
||||||
|
|
||||||
|
We can use our new `createObject` function to "export" the entire Python global object dictionary as a JavaScript object:
|
||||||
|
|
||||||
|
```python
|
||||||
|
<py-script>
|
||||||
|
from js import createObject
|
||||||
|
from pyodide.ffi import create_proxy
|
||||||
|
createObject(create_proxy(globals()), "pyodideGlobals")
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
|
This will make all Python global variables available in JavaScript with `pyodideGlobals.get('my_variable_name')`.
|
||||||
|
|
||||||
|
(Since PyScript tags evaluate _after_ all JavaScript on the page, we can't just dump a `console.log(...)` into a `<script>` tag, since that tag will evaluate before any PyScript has a chance to. We need to delay accessing the Python variable in JavaScript until after the Python code has a chance to run. The following example uses a button with `id="do-math"` to achieve this, but any method would be valid.)
|
||||||
|
|
||||||
|
```python
|
||||||
|
<py-script>
|
||||||
|
# create some Python objects:
|
||||||
|
symbols = {'pi': 3.1415926, 'e': 2.7182818}
|
||||||
|
|
||||||
|
def rough_exponential(x):
|
||||||
|
return symbols['e']**x
|
||||||
|
|
||||||
|
class Circle():
|
||||||
|
def __init__(self, radius):
|
||||||
|
self.radius = radius
|
||||||
|
|
||||||
|
@property
|
||||||
|
def area(self):
|
||||||
|
return symbols['pi'] * self.radius**2
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
|
|
||||||
|
```html
|
||||||
|
<input type="button" value="Log Python Variables" id="do-math">
|
||||||
|
<script>
|
||||||
|
document.getElementById("do-math").addEventListener("click", () => {
|
||||||
|
const exp = pyodideGlobals.get('rough_exponential');
|
||||||
|
console.log(`e squared is about ${exp(2)}`);
|
||||||
|
const c = pyodideGlobals.get('Circle')(4);
|
||||||
|
console.log(`The area of c is ${c.area}`);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Full example
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
||||||
|
|
||||||
|
<title>Exporting all Global Python Objects</title>
|
||||||
|
|
||||||
|
<link rel="icon" type="image/png" href="favicon.png" />
|
||||||
|
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
||||||
|
|
||||||
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<input type="button" value="Log Python Variables" id="do-math">
|
||||||
|
<py-script>
|
||||||
|
from js import createObject
|
||||||
|
from pyodide.ffi import create_proxy
|
||||||
|
|
||||||
|
createObject(create_proxy(globals()), "pyodideGlobals")
|
||||||
|
|
||||||
|
# create some Python objects:
|
||||||
|
symbols = {'pi': 3.1415926, 'e': 2.7182818}
|
||||||
|
|
||||||
|
def rough_exponential(x):
|
||||||
|
return symbols['e']**x
|
||||||
|
|
||||||
|
class Circle():
|
||||||
|
def __init__(self, radius):
|
||||||
|
self.radius = radius
|
||||||
|
|
||||||
|
@property
|
||||||
|
def area(self):
|
||||||
|
return symbols['pi'] * self.radius**2
|
||||||
|
</py-script>
|
||||||
|
<script>
|
||||||
|
function createObject(object, variableName){
|
||||||
|
//Bind a variable whose name is the string variableName
|
||||||
|
// to the object called 'object'
|
||||||
|
let execString = variableName + " = object"
|
||||||
|
console.log("Running '" + execString + "'");
|
||||||
|
eval(execString)
|
||||||
|
}
|
||||||
|
|
||||||
|
document.getElementById("do-math").addEventListener("click", () => {
|
||||||
|
const exp = pyodideGlobals.get('rough_exponential');
|
||||||
|
console.log(`e squared is about ${exp(2)}`);
|
||||||
|
const c = pyodideGlobals.get('Circle')(4);
|
||||||
|
console.log(`The area of c is ${c.area}`);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### Exporting Individual Python Objects
|
||||||
|
|
||||||
|
We can also export individual Python objects to the JavaScript global scope if we wish.
|
||||||
|
|
||||||
|
(As above, the following example uses a button to delay the execution of the `<script>` until after the PyScript has run.)
|
||||||
|
|
||||||
|
```python
|
||||||
|
<py-script>
|
||||||
|
import js
|
||||||
|
from pyodide.ffi import create_proxy
|
||||||
|
|
||||||
|
# Create 3 python objects
|
||||||
|
language = "Python 3"
|
||||||
|
animals = ['dog', 'cat', 'bird']
|
||||||
|
multiply3 = lambda a, b, c: a * b * c
|
||||||
|
|
||||||
|
# js object can be named the same as Python objects...
|
||||||
|
js.createObject(language, "language")
|
||||||
|
|
||||||
|
# ...but don't have to be
|
||||||
|
js.createObject(create_proxy(animals), "animals_from_py")
|
||||||
|
|
||||||
|
# functions are objects too, in both Python and Javascript
|
||||||
|
js.createObject(create_proxy(multiply3), "multiply")
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
|
```html
|
||||||
|
<input type="button" value="Log Python Variables" id="log-python-variables">
|
||||||
|
<script>
|
||||||
|
document.getElementById("log-python-variables").addEventListener("click", () => {
|
||||||
|
console.log(`Nice job using ${language}`);
|
||||||
|
for (const animal of animals_from_py){
|
||||||
|
console.log(`Do you like ${animal}s? `);
|
||||||
|
}
|
||||||
|
console.log(`2 times 3 times 4 is ${multiply(2,3,4)}`);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Full example
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
||||||
|
|
||||||
|
<title>Exporting Individual Python Objects</title>
|
||||||
|
|
||||||
|
<link rel="icon" type="image/png" href="favicon.png" />
|
||||||
|
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
||||||
|
|
||||||
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<py-script>
|
||||||
|
import js
|
||||||
|
from pyodide.ffi import create_proxy
|
||||||
|
|
||||||
|
# Create 3 python objects
|
||||||
|
language = "Python 3"
|
||||||
|
animals = ['dog', 'cat', 'bird']
|
||||||
|
multiply3 = lambda a, b, c: a * b * c
|
||||||
|
|
||||||
|
# js object can be named the same as Python objects...
|
||||||
|
js.createObject(language, "language")
|
||||||
|
|
||||||
|
# ...but don't have to be
|
||||||
|
js.createObject(create_proxy(animals), "animals_from_py")
|
||||||
|
|
||||||
|
# functions are objects too, in both Python and Javascript
|
||||||
|
js.createObject(create_proxy(multiply3), "multiply")
|
||||||
|
</py-script>
|
||||||
|
|
||||||
|
<input type="button" value="Log Python Variables" id="log-python-variables">
|
||||||
|
<script>
|
||||||
|
function createObject(object, variableName){
|
||||||
|
//Bind a variable whose name is the string variableName
|
||||||
|
// to the object called 'object'
|
||||||
|
let execString = variableName + " = object"
|
||||||
|
console.log("Running '" + execString + "'");
|
||||||
|
eval(execString)
|
||||||
|
}
|
||||||
|
|
||||||
|
document.getElementById("log-python-variables").addEventListener("click", () => {
|
||||||
|
console.log(`Nice job using ${language}`);
|
||||||
|
for (const animal of animals_from_py){
|
||||||
|
console.log(`Do you like ${animal}s? `);
|
||||||
|
}
|
||||||
|
console.log(`2 times 3 times 4 is ${multiply(2,3,4)}`);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
@@ -1,140 +0,0 @@
|
|||||||
# How to Pass Objects from PyScript to Javascript (and Vice Versa)
|
|
||||||
|
|
||||||
[Pyodide](https://pyodide.org), the runtime that underlies PyScript, does a lot of work under the hood to translate objects between Python and JavaScript. This allows code in one language to access objects defined in the other.
|
|
||||||
|
|
||||||
This guide discusses how to pass objects between JavaScript and Python within PyScript. For more details on how Pyodide handles translating and proxying objects between the two languages, see the [Pyodide Type Translations Page](https://pyodide.org/en/stable/usage/type-conversions.html).
|
|
||||||
|
|
||||||
For our purposes, an 'object' is anything that can be bound to a variable (a number, string, object, [function](https://developer.mozilla.org/en-US/docs/Glossary/First-class_Function), etc).
|
|
||||||
|
|
||||||
## JavaScript to PyScript
|
|
||||||
|
|
||||||
We can use the syntax `from js import ...` to import JavaScript objects directly into PyScript. Simple JavaScript objects are converted to equivalent Python types; these are called [implicit conversions](https://pyodide.org/en/stable/usage/type-conversions.html#implicit-conversions). More complicated objects are wrapped in [JSProxy](https://pyodide.org/en/stable/usage/type-conversions.html) objects to make them behave like Python objects.
|
|
||||||
|
|
||||||
`import js` and `from js import ...` [in Pyodide](https://pyodide.org/en/stable/usage/type-conversions.html#type-translations-using-js-obj-from-py) get objects from the [JavaScript globalThis scope](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/globalThis), so keep the[ rules of JavaScript variable scoping](https://www.freecodecamp.org/news/var-let-and-const-whats-the-difference/) in mind.
|
|
||||||
|
|
||||||
```html
|
|
||||||
<script>
|
|
||||||
name = "Guido" //A JS variable
|
|
||||||
|
|
||||||
// Define a JS Function
|
|
||||||
function addTwoNumbers(x, y){
|
|
||||||
return x + y;
|
|
||||||
}
|
|
||||||
</script>
|
|
||||||
```
|
|
||||||
```python
|
|
||||||
<py-script>
|
|
||||||
# Import and use JS function and variable into Python
|
|
||||||
from js import name, addTwoNumbers
|
|
||||||
|
|
||||||
print(f"Hello {name}")
|
|
||||||
print("Adding 1 and 2 in Javascript: " + str(addTwoNumbers(1, 2)))
|
|
||||||
</py-script>
|
|
||||||
```
|
|
||||||
|
|
||||||
## PyScript to JavaScript
|
|
||||||
|
|
||||||
Since [PyScript doesn't export its instance of Pyodide](https://github.com/pyscript/pyscript/issues/494) and only one instance of Pyodide can be running in a browser window at a time, there isn't currently a way for Javascript to access Objects defined inside PyScript tags "directly".
|
|
||||||
|
|
||||||
We can work around this limitation using [JavaScript's eval() function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/eval), which executes a string as code much like [Python's eval()](https://docs.python.org/3/library/functions.html#eval). First, we create a JS function `createObject` which takes an object and a string, then uses `eval()` to create a variable named after the string and bind it to that object. By calling this function from PyScript (where we have access to the Pyodide global namespace), we can bind JavaScript variables to Python objects without having direct access to that global namespace.
|
|
||||||
|
|
||||||
Include the following script tag anywhere in your html document:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<script>
|
|
||||||
function createObject(object, variableName){
|
|
||||||
//Bind a variable whose name is the string variableName
|
|
||||||
// to the object called 'object'
|
|
||||||
let execString = variableName + " = object"
|
|
||||||
console.log("Running '" + execString + "'");
|
|
||||||
eval(execString)
|
|
||||||
}
|
|
||||||
</script>
|
|
||||||
```
|
|
||||||
|
|
||||||
This function takes a Python Object and creates a variable pointing to it in the JavaScript global scope.
|
|
||||||
|
|
||||||
### Exporting all Global Python Objects
|
|
||||||
|
|
||||||
We can use our new `createObject` function to "export" the entire Python global object dictionary as a JavaScript object:
|
|
||||||
|
|
||||||
```python
|
|
||||||
<py-script>
|
|
||||||
from js import createObject
|
|
||||||
from pyodide.ffi import create_proxy
|
|
||||||
createObject(create_proxy(globals()), "pyodideGlobals")
|
|
||||||
</py-script>
|
|
||||||
```
|
|
||||||
This will make all Python global variables available in JavaScript with `pyodideGlobals.get('my_variable_name')`.
|
|
||||||
|
|
||||||
(Since PyScript tags evaluate _after_ all JavaScript on the page, we can't just dump a `console.log(...)` into a `<script>` tag, since that tag will evaluate before any PyScript has a chance to. We need to delay accessing the Python variable in JavaScript until after the Python code has a chance to run. The following example uses a button with `id="do-math"` to achieve this, but any method would be valid.)
|
|
||||||
|
|
||||||
```python
|
|
||||||
<py-script>
|
|
||||||
# create some Python objects:
|
|
||||||
symbols = {'pi': 3.1415926, 'e': 2.7182818}
|
|
||||||
|
|
||||||
def rough_exponential(x):
|
|
||||||
return symbols['e']**x
|
|
||||||
|
|
||||||
class Circle():
|
|
||||||
def __init__(self, radius):
|
|
||||||
self.radius = radius
|
|
||||||
|
|
||||||
@property
|
|
||||||
def area:
|
|
||||||
return symbols['pi'] * self.radius**2
|
|
||||||
</py-script>
|
|
||||||
```
|
|
||||||
|
|
||||||
```html
|
|
||||||
<input type="button" value="Log Python Variables" id="do-mmath">
|
|
||||||
<script>
|
|
||||||
document.getElementById("do-math").addEventListener("click", () => {
|
|
||||||
const exp = pyodideGlobals.get('rough_exponential');
|
|
||||||
console.log("e squared is about ${exp(2)}");
|
|
||||||
const c = pyodideGlobals.get('Circle')(4);
|
|
||||||
console.log("The area of c is ${c.area}");
|
|
||||||
});
|
|
||||||
</script>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
### Exporting Individual Python Objects
|
|
||||||
|
|
||||||
We can also export individual Python objects to the JavaScript global scope if we wish.
|
|
||||||
|
|
||||||
(As above, the following example uses a button to delay the execution of the `<script>` until after the PyScript has run.)
|
|
||||||
|
|
||||||
```python
|
|
||||||
<py-script>
|
|
||||||
import js
|
|
||||||
from pyodide.ffi import create_proxy
|
|
||||||
|
|
||||||
# Create 3 python objects
|
|
||||||
language = "Python 3"
|
|
||||||
animals = ['dog', 'cat', 'bird']
|
|
||||||
multiply3 = lambda a, b, c: a * b * c
|
|
||||||
|
|
||||||
# js object can be named the same as Python objects...
|
|
||||||
js.createObject(language, "language")
|
|
||||||
|
|
||||||
# ...but don't have to be
|
|
||||||
js.createObject(create_proxy(animals), "animals_from_py")
|
|
||||||
|
|
||||||
# functions are objects too, in both Python and Javascript
|
|
||||||
js.createObject(create_proxy(multiply3), "multiply")
|
|
||||||
</py-script>
|
|
||||||
```
|
|
||||||
```html
|
|
||||||
<input type="button" value="Log Python Variables" id="log-python-variables">
|
|
||||||
<script>
|
|
||||||
document.getElementById("log-python-variables").addEventListener("click", () => {
|
|
||||||
console.log(`Nice job using ${language}`);
|
|
||||||
for (const animal of animals_from_py){
|
|
||||||
console.log(`Do you like ${animal}s? `);
|
|
||||||
}
|
|
||||||
console.log(`2 times 3 times 4 is ${multiply(2,3,4)}`);
|
|
||||||
});
|
|
||||||
</script>
|
|
||||||
```
|
|
||||||
@@ -1,10 +1,5 @@
|
|||||||
# PyScript
|
# PyScript
|
||||||
|
|
||||||
```{warning}
|
|
||||||
Please note, this documentation is just a placeholder and **should not be used
|
|
||||||
in reference material**. Thank you!
|
|
||||||
```
|
|
||||||
|
|
||||||
Welcome to the PyScript documentation!
|
Welcome to the PyScript documentation!
|
||||||
|
|
||||||
PyScript provides a way for you to run Python code directly in your browser, giving
|
PyScript provides a way for you to run Python code directly in your browser, giving
|
||||||
@@ -22,12 +17,15 @@ Just getting started with PyScript?
|
|||||||
|
|
||||||
Check out our [getting started guide](tutorials/getting-started.md)!
|
Check out our [getting started guide](tutorials/getting-started.md)!
|
||||||
:::
|
:::
|
||||||
:::{grid-item-card} [How-to guides](howtos/index.md)
|
:::{grid-item-card} [Guides](guides/index.md)
|
||||||
|
|
||||||
You already know the basics and want to learn specifics!
|
You already know the basics and want to learn specifics!
|
||||||
|
|
||||||
[Passing Objects between JavaScript and Python](howtos/passing-objects.md)
|
[Passing Objects between JavaScript and Python](guides/passing-objects.md)
|
||||||
[Making async HTTP requests in pure Python](howtos/http-requests.md)
|
|
||||||
|
[Making async HTTP requests in pure Python](guides/http-requests.md)
|
||||||
|
|
||||||
|
[Async/Await and Asyncio](guides/asyncio.md)
|
||||||
|
|
||||||
:::
|
:::
|
||||||
:::{grid-item-card} [Concepts](concepts/index.md)
|
:::{grid-item-card} [Concepts](concepts/index.md)
|
||||||
@@ -39,6 +37,8 @@ You already know the basics and want to learn specifics!
|
|||||||
|
|
||||||
[Frequently asked questions](reference/faq.md)
|
[Frequently asked questions](reference/faq.md)
|
||||||
|
|
||||||
|
[The PyScript JS Module](reference/modules/pyscript.md)
|
||||||
|
|
||||||
:::{toctree}
|
:::{toctree}
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
@@ -51,7 +51,8 @@ maxdepth: 1
|
|||||||
hidden:
|
hidden:
|
||||||
---
|
---
|
||||||
tutorials/index
|
tutorials/index
|
||||||
howtos/index
|
guides/index
|
||||||
concepts/index
|
concepts/index
|
||||||
reference/index
|
reference/index
|
||||||
|
changelog
|
||||||
```
|
```
|
||||||
|
|||||||
8
docs/reference/API/__version__.md
Normal file
8
docs/reference/API/__version__.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# `__version__`
|
||||||
|
|
||||||
|
`PyScript.__version__` is a `str` representing the current version of PyScript in a human-readable form. For a structured version more suitable to comparisons, and for details of what each part of the version number represents, see [`version_info`](version_info.md)
|
||||||
|
|
||||||
|
```shell
|
||||||
|
>>> pyscript.__version__
|
||||||
|
'2023.02.1.dev'
|
||||||
|
```
|
||||||
85
docs/reference/API/attr_to_event.md
Normal file
85
docs/reference/API/attr_to_event.md
Normal file
@@ -0,0 +1,85 @@
|
|||||||
|
# List of PyScript Attributes to Events:
|
||||||
|
|
||||||
|
PyScript provides a convenient syntax for mapping JavaScript events to PyScript events, making it easy to connect events to HTML tags.
|
||||||
|
|
||||||
|
For example, you can use the following code to connect the click event to a button:
|
||||||
|
|
||||||
|
```
|
||||||
|
<button id="py-click" py-click="foo()">Click me</button>
|
||||||
|
```
|
||||||
|
|
||||||
|
Here is a list of all the available event mappings:
|
||||||
|
|
||||||
|
| PyScript Event Name | DOM Event Name |
|
||||||
|
|-------------------|----------------|
|
||||||
|
| py-afterprint | afterprint |
|
||||||
|
| py-beforeprint | beforeprint |
|
||||||
|
| py-beforeunload | beforeunload |
|
||||||
|
| py-error | error |
|
||||||
|
| py-hashchange | hashchange |
|
||||||
|
| py-load | load |
|
||||||
|
| py-message | message |
|
||||||
|
| py-offline | offline |
|
||||||
|
| py-online | online |
|
||||||
|
| py-pagehide | pagehide |
|
||||||
|
| py-pageshow | pageshow |
|
||||||
|
| py-popstate | popstate |
|
||||||
|
| py-resize | resize |
|
||||||
|
| py-storage | storage |
|
||||||
|
| py-unload | unload |
|
||||||
|
| py-blur | blur |
|
||||||
|
| py-change | change |
|
||||||
|
| py-contextmenu | contextmenu |
|
||||||
|
| py-focus | focus |
|
||||||
|
| py-input | input |
|
||||||
|
| py-invalid | invalid |
|
||||||
|
| py-reset | reset |
|
||||||
|
| py-search | search |
|
||||||
|
| py-select | select |
|
||||||
|
| py-submit | submit |
|
||||||
|
| py-keydown | keydown |
|
||||||
|
| py-keypress | keypress |
|
||||||
|
| py-keyup | keyup |
|
||||||
|
| py-click | click |
|
||||||
|
| py-dblclick | dblclick |
|
||||||
|
| py-mousedown | mousedown |
|
||||||
|
| py-mousemove | mousemove |
|
||||||
|
| py-mouseout | mouseout |
|
||||||
|
| py-mouseover | mouseover |
|
||||||
|
| py-mouseup | mouseup |
|
||||||
|
| py-mousewheel | mousewheel |
|
||||||
|
| py-wheel | wheel |
|
||||||
|
| py-drag | drag |
|
||||||
|
| py-dragend | dragend |
|
||||||
|
| py-dragenter | dragenter |
|
||||||
|
| py-dragleave | dragleave |
|
||||||
|
| py-dragover | dragover |
|
||||||
|
| py-dragstart | dragstart |
|
||||||
|
| py-drop | drop |
|
||||||
|
| py-scroll | scroll |
|
||||||
|
| py-copy | copy |
|
||||||
|
| py-cut | cut |
|
||||||
|
| py-paste | paste |
|
||||||
|
| py-abort | abort |
|
||||||
|
| py-canplay | canplay |
|
||||||
|
| py-canplaythrough | canplaythrough |
|
||||||
|
| py-cuechange | cuechange |
|
||||||
|
| py-durationchange | durationchange |
|
||||||
|
| py-emptied | emptied |
|
||||||
|
| py-ended | ended |
|
||||||
|
| py-loadeddata | loadeddata |
|
||||||
|
| py-loadedmetadata | loadedmetadata |
|
||||||
|
| py-loadstart | loadstart |
|
||||||
|
| py-pause | pause |
|
||||||
|
| py-play | play |
|
||||||
|
| py-playing | playing |
|
||||||
|
| py-progress | progress |
|
||||||
|
| py-ratechange | ratechange |
|
||||||
|
| py-seeked | seeked |
|
||||||
|
| py-seeking | seeking |
|
||||||
|
| py-stalled | stalled |
|
||||||
|
| py-suspend | suspend |
|
||||||
|
| py-timeupdate | timeupdate |
|
||||||
|
| py-volumechange | volumechange |
|
||||||
|
| py-waiting | waiting |
|
||||||
|
| py-toggle | toggle |
|
||||||
87
docs/reference/API/display.md
Normal file
87
docs/reference/API/display.md
Normal file
@@ -0,0 +1,87 @@
|
|||||||
|
# `display(*values, target=None, append=True)`
|
||||||
|
|
||||||
|
## Parameters
|
||||||
|
|
||||||
|
`*values` - the objects to be displayed. String objects are output as-written. For non-string objects, the default content to display is the the object's {py:func}`repr`. Objects may implement the following methods to indicate that they should be displayed as a different MIME type. MIME types with a * indicate that the content will be wrapped in the appropriate html tags and attributes before output:
|
||||||
|
|
||||||
|
|
||||||
|
| Method | Inferred MIME type |
|
||||||
|
|---------------------|------------------------|
|
||||||
|
| `__repr__` | text/plain |
|
||||||
|
| `_repr_html_` | text/html |
|
||||||
|
| `_repr_svg_` | image/svg+xml |
|
||||||
|
| `_repr_png_` | image/png* |
|
||||||
|
| `_repr_pdf_` | application/pdf |
|
||||||
|
| `_repr_jpeg_` | image/jpeg* |
|
||||||
|
| `_repr_json_` | application/json |
|
||||||
|
| `_repr_javascript_` | application/javascript*|
|
||||||
|
| `savefig` | image/png |
|
||||||
|
| | |
|
||||||
|
|
||||||
|
`target` - Element's ID. The default value for `target` is the current `py-script` tag ID, it's possible to specify different IDs for this parameter
|
||||||
|
|
||||||
|
`append` - `boolean` if the output is going to be appended or not to the `target`ed element. It creates a `<div>` tag if `True` and a `<py-script>` tag with a random ID if `False`. The default value for `append` is `True`.
|
||||||
|
|
||||||
|
### Description
|
||||||
|
|
||||||
|
Display is the default function to display objects on the screen. Functions like the Python `print()` or JavaScript `console.log()` are now defaulted to only appear on the terminal.
|
||||||
|
|
||||||
|
Display will throw an exception if the target is not clear. E.g. the following code is invalid:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<py-script>
|
||||||
|
def display_hello():
|
||||||
|
# this fails because we don't have any implicit target
|
||||||
|
# from event handlers
|
||||||
|
display('hello')
|
||||||
|
</py-script>
|
||||||
|
<button id="my-button" py-click="display_hello()">Click me</button>
|
||||||
|
```
|
||||||
|
|
||||||
|
Because it's considered unclear if the `hello` string should be displayed underneath the `<py-script>` tag or the `<button>` tag.
|
||||||
|
|
||||||
|
To write compliant code, make sure to specify the target using the `target` parameter, for example:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<py-script>
|
||||||
|
def display_hello():
|
||||||
|
# this works because we give an explicit target
|
||||||
|
display('hello', target="helloDiv")
|
||||||
|
</py-script>
|
||||||
|
<div id="helloDiv"></div>
|
||||||
|
<button id="my-button" py-click="display_hello()">Click me</button>
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Using matplotlib with display
|
||||||
|
|
||||||
|
`matplotlib` has two ways of plotting things as mentioned [here](https://matplotlib.org/matplotblog/posts/pyplot-vs-object-oriented-interface/)
|
||||||
|
|
||||||
|
- In case of using the `pyplot` interface, the graph can be shown using `display(plt)`.
|
||||||
|
|
||||||
|
```python
|
||||||
|
import matplotlib.pyplot as plt
|
||||||
|
import numpy as np
|
||||||
|
|
||||||
|
# Data for plotting
|
||||||
|
t = np.arange(0.0, 2.0, 0.01)
|
||||||
|
s = 1 + np.sin(2 * np.pi * t)
|
||||||
|
plt.plot(t,s)
|
||||||
|
|
||||||
|
display(plt)
|
||||||
|
```
|
||||||
|
|
||||||
|
- In case of using the `object oriented` interface, the graph can be shown using `display(fig)` or `display(plt)` both.
|
||||||
|
|
||||||
|
```python
|
||||||
|
import matplotlib.pyplot as plt
|
||||||
|
import numpy as np
|
||||||
|
|
||||||
|
# Data for plotting
|
||||||
|
t = np.arange(0.0, 2.0, 0.01)
|
||||||
|
s = 1 + np.sin(2 * np.pi * t)
|
||||||
|
|
||||||
|
fig, ax = plt.subplots()
|
||||||
|
ax.plot(t, s)
|
||||||
|
|
||||||
|
display(fig) # but even display(plt) would have worked!
|
||||||
|
```
|
||||||
309
docs/reference/API/element.md
Normal file
309
docs/reference/API/element.md
Normal file
@@ -0,0 +1,309 @@
|
|||||||
|
# `Element`
|
||||||
|
|
||||||
|
The `Element` API is a helpful way to create and manipulate elements in the DOM. It is a wrapper around the native DOM API, and is designed to be as intuitive as possible.
|
||||||
|
|
||||||
|
## Methods and Properties
|
||||||
|
|
||||||
|
| Property | Description |
|
||||||
|
|----------|-----------------------------------------|
|
||||||
|
| `element` | Returns the element with the given ID. |
|
||||||
|
| `id` | Returns the element's ID. |
|
||||||
|
| `value` | Returns the element's value. |
|
||||||
|
| `innerHtml` | Returns the element's inner HTML. |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
| Method | Description |
|
||||||
|
|----------------------|--------------------------------------------------------------|
|
||||||
|
| `write` | Writes `value` to element and handles various mime types. `append` defaults to `False`, if set to true, it will create a child element. |
|
||||||
|
| `clear` | Clears the element's value or content. |
|
||||||
|
| `select` | Select element from `query` which uses [Document.querySelector()](https://developer.mozilla.org/en-US/docs/Web/API/Document/querySelector). |
|
||||||
|
| `clone` | Clones the with `new_id` if provided and `to` element if provided. |
|
||||||
|
| `remove_class` | Removes one or more class name from the element. |
|
||||||
|
| `add_class` | Adds one or more class name to the element. |
|
||||||
|
|
||||||
|
## Element.element
|
||||||
|
|
||||||
|
| Parameter | Default | Type |
|
||||||
|
|-----------|---------|------|
|
||||||
|
| | | |
|
||||||
|
|
||||||
|
The `element` property returns the DOM element with the given ID.
|
||||||
|
|
||||||
|
```html
|
||||||
|
from pyscript import Element
|
||||||
|
|
||||||
|
my_div = Element('my-div')
|
||||||
|
print(my_div.element)
|
||||||
|
```
|
||||||
|
|
||||||
|
## Element.id
|
||||||
|
|
||||||
|
| Parameter | Default | Type |
|
||||||
|
|-----------|---------|------|
|
||||||
|
| | | |
|
||||||
|
|
||||||
|
Return the element's ID.
|
||||||
|
|
||||||
|
```html
|
||||||
|
|
||||||
|
<div id="my-div"></div>
|
||||||
|
|
||||||
|
<py-script>
|
||||||
|
from pyscript import Element
|
||||||
|
|
||||||
|
my_div = Element('my-div')
|
||||||
|
print(my_div.id) # prints 'my-div'
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Element.value
|
||||||
|
|
||||||
|
| Parameter | Default | Type |
|
||||||
|
|-----------|---------|------|
|
||||||
|
| | | |
|
||||||
|
|
||||||
|
Return the element's value.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<input id="my-input" value="hello world"></input>
|
||||||
|
|
||||||
|
<py-script>
|
||||||
|
from pyscript import Element
|
||||||
|
|
||||||
|
my_input = Element('my-input')
|
||||||
|
print(my_input.value) # prints 'hello world'
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Element.innerHtml
|
||||||
|
|
||||||
|
| Parameter | Default | Type |
|
||||||
|
|-----------|---------|------|
|
||||||
|
| | | |
|
||||||
|
|
||||||
|
Return the element's inner HTML.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<div id="my-innerHtml">
|
||||||
|
<b>hello world</b>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<py-script>
|
||||||
|
from pyscript import Element
|
||||||
|
|
||||||
|
my_innerHtml = Element('my-innerHtml')
|
||||||
|
print(my_innerHtml.innerHtml) # prints <b> hello world </b>
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Element.write
|
||||||
|
|
||||||
|
| Parameter | Default | Type |
|
||||||
|
|-------------|---------|-----------------------------|
|
||||||
|
| `value` | | `str` or `__mime_type__` |
|
||||||
|
| `append` | False | `bool` |
|
||||||
|
|
||||||
|
Writes `value` to element and handles various mime types. This method also contains a `append` parameter, which defaults to `False`.
|
||||||
|
|
||||||
|
Currently, these are the MIME types that are supported when rendering content using this method
|
||||||
|
|
||||||
|
| Method | Inferred MIME type |
|
||||||
|
|---------------------|------------------------|
|
||||||
|
| `__repr__` | text/plain |
|
||||||
|
| `_repr_html_` | text/html |
|
||||||
|
| `_repr_svg_` | image/svg+xml |
|
||||||
|
| `_repr_png_` | image/png* |
|
||||||
|
| `_repr_pdf_` | application/pdf |
|
||||||
|
| `_repr_jpeg_` | image/jpeg* |
|
||||||
|
| `_repr_json_` | application/json |
|
||||||
|
| `_repr_javascript_` | application/javascript*|
|
||||||
|
| `savefig` | image/png |
|
||||||
|
|
||||||
|
```html
|
||||||
|
<div id="foo"></div>
|
||||||
|
|
||||||
|
<py-script>
|
||||||
|
from pyscript import Element
|
||||||
|
el = Element("foo")
|
||||||
|
el.write("Hello!")
|
||||||
|
el.write("World!") # will replace the previous content
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
|
|
||||||
|
If we set `append` to `True`, it will create a child element using a `div`.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<div id="foo"></div>
|
||||||
|
|
||||||
|
<py-script>
|
||||||
|
from pyscript import Element
|
||||||
|
el = Element("foo")
|
||||||
|
el.write("Hello!", append=True)
|
||||||
|
|
||||||
|
# This will create a child div with the id "foo-1"
|
||||||
|
el.write("World!", append=True)
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Element.clear
|
||||||
|
|
||||||
|
| Parameter | Default | Type |
|
||||||
|
|-----------|---------|------|
|
||||||
|
| | | |
|
||||||
|
|
||||||
|
Clears the element's value or content. For example, we can clear the value of an input element.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<input id="foo" value="Hello!"></input>
|
||||||
|
|
||||||
|
<py-script>
|
||||||
|
from pyscript import Element
|
||||||
|
el = Element("foo")
|
||||||
|
el.clear() # Removes value from input
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
|
|
||||||
|
Or we can clear the content of a div element.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<div id="foo">Hello!</div>
|
||||||
|
|
||||||
|
<py-script>
|
||||||
|
from pyscript import Element
|
||||||
|
el = Element("foo")
|
||||||
|
el.clear() # Removes Hello from div content
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Element.select
|
||||||
|
|
||||||
|
Select element from `query`, it will look into the main Element if `from_content` is `True`. This method is a wrapper of [Document.querySelector()](https://developer.mozilla.org/en-US/docs/Web/API/Document/querySelector).
|
||||||
|
|
||||||
|
```html
|
||||||
|
<div id="foo">
|
||||||
|
<div id="bar"></div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<py-script>
|
||||||
|
from pyscript import Element
|
||||||
|
el = Element("foo")
|
||||||
|
bar = el.select("#bar")
|
||||||
|
print(bar.id) # prints 'bar'
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Element.clone
|
||||||
|
|
||||||
|
| Parameter | Default | Type |
|
||||||
|
|-------------|---------|-----------|
|
||||||
|
| `new_id` | None | `str` |
|
||||||
|
| `to` | None | `Element` |
|
||||||
|
|
||||||
|
Clones the element to a new element. You can provide `new_id` to set a different id to the cloned element. You can also use a `to` element to append the cloned element to.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<div id="foo">
|
||||||
|
HI!
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<py-script>
|
||||||
|
from pyscript import Element
|
||||||
|
|
||||||
|
el = Element("foo")
|
||||||
|
# Creates two divs with the id "foo" and content "HI!"
|
||||||
|
el.clone()
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
|
|
||||||
|
It's always a good idea to pass a new id to the element you are cloning to avoid confusion if you need to reference the element by id again.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<div id="foo">Hello!</div>
|
||||||
|
|
||||||
|
<py-script>
|
||||||
|
from pyscript import Element
|
||||||
|
el = Element("foo")
|
||||||
|
# Clones foo and its contents, but uses the id 'bar'
|
||||||
|
el.clone(new_id="bar")
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
|
|
||||||
|
You can also clone an element into another element.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<div id="bond">
|
||||||
|
Bond
|
||||||
|
</div>
|
||||||
|
<div id="james">
|
||||||
|
James
|
||||||
|
</div>
|
||||||
|
<py-script>
|
||||||
|
from pyscript import Element
|
||||||
|
|
||||||
|
bond_div = Element("bond")
|
||||||
|
james_div = Element("james")
|
||||||
|
|
||||||
|
bond_div.clone(new_id="bond-2", to=james_div)
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Element.remove_class
|
||||||
|
|
||||||
|
| Parameter | Default | Type |
|
||||||
|
|-------------|---------|-----------------------|
|
||||||
|
| `classname` | None | `str` or `List[str]` |
|
||||||
|
|
||||||
|
Removes one or more class names from the element.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<div id="foo" class="bar baz"></div>
|
||||||
|
<py-script>
|
||||||
|
from pyscript import Element
|
||||||
|
|
||||||
|
el = Element("foo")
|
||||||
|
el.remove_class("bar")
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
|
|
||||||
|
You can also remove multiple classes by passing a list of strings.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<div id="foo" class="bar baz"></div>
|
||||||
|
<py-script>
|
||||||
|
from pyscript import Element
|
||||||
|
|
||||||
|
el = Element("foo")
|
||||||
|
el.remove_class(["bar", "baz"]) # Remove all classes from element
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Element.add_class
|
||||||
|
|
||||||
|
| Parameter | Default | Type |
|
||||||
|
|-------------|---------|-----------------------|
|
||||||
|
| `classname` | None | `str` or `List[str]` |
|
||||||
|
|
||||||
|
Adds one or more class names to the element.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<style> .red { color: red; } </style>
|
||||||
|
<div id="foo">Hi!</div>
|
||||||
|
<py-script>
|
||||||
|
from pyscript import Element
|
||||||
|
el = Element("foo")
|
||||||
|
el.add_class("red")
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
|
|
||||||
|
You can also add multiple classes at once by passing a list of strings.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<style> .red { color: red; } .bold { font-weight: bold; } </style>
|
||||||
|
<div id="foo">Hi!</div>
|
||||||
|
<py-script>
|
||||||
|
from pyscript import Element
|
||||||
|
el = Element("foo")
|
||||||
|
el.add_class(["red", "bold"])
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
16
docs/reference/API/version_info.md
Normal file
16
docs/reference/API/version_info.md
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
# `version_info`
|
||||||
|
|
||||||
|
`PyScript.version_info` is a `namedtuple` representing the current version of PyScript. It can be used to compare whether current version precedes or follows a desired version. For a human-readable version of the same info, see [`__version__`](__version__.md)
|
||||||
|
|
||||||
|
```sh
|
||||||
|
>>> pyscript.version_info
|
||||||
|
version_info(year=2023, month=2, minor=1, releaselevel='dev')
|
||||||
|
```
|
||||||
|
|
||||||
|
## Version Fields
|
||||||
|
| **parameter** | **CalVer equivalent field** | **example value** | **description** |
|
||||||
|
|-----------------|-----------------------------|---------------|------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| `year` | Full year (YYYY) | 2023 | The year of the release; when printed or represented as a string, always written with 4 digits |
|
||||||
|
| `month` | Short Month (MM) | 2 | The month of the release; when printed or represented as a string, written with 1 or 2 digits as necessary |
|
||||||
|
| `minor` | | 1 | The incremental number of the release for this month; when printed or represented as a string, written with 1 or two digits as necessary |
|
||||||
|
| `releaselevel` | | 'dev' | A string representing the qualifications of this build |
|
||||||
51
docs/reference/API/when.md
Normal file
51
docs/reference/API/when.md
Normal file
@@ -0,0 +1,51 @@
|
|||||||
|
# `@when`
|
||||||
|
|
||||||
|
`@when(event_type:str = None, selector:str = None)`
|
||||||
|
|
||||||
|
The `@when` decorator attaches the decorated function or Callable as an event handler for selected objects on the page. That is, when the named event is emitted by the selected DOM elements, the decorated Python function will be called.
|
||||||
|
|
||||||
|
If the decorated function takes a single (non-self) argument, it will be passed the [Event object](https://developer.mozilla.org/en-US/docs/Web/API/Event) corresponding to the triggered event. If the function takes no (non-self) argument, it will be called with no arguments.
|
||||||
|
|
||||||
|
## Parameters
|
||||||
|
|
||||||
|
`event_type` - A string representing the event type to match against. This can be any of the [https://developer.mozilla.org/en-US/docs/Web/Events#event_listing](https://developer.mozilla.org/en-US/docs/Web/Events) that HTML elements may emit, as appropriate to their element type.
|
||||||
|
|
||||||
|
`selector` = A string containing one or more [CSS selectors](https://developer.mozilla.org/en-US/docs/Learn/CSS/Building_blocks/Selectors). The selected DOM elements will have the decorated function attacehed as an event handler.
|
||||||
|
|
||||||
|
## Examples:
|
||||||
|
|
||||||
|
The following example prints "Hello, world!" whenever the button is clicked. It demonstrates using the `@when` decorator on a Callable which takes no arguments:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<button id="my_btn">Click Me to Say Hi</button>
|
||||||
|
<py-script>
|
||||||
|
from pyscript import when
|
||||||
|
@when("click", selector="#my_btn")
|
||||||
|
def say_hello():
|
||||||
|
print(f"Hello, world!")
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
|
|
||||||
|
The following example includes three buttons - when any of the buttons is clicked, that button turns green, and the remaining two buttons turn red. This demonstrates using the `@when` decorator on a Callable which takes one argument, which is then passed the Event object from the associated event. When combined with the ability to look at other elements in on the page, this is quite a powerful feature.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<div id="container">
|
||||||
|
<button>First</button>
|
||||||
|
<button>Second</button>
|
||||||
|
<button>Third</button>
|
||||||
|
</div>
|
||||||
|
<py-script>
|
||||||
|
from pyscript import when
|
||||||
|
import js
|
||||||
|
|
||||||
|
@when("click", selector="#container button")
|
||||||
|
def highlight(evt):
|
||||||
|
#Set the clicked button's background to green
|
||||||
|
evt.target.style.backgroundColor = 'green'
|
||||||
|
|
||||||
|
#Set the background of all buttons to red
|
||||||
|
other_buttons = (button for button in js.document.querySelectorAll('button') if button != evt.target)
|
||||||
|
for button in other_buttons:
|
||||||
|
button.style.backgroundColor = 'red'
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
493
docs/reference/elements/py-config.md
Normal file
493
docs/reference/elements/py-config.md
Normal file
@@ -0,0 +1,493 @@
|
|||||||
|
# <py-config>
|
||||||
|
|
||||||
|
Use the `<py-config>` tag to set and configure general metadata along with declaring dependencies for your PyScript application. The configuration has to be set in either [TOML](https://toml.io/)(default) or [JSON](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Objects/JSON) format.
|
||||||
|
|
||||||
|
If you are unfamiliar with TOML, consider [reading about it](https://learnxinyminutes.com/docs/toml/) or if you are unfamiliar with JSON, consider reading [freecodecamp's JSON for beginners](https://www.freecodecamp.org/news/what-is-json-a-json-file-example/) guide for more information.
|
||||||
|
|
||||||
|
The `<py-config>` element should be placed within the `<body>` element.
|
||||||
|
|
||||||
|
## Attributes
|
||||||
|
|
||||||
|
| attribute | type | default | description |
|
||||||
|
|-----------|--------|---------|----------------------------------------------------------------------------------------------------------|
|
||||||
|
| **type** | string | "toml" | Syntax type of the `<py-config>`. Value can be `json` or `toml`. Default: "toml" if type is unspecified. |
|
||||||
|
| **src** | url | | Source url to an external configuration file. |
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
### Defining an inline config
|
||||||
|
|
||||||
|
- `<py-config>` using TOML (default)
|
||||||
|
|
||||||
|
```{note}
|
||||||
|
Reminder: when using TOML, any Arrays of Tables defined with double-brackets (like `[[interpreters]]` and `[[fetch]]` must come after individual keys (like `plugins = ...` and `packages=...`)
|
||||||
|
```
|
||||||
|
|
||||||
|
```html
|
||||||
|
<py-config>
|
||||||
|
[splashscreen]
|
||||||
|
autoclose = true
|
||||||
|
|
||||||
|
[[interpreters]]
|
||||||
|
src = "https://cdn.jsdelivr.net/pyodide/v0.21.2/full/pyodide.js"
|
||||||
|
name = "pyodide-0.21.2"
|
||||||
|
lang = "python"
|
||||||
|
</py-config>
|
||||||
|
```
|
||||||
|
|
||||||
|
- `<py-config>` using JSON via `type` attribute
|
||||||
|
|
||||||
|
```html
|
||||||
|
<py-config type="json">
|
||||||
|
{
|
||||||
|
"splashscreen": {
|
||||||
|
"autoclose": true
|
||||||
|
},
|
||||||
|
"interpreters": [{
|
||||||
|
"src": "https://cdn.jsdelivr.net/pyodide/v0.21.2/full/pyodide.js",
|
||||||
|
"name": "pyodide-0.21.2",
|
||||||
|
"lang": "python"
|
||||||
|
}]
|
||||||
|
}
|
||||||
|
</py-config>
|
||||||
|
```
|
||||||
|
|
||||||
|
### Defining a file based config
|
||||||
|
|
||||||
|
- Use of the `src` attribute
|
||||||
|
|
||||||
|
```html
|
||||||
|
<py-config src="./custom.toml"></py-config>
|
||||||
|
```
|
||||||
|
where `custom.toml` contains
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[splashscreen]
|
||||||
|
autoclose = true
|
||||||
|
|
||||||
|
[[interpreters]]
|
||||||
|
src = "https://cdn.jsdelivr.net/pyodide/v0.21.2/full/pyodide.js"
|
||||||
|
name = "pyodide-0.21.2"
|
||||||
|
lang = "python"
|
||||||
|
```
|
||||||
|
|
||||||
|
- JSON using the `type` and `src` attribute
|
||||||
|
|
||||||
|
```html
|
||||||
|
<py-config type="json" src="./custom.json"></py-config>
|
||||||
|
```
|
||||||
|
where `custom.json` contains
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"splashscreen": {
|
||||||
|
"autoclose": true,
|
||||||
|
},
|
||||||
|
"interpreters": [{
|
||||||
|
"src": "https://cdn.jsdelivr.net/pyodide/v0.21.2/full/pyodide.js",
|
||||||
|
"name": "pyodide-0.21.2",
|
||||||
|
"lang": "python"
|
||||||
|
}]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Mixing inline and file based configs
|
||||||
|
|
||||||
|
One can also use both i.e pass the config from `src` attribute as well as specify it as `inline`. So the following snippet is also valid:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<py-config src="./custom.toml">
|
||||||
|
[[fetch]]
|
||||||
|
files = ["./utils.py"]
|
||||||
|
</py-config>
|
||||||
|
```
|
||||||
|
|
||||||
|
This can also be done via JSON using the `type` attribute.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<py-config type="json" src="./custom.json">
|
||||||
|
{
|
||||||
|
"fetch": [{
|
||||||
|
"files": ["./utils.py"]
|
||||||
|
}]
|
||||||
|
}
|
||||||
|
</py-config>
|
||||||
|
```
|
||||||
|
|
||||||
|
Note: While the `<py-config>` tag supports both TOML and JSON, one cannot mix the type of config passed from 2 different sources i.e. the case when inline config is in TOML format while config from src is in JSON format is NOT allowed. Similarly for the opposite case.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
This is helpful in cases where a number of applications share a common configuration (which can be supplied via `src`), but their specific keys need to be customised and overridden.
|
||||||
|
|
||||||
|
The keys supplied through `inline` override the values present in config supplied via `src`.
|
||||||
|
|
||||||
|
## Dependencies and Packages
|
||||||
|
|
||||||
|
One can also declare dependencies so as to get access to many 3rd party OSS packages that are supported by PyScript.
|
||||||
|
You can also link to `.whl` files directly on disk like in our [toga example](https://github.com/pyscript/pyscript/blob/main/examples/toga/freedom.html).
|
||||||
|
|
||||||
|
Package dependencies in the `<py-config>` can be declared by using the direct link to the package URL (whl or any other format supported by the chosen interpreter) or by just providing the package name [and version]. If only the name [and version] are provided, packages will be installed directly from what's provided by your interpreter or from PyPI.
|
||||||
|
|
||||||
|
NOTICE that only pure python packages from PyPI will work and packages with C dependencies will not. These need to be built specifically for WASM (please, consult the Pyodide project for more information about what's supported and on how to build packages with C dependencies)
|
||||||
|
|
||||||
|
```html
|
||||||
|
<py-config>
|
||||||
|
packages = ["./static/wheels/travertino-0.1.3-py3-none-any.whl"]
|
||||||
|
</py-config>
|
||||||
|
```
|
||||||
|
|
||||||
|
OR in JSON like
|
||||||
|
|
||||||
|
```html
|
||||||
|
<py-config type="json">
|
||||||
|
{
|
||||||
|
"packages": ["./static/wheels/travertino-0.1.3-py3-none-any.whl"]
|
||||||
|
}
|
||||||
|
</py-config>
|
||||||
|
```
|
||||||
|
|
||||||
|
If your `.whl` is not a pure Python wheel, then open a PR or issue with [pyodide](https://github.com/pyodide/pyodide) to get it added [here](https://github.com/pyodide/pyodide/tree/main/packages).
|
||||||
|
|
||||||
|
If there's enough popular demand, the pyodide team will likely work on supporting your package. Regardless, things will likely move faster if you make the PR and consult with the team to get unblocked.
|
||||||
|
|
||||||
|
For example, NumPy and Matplotlib are available. Notice here we're using `display(fig, target="plot")`, which takes the graph and displays it in the element with the id `plot`.
|
||||||
|
|
||||||
|
|
||||||
|
```html
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
||||||
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<h1>Let's plot random numbers</h1>
|
||||||
|
<div id="plot"></div>
|
||||||
|
<py-config type="json">
|
||||||
|
{
|
||||||
|
"packages": ["numpy", "matplotlib"]
|
||||||
|
}
|
||||||
|
</py-config>
|
||||||
|
<py-script>
|
||||||
|
import matplotlib.pyplot as plt
|
||||||
|
import numpy as np
|
||||||
|
x = np.random.randn(1000)
|
||||||
|
y = np.random.randn(1000)
|
||||||
|
fig, ax = plt.subplots()
|
||||||
|
ax.scatter(x, y)
|
||||||
|
display(fig, target="plot")
|
||||||
|
</py-script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Local modules
|
||||||
|
|
||||||
|
In addition to packages, you can declare local Python modules that will
|
||||||
|
be imported in the `<py-script>` tag. For example, we can place the random
|
||||||
|
number generation steps in a function in the file `data.py`.
|
||||||
|
|
||||||
|
```python
|
||||||
|
# data.py
|
||||||
|
import numpy as np
|
||||||
|
def make_x_and_y(n):
|
||||||
|
x = np.random.randn(n)
|
||||||
|
y = np.random.randn(n)
|
||||||
|
return x, y
|
||||||
|
```
|
||||||
|
|
||||||
|
In the HTML tag `<py-config>`, paths to local modules are provided in the
|
||||||
|
`files` key within the `fetch` section. Refer to the [fetch](#fetch) section for
|
||||||
|
more details.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
||||||
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<h1>Let's plot random numbers</h1>
|
||||||
|
<div id="plot"></div>
|
||||||
|
<py-config type="toml">
|
||||||
|
packages = ["numpy", "matplotlib"]
|
||||||
|
|
||||||
|
[[fetch]]
|
||||||
|
files = ["./data.py"]
|
||||||
|
</py-config>
|
||||||
|
<py-script>
|
||||||
|
import matplotlib.pyplot as plt
|
||||||
|
from data import make_x_and_y
|
||||||
|
x, y = make_x_and_y(n=1000)
|
||||||
|
fig, ax = plt.subplots()
|
||||||
|
ax.scatter(x, y)
|
||||||
|
display(fig, target="plot")
|
||||||
|
</py-script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Supported configuration values
|
||||||
|
|
||||||
|
The following optional values are supported by `<py-config>`:
|
||||||
|
| Value | Type | Description |
|
||||||
|
| ------ | ---- | ----------- |
|
||||||
|
| `name` | string | Name of the user application. This field can be any string and is to be used by the application author for their own customization purposes. |
|
||||||
|
| `description` | string | Description of the user application. This field can be any string and is to be used by the application author for their own customization purposes. |
|
||||||
|
| `version` | string | Version of the user application. This field can be any string and is to be used by the application author for their own customization purposes. It is not related to the PyScript version. |
|
||||||
|
| `schema_version` | number | The version of the config schema which determines what all keys are supported. This can be supplied by the user so PyScript knows what to expect in the config. If not supplied, the latest version for the schema is automatically used. |
|
||||||
|
| `type` | string | Type of the project. The default is an "app" i.e. a user application |
|
||||||
|
| `author_name` | string | Name of the author. |
|
||||||
|
| `author_email` | string | Email of the author. |
|
||||||
|
| `license` | string | License to be used for the user application. |
|
||||||
|
| `autoclose_loader` | boolean | If false, PyScript will not close the loading splash screen when the startup operations finish. |
|
||||||
|
| `packages` | List of Packages | Dependencies on 3rd party OSS packages are specified here. The default value is an empty list. |
|
||||||
|
| `fetch` | List of Stuff to fetch | Local Python modules OR resources from the internet are to be specified here using a Fetch Configuration, described below. The default value is an empty list. |
|
||||||
|
| `plugins` | List of Plugins | List of Plugins are to be specified here. The default value is an empty list. |
|
||||||
|
| `interpreters` | List of Interpreters| List of Interpreter configurations, described below. The default value contains a single Pyodide based interpreter. **Note:** Currently, only a single interpreter is supported. |
|
||||||
|
| `runtimes` {bdg-warning-line}`Deprecated` | List of Runtimes | This value is deprecated, please use `interpreters`. List of runtime configurations, described below. The default value contains a single Pyodide based interpreter. |
|
||||||
|
|
||||||
|
### <a name="fetch">Fetch</a>
|
||||||
|
|
||||||
|
A fetch configuration consists of the following:
|
||||||
|
|
||||||
|
| Value | Type | Description |
|
||||||
|
|--------------|-----------------|-------------------------------------------------|
|
||||||
|
| `from` | string | Base URL for the resource to be fetched. |
|
||||||
|
| `to_folder` | string | Name of the folder to create in the filesystem. |
|
||||||
|
| `to_file` | string | Name of the target to create in the filesystem. |
|
||||||
|
| `files` | List of strings | List of files to be downloaded. |
|
||||||
|
|
||||||
|
The parameters `to_file` and `files` shouldn't be supplied together.
|
||||||
|
|
||||||
|
#### Mechanism
|
||||||
|
|
||||||
|
The `fetch` mechanism works in the following manner:
|
||||||
|
|
||||||
|
- If both `files` and `to_file` parameters are supplied: Error!
|
||||||
|
- `from` defaults to an empty string i.e. `""` to denote relative URLs of the serving directory
|
||||||
|
- `to_folder` defaults to `.` i.e. the current working directory of the filesystem
|
||||||
|
- If `files` is specified
|
||||||
|
- for each `file` present in the `files` array
|
||||||
|
- the `sourcePath` is calculated as `from + file`
|
||||||
|
- the `destination` is calculated as `to_folder + file`
|
||||||
|
- thus, the object is downloaded from `sourcePath` to `destination`
|
||||||
|
- Else i.e. `files` is NOT specified
|
||||||
|
- If `to_file` is specified
|
||||||
|
- the object is downloaded from `from` to `to_folder + to_file`
|
||||||
|
- Otherwise, calculate the `filename` at the end of `from` i.e. the part after last `/`
|
||||||
|
- the object is downloaded from `from` to `to_folder + filename at the end of 'from'`
|
||||||
|
|
||||||
|
Learn more about `fetch` on PyScript [here](https://jeff.glass/post/whats-new-pyscript-2022-12-1)
|
||||||
|
|
||||||
|
#### Use-Cases
|
||||||
|
|
||||||
|
Assumptions:
|
||||||
|
|
||||||
|
The directory being served has the following tree structure:
|
||||||
|
|
||||||
|
```
|
||||||
|
content/
|
||||||
|
├─ index.html <<< File with <py-config>
|
||||||
|
├─ info.txt
|
||||||
|
├─ data/
|
||||||
|
│ ├─ sensordata.csv
|
||||||
|
├─ packages/
|
||||||
|
│ ├─ my_package/
|
||||||
|
│ │ ├─ __init__.py
|
||||||
|
│ │ ├─ helloworld/
|
||||||
|
│ │ │ ├─ __init__.py
|
||||||
|
│ │ │ ├─ greetings.py
|
||||||
|
```
|
||||||
|
|
||||||
|
1. Fetching a single file
|
||||||
|
|
||||||
|
```html
|
||||||
|
<py-config>
|
||||||
|
[[fetch]]
|
||||||
|
files = ['info.txt']
|
||||||
|
</py-config>
|
||||||
|
```
|
||||||
|
|
||||||
|
```html
|
||||||
|
<py-script>
|
||||||
|
with open('info.txt', 'r') as fp:
|
||||||
|
print(fp.read())
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Single File with Renaming
|
||||||
|
|
||||||
|
```html
|
||||||
|
<py-config>
|
||||||
|
[[fetch]]
|
||||||
|
from = 'info.txt'
|
||||||
|
to_file = 'info_loaded_from_web.txt'
|
||||||
|
</py-config>
|
||||||
|
```
|
||||||
|
|
||||||
|
```html
|
||||||
|
<py-script>
|
||||||
|
with open('info_loaded_from_web.txt', 'r') as fp:
|
||||||
|
print(fp.read())
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Single File to another Directory
|
||||||
|
|
||||||
|
```html
|
||||||
|
<py-config>
|
||||||
|
[[fetch]]
|
||||||
|
files = ['info.txt']
|
||||||
|
to_folder = 'infofiles/loaded_info'
|
||||||
|
</py-config>
|
||||||
|
```
|
||||||
|
|
||||||
|
```html
|
||||||
|
<py-script>
|
||||||
|
with open('infofiles/loaded_info/info.txt', 'r') as fp:
|
||||||
|
print(fp.read())
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
|
|
||||||
|
4. Single File to another Directory with Renaming
|
||||||
|
|
||||||
|
```html
|
||||||
|
<py-config>
|
||||||
|
[[fetch]]
|
||||||
|
from = 'info.txt'
|
||||||
|
to_folder = 'infofiles/loaded_info'
|
||||||
|
to_file = 'info_loaded_from_web.txt'
|
||||||
|
</py-config>
|
||||||
|
```
|
||||||
|
|
||||||
|
```html
|
||||||
|
<py-script>
|
||||||
|
with open('infofiles/loaded_info/info_loaded_from_web.txt', 'r') as fp:
|
||||||
|
print(fp.read())
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
|
|
||||||
|
5. Single file from a folder to the current working directory
|
||||||
|
|
||||||
|
```html
|
||||||
|
<py-config>
|
||||||
|
[[fetch]]
|
||||||
|
from = 'data/'
|
||||||
|
files = ['sensordata.csv']
|
||||||
|
</py-config>
|
||||||
|
```
|
||||||
|
|
||||||
|
```html
|
||||||
|
<py-script>
|
||||||
|
with open('./sensordata.csv', 'r') as fp:
|
||||||
|
print(fp.read())
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
|
|
||||||
|
6. Single file from a folder to another folder (i.e. not the current working directory)
|
||||||
|
|
||||||
|
```html
|
||||||
|
<py-config>
|
||||||
|
[[fetch]]
|
||||||
|
from = 'data/'
|
||||||
|
to_folder = './local_data'
|
||||||
|
files = ['sensordata.csv']
|
||||||
|
</py-config>
|
||||||
|
```
|
||||||
|
|
||||||
|
```html
|
||||||
|
<py-script>
|
||||||
|
with open('./local_data/sensordata.csv', 'r') as fp:
|
||||||
|
print(fp.read())
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
|
|
||||||
|
7. Multiple files preserving directory structure
|
||||||
|
|
||||||
|
```html
|
||||||
|
<py-config>
|
||||||
|
[[fetch]]
|
||||||
|
from = 'packages/my_package/'
|
||||||
|
files = ['__init__.py', 'helloworld/greetings.py', 'helloworld/__init__.py']
|
||||||
|
to_folder = 'custom_pkg'
|
||||||
|
</py-config>
|
||||||
|
```
|
||||||
|
|
||||||
|
```html
|
||||||
|
<py-script>
|
||||||
|
from custom_pkg.helloworld.greetings import say_hi
|
||||||
|
print(say_hi())
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
|
|
||||||
|
8. From an API endpoint which doesn't end in a filename
|
||||||
|
|
||||||
|
```html
|
||||||
|
<py-config>
|
||||||
|
[[fetch]]
|
||||||
|
from = 'https://catfact.ninja/fact'
|
||||||
|
to_file = './cat_fact.json'
|
||||||
|
</py-config>
|
||||||
|
```
|
||||||
|
|
||||||
|
```html
|
||||||
|
<py-script>
|
||||||
|
import json
|
||||||
|
with open("cat_fact.json", "r") as fp:
|
||||||
|
data = json.load(fp)
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
|
|
||||||
|
### Interpreter
|
||||||
|
|
||||||
|
An interpreter configuration consists of the following:
|
||||||
|
|
||||||
|
| Value | Type | Description |
|
||||||
|
|--------|-------------------|-------------|
|
||||||
|
| `src` | string (Required) | URL to the interpreter source. |
|
||||||
|
| `name` | string | Name of the interpreter. This field can be any string and is to be used by the application author for their own customization purposes |
|
||||||
|
| `lang` | string | Programming language supported by the interpreter. This field can be used by the application author to provide clarification. It currently has no implications on how PyScript behaves. |
|
||||||
|
|
||||||
|
#### Example
|
||||||
|
|
||||||
|
- The default interpreter is `pyodide`, another version of which can be specified as following
|
||||||
|
|
||||||
|
```html
|
||||||
|
<py-config>
|
||||||
|
[[interpreters]]
|
||||||
|
src = "https://cdn.jsdelivr.net/pyodide/v0.20.0/full/pyodide.js"
|
||||||
|
name = "pyodide-0.20.0"
|
||||||
|
lang = "python"
|
||||||
|
</py-config>
|
||||||
|
```
|
||||||
|
|
||||||
|
```{note}
|
||||||
|
Currently, PyScript supports a single interpreter, this may change in the future.
|
||||||
|
```
|
||||||
|
|
||||||
|
## Supplying extra information (or metadata)
|
||||||
|
|
||||||
|
Besides the above schema, a user can also supply any extra keys and values that are relevant as metadata information or perhaps are being used within the application.
|
||||||
|
|
||||||
|
For example, a valid config could also be with the snippet below:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<py-config type="toml">
|
||||||
|
magic = "unicorn"
|
||||||
|
</py-config>
|
||||||
|
```
|
||||||
|
|
||||||
|
OR in JSON like
|
||||||
|
|
||||||
|
```html
|
||||||
|
<py-config type="json">
|
||||||
|
{
|
||||||
|
"magic": "unicorn"
|
||||||
|
}
|
||||||
|
</py-config>
|
||||||
|
```
|
||||||
|
|
||||||
|
If this `"magic"` key is present in config supplied via `src` and also present in config supplied via `inline`, then the value in the inline config is given priority i.e. the overriding process also works for custom keys.
|
||||||
62
docs/reference/elements/py-repl.md
Normal file
62
docs/reference/elements/py-repl.md
Normal file
@@ -0,0 +1,62 @@
|
|||||||
|
# <py-repl>
|
||||||
|
|
||||||
|
The `<py-repl>` element provides a REPL(Read Eval Print Loop) to evaluate multi-line Python and display output.
|
||||||
|
|
||||||
|
## Attributes
|
||||||
|
|
||||||
|
| attribute | type | default | description |
|
||||||
|
|-------------------|---------|---------|--------------------------------------|
|
||||||
|
| **auto-generate** | boolean | | Auto-generates REPL after evaluation |
|
||||||
|
| **output-mode** | string | "" | Determines whether the output element is cleared prior to writing output |
|
||||||
|
| **output** | string | | The id of the element to write `stdout` and `stderr` to |
|
||||||
|
| **stderr** | string | | The id of the element to write `stderr` to |
|
||||||
|
| **src** | string | | Resource to be preloaded into the REPL |
|
||||||
|
|
||||||
|
|
||||||
|
### `auto-generate`
|
||||||
|
If a \<py-repl\> tag has the `auto-generate` attribute, upon execution, another \<pr-repl\> tag will be created and added to the DOM as a sibling of the current tag.
|
||||||
|
|
||||||
|
### `output-mode`
|
||||||
|
By default, the element which displays the output from a REPL is cleared (`innerHTML` set to "") prior to each new execution of the REPL. If `output-mode` == "append", that element is not cleared, and the output is appended instead.
|
||||||
|
|
||||||
|
### `output`
|
||||||
|
The ID of an element in the DOM that `stdout` (e.g. `print()`), `stderr`, and the results of executing the repl are written to. Defaults to an automatically-generated \<div\> as the next sibling of the REPL itself.
|
||||||
|
|
||||||
|
### `stderr`
|
||||||
|
The ID of an element in the DOM that `stderr` will be written to. Defaults to None, though writes to `stderr` will still appear in the location specified by `output`.
|
||||||
|
|
||||||
|
### `src`
|
||||||
|
If a \<py-repl\> tag has the `src` attribute, during page initialization, resource in the `src` will be preloaded into the REPL. Please note that this will not run in advance. If there is content in the \<py-repl\> tag, it will be cleared and replaced with preloaded resource.
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
### `<py-repl>` element set to auto-generate
|
||||||
|
|
||||||
|
```html
|
||||||
|
<py-repl auto-generate="true"> </py-repl>
|
||||||
|
```
|
||||||
|
|
||||||
|
### `<py-repl>` element with output
|
||||||
|
|
||||||
|
The following will write "Hello! World!" to the div with id `replOutput`.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<div id="replOutput"></div>
|
||||||
|
<py-repl output="replOutput">
|
||||||
|
print("Hello!")
|
||||||
|
hello = "World!"
|
||||||
|
hello
|
||||||
|
</py-repl>
|
||||||
|
```
|
||||||
|
|
||||||
|
Note that if we `print` from the REPL (or otherwise write to `sys.stdout`), the output will be printed in the [`py-terminal`](../plugins/py-terminal.md) if is enabled.
|
||||||
|
|
||||||
|
### `<py-repl>` element with src
|
||||||
|
Preload resource from src into the REPL
|
||||||
|
```html
|
||||||
|
<py-repl id="py-repl" output="replOutput" src="./src/py/py_code.py">
|
||||||
|
If a py-repl tag has the src attribute,
|
||||||
|
the content here will be cleared and replaced.
|
||||||
|
</py-repl>
|
||||||
|
<div id="replOutput"></div>
|
||||||
|
```
|
||||||
126
docs/reference/elements/py-script.md
Normal file
126
docs/reference/elements/py-script.md
Normal file
@@ -0,0 +1,126 @@
|
|||||||
|
# <py-script>
|
||||||
|
|
||||||
|
The `<py-script>` element, also available as `<script type="py-script">`, lets you execute multi-line Python scripts both inline and via a src attribute.
|
||||||
|
|
||||||
|
## Attributes
|
||||||
|
|
||||||
|
| attribute | type | default | description |
|
||||||
|
|-----------|--------|---------|------------------------------|
|
||||||
|
| **src** | url | | You don't need to add long python code in py-script, you can provide url of the python source file in the py-script tag with the `src` attribute. When a Python file is referred with the `src` attribute it is executed, and then added to the namespace where it was referred. |
|
||||||
|
| **output**| string | | The id of a DOM element to route `sys.stdout` and `stderr` to, in addition to sending it to the `<py-terminal>`|
|
||||||
|
| **stderr**| string | | The id of a DOM element to route just `sys.stderr` to, in addition to sending it to the `<py-terminal>`|
|
||||||
|
|
||||||
|
### output
|
||||||
|
|
||||||
|
If the `output` attribute is provided, any output to [sys.stdout](https://docs.python.org/3/library/sys.html#sys.stdout) or [sys.stderr](https://docs.python.org/3/library/sys.html#sys.stderr) is written to the DOM element with the ID matching the attribute. If no DOM element is found with a matching ID, a warning is shown. The msg is output to the `innerHTML` of the HTML Element, with newlines (`\n'`) converted to breaks (`<br/>`).
|
||||||
|
|
||||||
|
This output is in addition to the output being written to the developer console and the `<py-terminal>` if it is being used.
|
||||||
|
|
||||||
|
### stderr
|
||||||
|
|
||||||
|
If the `stderr` attribute is provided, any output to [sys.stderr](https://docs.python.org/3/library/sys.html#sys.stderr) is written to the DOM element with the ID matching the attribute. If no DOM element is found with a matching ID, a warning is shown. The msg is output to the `innerHTML` of the HTML Element, with newlines (`\n'`) converted to breaks (`<br/>`).
|
||||||
|
|
||||||
|
This output is in addition to the output being written to the developer console and the `<py-terminal>` if it is being used.
|
||||||
|
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
### Inline `<py-script>` element
|
||||||
|
|
||||||
|
Let's execute this multi-line Python script to compute π and print it back onto the page
|
||||||
|
|
||||||
|
```html
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
||||||
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<py-script>
|
||||||
|
print("Let's compute π:")
|
||||||
|
def compute_pi(n):
|
||||||
|
pi = 2
|
||||||
|
for i in range(1,n):
|
||||||
|
pi *= 4 * i ** 2 / (4 * i ** 2 - 1)
|
||||||
|
return pi
|
||||||
|
|
||||||
|
pi = compute_pi(100000)
|
||||||
|
s = f"π is approximately {pi:.3f}"
|
||||||
|
print(s)
|
||||||
|
</py-script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
### Using `<py-script>` element with `src` attribute
|
||||||
|
|
||||||
|
we can also move our python code to its own file and reference it via the `src` attribute.
|
||||||
|
|
||||||
|
|
||||||
|
```python
|
||||||
|
# compute_pi.py
|
||||||
|
print("Let's compute π:")
|
||||||
|
def compute_pi(n):
|
||||||
|
pi = 2
|
||||||
|
for i in range(1,n):
|
||||||
|
pi *= 4 * i ** 2 / (4 * i ** 2 - 1)
|
||||||
|
return pi
|
||||||
|
|
||||||
|
pi = compute_pi(100000)
|
||||||
|
s = f"π is approximately {pi:.3f}"
|
||||||
|
print(s)
|
||||||
|
```
|
||||||
|
|
||||||
|
Since both compute_pi.py and index.html are in the same directory, we can reference the python file with a relative path.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
||||||
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<py-script src="compute_pi.py"></py-script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
### Writing into labeled elements
|
||||||
|
|
||||||
|
In the example above, we had a single `<py-script>` tag printing
|
||||||
|
one or more lines onto the page in order. Within the `<py-script>`, you can
|
||||||
|
use the `Element` class to create a python object for interacting with
|
||||||
|
page elements. Objects created from the `Element` class provide the `.write()` method
|
||||||
|
which enables you to send strings into the page elements referenced by those objects.
|
||||||
|
|
||||||
|
For example, we'll add some style elements and provide placeholders for
|
||||||
|
the `<py-script>` tag to write to.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
||||||
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
|
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/css/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous">
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<b><p>Today is <u><label id='today'></label></u></p></b>
|
||||||
|
<br>
|
||||||
|
<div id="pi" class="alert alert-primary"></div>
|
||||||
|
<py-script>
|
||||||
|
import datetime as dt
|
||||||
|
Element('today').write(dt.date.today().strftime('%A %B %d, %Y'))
|
||||||
|
|
||||||
|
def compute_pi(n):
|
||||||
|
pi = 2
|
||||||
|
for i in range(1,n):
|
||||||
|
pi *= 4 * i ** 2 / (4 * i ** 2 - 1)
|
||||||
|
return pi
|
||||||
|
|
||||||
|
pi = compute_pi(100000)
|
||||||
|
Element('pi').write(f'π is approximately {pi:.3f}')
|
||||||
|
</py-script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
52
docs/reference/exceptions.md
Normal file
52
docs/reference/exceptions.md
Normal file
@@ -0,0 +1,52 @@
|
|||||||
|
# Exceptions and error codes
|
||||||
|
|
||||||
|
When creating pages with PyScript, you may encounter exceptions. Each handled exception will contain a specific code which will give you more information about it.
|
||||||
|
This reference guide contains the error codes you might find and a description of each of them.
|
||||||
|
|
||||||
|
## User Errors
|
||||||
|
|
||||||
|
| Error code | Description | Recommendation |
|
||||||
|
|------------|--------------------------------|--------------------|
|
||||||
|
| PY1000 | Invalid configuration supplied | Confirm that your `py-config` tag is using a valid `TOML` or `JSON` syntax and is using the correct configuration type. |
|
||||||
|
| PY1001 | Unable to install package(s) | Confirm that the package contains a pure Python 3 wheel or the name of the package is correct. |
|
||||||
|
| PY2000 | Invalid plugin file extension | Only `.js` and `.py` files can be used when loading user plugins. Please confirm your path contains the file extension. |
|
||||||
|
| PY2001 | Plugin doesn't contain a default export | Please add `export default` to the main plugin class. |
|
||||||
|
| PY9000 | Top level await is deprecated | Create a coroutine with your code and schedule it with `asyncio.ensure_future` or similar |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Fetch Errors
|
||||||
|
|
||||||
|
These error codes are related to any exception raised when trying to fetch a resource. If, while trying to fetch a resource, we encounter a status code that is not 200, the error code will contain the HTTP status code and the `PY0` prefix. For example, if we encounter a 404 error, the error code will be `P02404`.
|
||||||
|
|
||||||
|
|
||||||
|
| Error Code | Description |
|
||||||
|
|------------|--------------------------------------------------------------|
|
||||||
|
| PY0001 | Generic fetch error, failed to fetch page from the server |
|
||||||
|
| PY0002 | Name supplied when trying to fetch resource is invalid |
|
||||||
|
| PY0401 | You are not authorized to access this resource. |
|
||||||
|
| PY0403 | You are not allowed to access this resource. |
|
||||||
|
| PY0404 | The page you are trying to fetch does not exist. |
|
||||||
|
| PY0500 | The server encountered an internal error. |
|
||||||
|
| PY0503 | The server is currently unavailable. |
|
||||||
|
|
||||||
|
## PY1001
|
||||||
|
|
||||||
|
Pyscript cannot install the package(s) you specified in your `py-config` tag. This can happen for a few reasons:
|
||||||
|
|
||||||
|
- The package does not exist
|
||||||
|
- The package does not contain a pure Python 3 wheel
|
||||||
|
- An error occurred while trying to install the package
|
||||||
|
|
||||||
|
An error banner should appear on your page with the error code and a description of the error or a traceback. You can also check the developer console for more information.
|
||||||
|
|
||||||
|
## PY2001
|
||||||
|
|
||||||
|
Javascript plugins must export a default class. This is required for PyScript to be able to load the plugin. Please add `export default` to the main plugin class. For example:
|
||||||
|
|
||||||
|
```js
|
||||||
|
export default class HelloWorldPlugin {
|
||||||
|
afterStartup(runtime) {
|
||||||
|
console.log("Hello World from the plugin!");
|
||||||
|
}
|
||||||
|
```
|
||||||
@@ -155,6 +155,6 @@ Requests and Black do not work out of the box because they weren’t meant for t
|
|||||||
|
|
||||||
For Black, it’s a design choice that can be patched. This is currently being addressed by the team at Pyodide.
|
For Black, it’s a design choice that can be patched. This is currently being addressed by the team at Pyodide.
|
||||||
|
|
||||||
Requests do not work because of the sockets issue (sockets and websockets are two different things) and requests are blocking—which you don’t want in the browser. It’ll require putting the runtime on a webworker and utilizing an assistant, but on the main thread it’s unlikely that it’ll work.
|
Requests do not work because of the sockets issue (sockets and websockets are two different things) and requests are blocking—which you don’t want in the browser. It’ll require putting the interpreter on a webworker and utilizing an assistant, but on the main thread it’s unlikely that it’ll work.
|
||||||
|
|
||||||
There are options as a path forward. For example, Requests can be leveraged using javascript libraries, or building a python async version of Requests API or a python wrapper for fetch (pyfetch), etc. The websockets library has a client side that could be made to work—given that it has all asynchronous APIs, there’s nothing fundamentally difficult about getting it to work.
|
There are options as a path forward. For example, Requests can be leveraged using javascript libraries, or building a python async version of Requests API or a python wrapper for fetch (pyfetch), etc. The websockets library has a client side that could be made to work—given that it has all asynchronous APIs, there’s nothing fundamentally difficult about getting it to work.
|
||||||
|
|||||||
@@ -1,11 +1,54 @@
|
|||||||
# Reference
|
# Reference
|
||||||
|
|
||||||
This reference section will have manually documented or fully
|
|
||||||
automated code documentation. **Coming soon!**
|
|
||||||
|
|
||||||
```{toctree}
|
```{toctree}
|
||||||
---
|
---
|
||||||
maxdepth: 1
|
maxdepth: 1
|
||||||
glob:
|
glob:
|
||||||
|
caption: Elements
|
||||||
|
---
|
||||||
|
elements/*
|
||||||
|
```
|
||||||
|
|
||||||
|
```{toctree}
|
||||||
|
---
|
||||||
|
maxdepth: 1
|
||||||
|
glob:
|
||||||
|
caption: Modules
|
||||||
|
---
|
||||||
|
modules/*
|
||||||
|
```
|
||||||
|
|
||||||
|
```{toctree}
|
||||||
|
---
|
||||||
|
maxdepth: 1
|
||||||
|
glob:
|
||||||
|
caption: Plugins
|
||||||
|
---
|
||||||
|
plugins/*
|
||||||
|
```
|
||||||
|
|
||||||
|
```{toctree}
|
||||||
|
---
|
||||||
|
maxdepth: 1
|
||||||
|
glob:
|
||||||
|
caption: API
|
||||||
|
---
|
||||||
|
API/*
|
||||||
|
```
|
||||||
|
|
||||||
|
```{toctree}
|
||||||
|
---
|
||||||
|
maxdepth: 2
|
||||||
|
glob:
|
||||||
|
caption: Exceptions
|
||||||
|
---
|
||||||
|
exceptions
|
||||||
|
```
|
||||||
|
|
||||||
|
```{toctree}
|
||||||
|
---
|
||||||
|
maxdepth: 1
|
||||||
|
caption: Miscellaneous
|
||||||
---
|
---
|
||||||
faq
|
faq
|
||||||
|
```
|
||||||
|
|||||||
77
docs/reference/modules/pyscript.md
Normal file
77
docs/reference/modules/pyscript.md
Normal file
@@ -0,0 +1,77 @@
|
|||||||
|
# pyscript
|
||||||
|
|
||||||
|
The code underlying PyScript is a JavaScript module, which is loaded and executed by the browser. This is what loads when you include, for example, `<script defer src="https://pyscript.net/latest/pyscript.js">` in your HTML.
|
||||||
|
|
||||||
|
The module is exported to the browser as `pyscript`. The exports from this module are:
|
||||||
|
|
||||||
|
## pyscript.version
|
||||||
|
|
||||||
|
Once `pyscript.js` has loaded, the version of PyScript that is currently running can be accessed via `pyscript.version`.
|
||||||
|
```html
|
||||||
|
<script defer onload="console.log(`${pyscript.version}`)" src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
|
```
|
||||||
|
```js
|
||||||
|
//example result
|
||||||
|
Object { year: 2022, month: 11, patch: 1, releaselevel: "dev" }
|
||||||
|
```
|
||||||
|
|
||||||
|
## pyscript.interpreter
|
||||||
|
|
||||||
|
The Interpreter object which is responsible for executing Python code in the Browser. Currently, all interpreters are assumed to be Pyodide interpreters, but there is flexibility to expand this to other web-based Python interpreters in future versions.
|
||||||
|
|
||||||
|
The Interpreter object has the following attributes
|
||||||
|
|
||||||
|
| attribute | type | description |
|
||||||
|
|---------------------|-----------------------|---------------------------------------------------------------------------------|
|
||||||
|
| **src** | string | The URL from which the current interpreter was fetched |
|
||||||
|
| **interface** | InterpreterInterface | A reference to the interpreter object itself |
|
||||||
|
| **globals** | any | The globals dictionary of the interpreter, if applicable/accessible |
|
||||||
|
| **name (optional)** | string | A user-designated name for the interpreter |
|
||||||
|
| **lang (optional)** | string | A user-designation for the language the interpreter runs ('Python', 'C++', etc) |
|
||||||
|
|
||||||
|
### pyscript.interpreter.src
|
||||||
|
|
||||||
|
The URL from which the current interpreter was fetched.
|
||||||
|
|
||||||
|
### pyscript.interpreter.interface
|
||||||
|
|
||||||
|
A reference to the Interpreter wrapper that PyScript uses to execute code. object itself. This allows other frameworks, modules etc to interact with the same [(Pyodide) interpreter instance](https://pyodide.org/en/stable/usage/api/js-api.html) that PyScript uses.
|
||||||
|
|
||||||
|
For example, assuming we've loaded Pyodide, we can access the methods of the Pyodide interpreter as follows:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<button onclick="logFromPython()">Click Me to Run Some Python</button>
|
||||||
|
<script>
|
||||||
|
function logFromPython(){
|
||||||
|
pyscript.interpreter.interface.runPython(`
|
||||||
|
animal = "Python"
|
||||||
|
sound = "sss"
|
||||||
|
console.warn(f"{animal}s go " + sound * 5)
|
||||||
|
`)
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
```
|
||||||
|
|
||||||
|
### pyscript.interpreter.globals
|
||||||
|
|
||||||
|
A proxy for the interpreter's `globals()` dictionary. For example:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<body>
|
||||||
|
<py-script>x = 42</py-script>
|
||||||
|
|
||||||
|
<button onclick="showX()">Click Me to Get 'x' from Python</button>
|
||||||
|
<script>
|
||||||
|
function showX(){
|
||||||
|
console.log(`In Python right now, x = ${pyscript.interpreter.globals.get('x')}`)
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
</body>
|
||||||
|
```
|
||||||
|
### pyscript.interpreter.name
|
||||||
|
|
||||||
|
A user-supplied string for the interpreter given at its creation. For user reference only - does not affect the operation of the interpreter or PyScript.
|
||||||
|
|
||||||
|
### PyScript.interpreter.lang
|
||||||
|
|
||||||
|
A user-supplied string for the language the interpreter uses given at its creation. For user reference only - does not affect the operation of the interpreter or PyScript.
|
||||||
65
docs/reference/plugins/py-splashscreen.md
Normal file
65
docs/reference/plugins/py-splashscreen.md
Normal file
@@ -0,0 +1,65 @@
|
|||||||
|
|
||||||
|
# <py-splashscreen>
|
||||||
|
|
||||||
|
This is one of the core plugins in PyScript, which is active by default. The splashscreen is the first thing you see when you open a page with Pyscript while it is loading itself and all the necessary resources.
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
You can control how `<py-splashscreen>` behaves by setting the value of the `splashscreen` configuration in your `<py-config>`.
|
||||||
|
|
||||||
|
|
||||||
|
| parameter | default | description |
|
||||||
|
|-------------|-----------|-------------|
|
||||||
|
| `autoclose` | `true` | Whether to close the splashscreen automatically when the page is ready or not |
|
||||||
|
| `enabled` | `true` | Whether to show the splashscreen or not |
|
||||||
|
|
||||||
|
### Examples
|
||||||
|
|
||||||
|
#### Disabling the splashscreen
|
||||||
|
|
||||||
|
If you don't want the splashscreen to show and log any loading messages, you can disable it by setting the splashscreen option `enabled` to `false`.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<py-config>
|
||||||
|
[splashscreen]
|
||||||
|
enabled = false
|
||||||
|
</py-config>
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Disabling autoclose
|
||||||
|
|
||||||
|
If you want to keep the splashscreen open even after the page is ready, you can disable autoclose by setting `autoclose` to `false`.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<py-config>
|
||||||
|
[splashscreen]
|
||||||
|
autoclose = false
|
||||||
|
</py-config>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Adding custom messages
|
||||||
|
|
||||||
|
You can add custom messages to the splashscreen. This is useful if you want to show the user that something is happening in the background for your PyScript app.
|
||||||
|
|
||||||
|
There are two ways to add your custom messages to the splashscreen, either by dispatching a new custom event, `py-status-message` to the document:
|
||||||
|
|
||||||
|
|
||||||
|
```js
|
||||||
|
document.dispatchEvent(new CustomEvent("py-status-message", {detail: "Hello, world!"}))
|
||||||
|
```
|
||||||
|
|
||||||
|
Or by using the `log` method of the `py-splashscreen` tag directly:
|
||||||
|
|
||||||
|
```js
|
||||||
|
const splashscreen = document.querySelector("py-splashscreen")
|
||||||
|
splashscreen.log("Hello, world!")
|
||||||
|
```
|
||||||
|
|
||||||
|
If you wish, you can also send messages directly to the splashscreen from your python code:
|
||||||
|
|
||||||
|
```python
|
||||||
|
from js import document
|
||||||
|
|
||||||
|
splashscreen = document.querySelector("py-splashscreen")
|
||||||
|
splashscreen.log("Hello, world!")
|
||||||
|
```
|
||||||
82
docs/reference/plugins/py-terminal.md
Normal file
82
docs/reference/plugins/py-terminal.md
Normal file
@@ -0,0 +1,82 @@
|
|||||||
|
# <py-terminal>
|
||||||
|
|
||||||
|
This is one of the core plugins in PyScript, which is active by default. With it, you can print to `stdout` and `stderr` from your python code, and the output will be displayed on the page in `<py-terminal>`.
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
You can control how `<py-terminal>` behaves by setting the values of the `terminal`, `docked`, and `xterm` fields in your configuration in your `<py-config>`.
|
||||||
|
|
||||||
|
For the **terminal** field, these are the values:
|
||||||
|
|
||||||
|
| value | description |
|
||||||
|
|-------|-------------|
|
||||||
|
| `false` | Don't add `<py-terminal>` to the page |
|
||||||
|
| `true` | Automatically add a `<py-terminal>` to the page |
|
||||||
|
| `"auto"` | This is the default. Automatically add a `<py-terminal auto>`, to the page. The terminal is initially hidden and automatically shown as soon as something writes to `stdout` and/or `stderr` |
|
||||||
|
|
||||||
|
For the **docked** field, these are the values:
|
||||||
|
|
||||||
|
| value | description |
|
||||||
|
|-------|-------------|
|
||||||
|
| `false` | Don't dock `<py-terminal>` to the page |
|
||||||
|
| `true` | Automatically dock a `<py-terminal>` to the page |
|
||||||
|
| `"docked"` | This is the default. Automatically add a `<py-terminal docked>`, to the page. The terminal, once visible, is automatically shown at the bottom of the page, covering the width of such page |
|
||||||
|
|
||||||
|
Please note that **docked** mode is currently used as default only when `terminal="auto"`, or *terminal* default, is used.
|
||||||
|
|
||||||
|
In all other cases it's up to the user decide if a terminal should be docked or not.
|
||||||
|
|
||||||
|
For the **xterm** field, these are the values:
|
||||||
|
|
||||||
|
| value | description |
|
||||||
|
|-------|-------------|
|
||||||
|
| `false` | This is the default. The `<py-terminal>` is a simple `<pre>` tag with some CSS styling. |
|
||||||
|
| `true` or `xterm` | The [xtermjs](http://xtermjs.org/) library is loaded and its Terminal object is used as the `<py-terminal>`. It's visibility and position are determined by the `docked` and `auto` keys in the same way as the default `<py-terminal>` |
|
||||||
|
|
||||||
|
The xterm.js [Terminal object](http://xtermjs.org/docs/api/terminal/classes/terminal/) can be accessed directly if you want to adjust its properties, add [custom parser hooks](http://xtermjs.org/docs/guides/hooks/), introduce [xterm.js addons](http://xtermjs.org/docs/guides/using-addons/), etc. Access is best achieved by awaiting the `xtermReady` attribute of the `<py-terminal>` HTML element itself:
|
||||||
|
|
||||||
|
```python
|
||||||
|
import js
|
||||||
|
import asyncio
|
||||||
|
|
||||||
|
async def adjust_term_size(columns, rows):
|
||||||
|
xterm = await js.document.querySelector('py-terminal').xtermReady
|
||||||
|
xterm.resize(columns, rows)
|
||||||
|
|
||||||
|
asyncio.ensure_future(adjust_term_size(40,10))
|
||||||
|
```
|
||||||
|
|
||||||
|
Some terminal-formatting packages read from specific environment variables to determine whether they should emit formatted output; PyScript does not set these variables explicitly - you may need to set them yourself, or force your terminal-formatting package into a state where it outputs correctly formatted output.
|
||||||
|
|
||||||
|
A couple of specific examples:
|
||||||
|
- the [rich](https://github.com/Textualize/rich) will not, by default, output colorful text, but passing `256` or `truecolor` as an argument as the `color_system` parameter to the [Console constructor](https://rich.readthedocs.io/en/stable/reference/console.html#rich.console.Console) will force it to do so. (As of rich v13)
|
||||||
|
- [termcolor](https://github.com/termcolor/termcolor) will not, by default, output colorful text, but setting `os.environ["FORCE_COLOR"] = "True"` or by passing `force_color=True` to the `colored()` function will force it to do so. (As of termcolor v2.3)
|
||||||
|
|
||||||
|
### Examples
|
||||||
|
|
||||||
|
```html
|
||||||
|
<py-config>
|
||||||
|
terminal = true
|
||||||
|
docked = false
|
||||||
|
</py-config>
|
||||||
|
|
||||||
|
<py-script>
|
||||||
|
print("Hello, world!")
|
||||||
|
</py-script>
|
||||||
|
```
|
||||||
|
|
||||||
|
This example will create a new `<py-terminal>`, the value "Hello, world!" that was printed will show in it.
|
||||||
|
|
||||||
|
You can also add one (or more) `<py-terminal>` to the page manually.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<py-script>
|
||||||
|
print("Hello, world!")
|
||||||
|
</py-script>
|
||||||
|
|
||||||
|
<py-terminal></py-terminal>
|
||||||
|
```
|
||||||
|
|
||||||
|
```{note}
|
||||||
|
If you include a `<py-terminal>` in the page, you can skip `terminal` from your `<py-config>`.
|
||||||
|
```
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
# Deployment
|
|
||||||
|
|
||||||
**Coming soon!**
|
|
||||||
@@ -11,40 +11,6 @@ If you're using [VSCode](https://code.visualstudio.com/), the
|
|||||||
[Live Server extension](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer)
|
[Live Server extension](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer)
|
||||||
can be used to reload the page as you edit the HTML file.
|
can be used to reload the page as you edit the HTML file.
|
||||||
|
|
||||||
## Trying before installing
|
|
||||||
|
|
||||||
If you're new to programming and know nothing about HTML or just want to try some of PyScript features, we recommend using the [REPL](https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop) element in the [PyScript REPL example](https://pyscript.net/examples/repl.html) instead so you can have a programming experience in a REPL that doesn't require any setup. This REPL can be used to have an interactive experience using Python directly.
|
|
||||||
|
|
||||||
Alternatively, you can also use an online editor like W3School's [TryIt Editor](https://www.w3schools.com/html/tryit.asp?filename=tryhtml_default_default) and just plug the code below into it, as shown in the [example](https://docs.pyscript.net/latest/concepts/what-is-pyscript.html#example) page and click the run button.
|
|
||||||
|
|
||||||
```html
|
|
||||||
<!DOCTYPE html>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<meta charset="utf-8" />
|
|
||||||
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
|
||||||
|
|
||||||
<title>REPL</title>
|
|
||||||
|
|
||||||
<link rel="icon" type="image/png" href="favicon.png" />
|
|
||||||
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
|
||||||
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
|
||||||
</head>
|
|
||||||
|
|
||||||
<body>
|
|
||||||
Hello world! <br>
|
|
||||||
This is the current date and time, as computed by Python:
|
|
||||||
<py-script>
|
|
||||||
from datetime import datetime
|
|
||||||
now = datetime.now()
|
|
||||||
now.strftime("%m/%d/%Y, %H:%M:%S")
|
|
||||||
</py-script>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
```
|
|
||||||
|
|
||||||
You could try changing the code above to explore and play with pyscript yourself.
|
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
There is no installation required. In this document, we'll use
|
There is no installation required. In this document, we'll use
|
||||||
@@ -62,25 +28,6 @@ the same directory as your PyScript, JavaScript, and CSS files with the
|
|||||||
following content, and open the file in your web browser. You can typically
|
following content, and open the file in your web browser. You can typically
|
||||||
open an HTML by double-clicking it in your file explorer.
|
open an HTML by double-clicking it in your file explorer.
|
||||||
|
|
||||||
```html
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
|
||||||
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
|
||||||
</head>
|
|
||||||
<body> <py-script> print('Hello, World!') </py-script> </body>
|
|
||||||
</html>
|
|
||||||
```
|
|
||||||
|
|
||||||
Notice the use of the `<py-script>` tag in the HTML body. This
|
|
||||||
is where you'll write your Python code. In the following sections, we'll
|
|
||||||
introduce the eight tags provided by PyScript.
|
|
||||||
|
|
||||||
## The py-script tag
|
|
||||||
|
|
||||||
The `<py-script>` tag lets you execute multi-line Python scripts and
|
|
||||||
print back onto the page. For example, we can compute π.
|
|
||||||
|
|
||||||
```html
|
```html
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
@@ -89,416 +36,240 @@ print back onto the page. For example, we can compute π.
|
|||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<py-script>
|
<py-script>
|
||||||
print("Let's compute π:")
|
print('Hello, World!')
|
||||||
def compute_pi(n):
|
|
||||||
pi = 2
|
|
||||||
for i in range(1,n):
|
|
||||||
pi *= 4 * i ** 2 / (4 * i ** 2 - 1)
|
|
||||||
return pi
|
|
||||||
|
|
||||||
pi = compute_pi(100000)
|
|
||||||
s = f"π is approximately {pi:.3f}"
|
|
||||||
print(s)
|
|
||||||
</py-script>
|
</py-script>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
```
|
```
|
||||||
|
|
||||||
### Writing into labeled elements
|
### Using a Local Server
|
||||||
|
|
||||||
In the example above, we had a single `<py-script>` tag printing
|
In some situations, your browser may forbid loading remote resources like `pyscript.js` and `pyscript.css` when you open an HTML file directly. When this is the case, you may see your Python code in the text of the webpage, and the [browser developer console](https://balsamiq.com/support/faqs/browserconsole/) may show an error like *"Cross origin requests are only supported for HTTP."* The fix for this is to use a [simple local server](https://developer.mozilla.org/en-US/docs/Learn/Common_questions/Tools_and_setup/set_up_a_local_testing_server) to make your html file available to the browser.
|
||||||
one or more lines onto the page in order. Within the `<py-script>`, you
|
|
||||||
have access to the `pyscript` module, which provides a `.write()` method
|
|
||||||
to send strings into labeled elements on the page.
|
|
||||||
|
|
||||||
For example, we'll add some style elements and provide placeholders for
|
If you have python installed on your system, you can use it's basic built-in server for this purpose via the command line. Change the current working directory of your terminal or command line to the folder where your HTML file is stored. From this folder, run `python -m http.server 8080 --bind 127.0.0.1` in your terminal or command line. With the server program running, point your browser to `http://localhost:8080` to view the contents of that folder. (If a file in that folder is called `index.html`, it will be displayed by default.)
|
||||||
the `<py-script>` tag to write to.
|
|
||||||
|
## A more complex example
|
||||||
|
|
||||||
|
Now that we know how you can create a simple 'Hello, World!' example, let's see a more complex example. This example will use the Demo created by [Cheuk Ting Ho](https://github.com/Cheukting). In this example, we will use more features from PyScript.
|
||||||
|
|
||||||
|
### Setting up the base index file
|
||||||
|
|
||||||
|
Let's create a new file called `index.html` and add the following content:
|
||||||
|
|
||||||
```html
|
```html
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
|
<title>Ice Cream Picker</title>
|
||||||
|
<meta charset="utf-8">
|
||||||
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
||||||
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/css/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous">
|
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body>
|
<body>
|
||||||
<b><p>Today is <u><label id='today'></label></u></p></b>
|
|
||||||
<br>
|
</body>
|
||||||
<div id="pi" class="alert alert-primary"></div>
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
In this first step, we have created the index file, imported `pyscript.css` and `pyscript.js`. We are ready to start adding the elements we need for our application.
|
||||||
|
|
||||||
|
### Importing the needed libraries
|
||||||
|
|
||||||
|
For this example, we will need to install `pandas` and `matplotlib`. We can install libraries using the `<py-config>` tag so we can import them later. Please refer to the [`<py-config>`](../reference/elements/py-config.md) documentation for more information.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<title>Ice Cream Picker</title>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
||||||
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
|
||||||
|
<py-config>
|
||||||
|
packages = ["matplotlib", "pandas"]
|
||||||
|
</py-config>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
### Importing the data and exploring
|
||||||
|
|
||||||
|
Now that we have installed the needed libraries, we can import and explore the data. In this step, we need to create a `<py-script>` tag to import our dependencies, read the data with pandas and then use `py-repl` to explore the data.
|
||||||
|
|
||||||
|
You may want to read the [`<py-script>`](../reference/elements/py-script.md) and [`<py-repl>`](../reference/elements/py-repl.md) documentation for more information about these elements.
|
||||||
|
|
||||||
|
|
||||||
|
```html
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<title>Ice Cream Picker</title>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
||||||
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
|
||||||
|
<py-config>
|
||||||
|
packages = ["matplotlib", "pandas"]
|
||||||
|
</py-config>
|
||||||
|
|
||||||
<py-script>
|
<py-script>
|
||||||
import datetime as dt
|
import pandas as pd
|
||||||
pyscript.write('today', dt.date.today().strftime('%A %B %d, %Y'))
|
|
||||||
|
|
||||||
def compute_pi(n):
|
from pyodide.http import open_url
|
||||||
pi = 2
|
|
||||||
for i in range(1,n):
|
|
||||||
pi *= 4 * i ** 2 / (4 * i ** 2 - 1)
|
|
||||||
return pi
|
|
||||||
|
|
||||||
pi = compute_pi(100000)
|
url = (
|
||||||
pyscript.write('pi', f'π is approximately {pi:.3f}')
|
"https://raw.githubusercontent.com/Cheukting/pyscript-ice-cream/main/bj-products.csv"
|
||||||
|
)
|
||||||
|
ice_data = pd.read_csv(open_url(url))
|
||||||
</py-script>
|
</py-script>
|
||||||
|
|
||||||
|
<py-repl>
|
||||||
|
ice_data
|
||||||
|
</py-repl>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
```
|
```
|
||||||
|
|
||||||
## The py-config tag
|
Note that we are adding `ice_data` to `py-repl` to pre-populate the REPL with this variable, so you don't have to type it yourself.
|
||||||
|
|
||||||
Use the `<py-config>` tag to set and configure general metadata along with declaring dependencies for your PyScript application. The configuration has to be set in either TOML or JSON format. If you are unfamiliar with JSON, consider reading [freecodecamp's JSON for beginners](https://www.freecodecamp.org/news/what-is-json-a-json-file-example/) guide for more information. And for TOML, consider reading about it [here](https://learnxinyminutes.com/docs/toml/).
|
### Creating the plot
|
||||||
|
|
||||||
The ideal place to use `<py-config>` in between the `<head>...</head>` tags.
|
Now that we have the data, we can create the plot. We will use the `matplotlib` library to make the plot. We will use the `display` API to display the plot on the page. You may want to read the [`display`](../reference/API/display.md) documentation for more information.
|
||||||
|
|
||||||
The `<py-config>` tag can be used as follows:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<py-config>
|
|
||||||
autoclose_loader = true
|
|
||||||
|
|
||||||
[[runtimes]]
|
|
||||||
src = "https://cdn.jsdelivr.net/pyodide/v0.21.2/full/pyodide.js"
|
|
||||||
name = "pyodide-0.21.2"
|
|
||||||
lang = "python"
|
|
||||||
</py-config>
|
|
||||||
```
|
|
||||||
|
|
||||||
Alternatively, a JSON config can be passed using the `type` attribute.
|
|
||||||
|
|
||||||
```html
|
|
||||||
<py-config type="json">
|
|
||||||
{
|
|
||||||
"autoclose_loader": true,
|
|
||||||
"runtimes": [{
|
|
||||||
"src": "https://cdn.jsdelivr.net/pyodide/v0.21.2/full/pyodide.js",
|
|
||||||
"name": "pyodide-0.21.2",
|
|
||||||
"lang": "python"
|
|
||||||
}]
|
|
||||||
}
|
|
||||||
</py-config>
|
|
||||||
```
|
|
||||||
|
|
||||||
Besides passing the config as inline (as shown above), one can also pass it with the `src` attribute. This is demonstrated below:
|
|
||||||
|
|
||||||
```
|
|
||||||
<py-config src="./custom.toml"></py-config>
|
|
||||||
```
|
|
||||||
|
|
||||||
where `custom.toml` contains
|
|
||||||
|
|
||||||
```
|
|
||||||
autoclose_loader = true
|
|
||||||
[[runtimes]]
|
|
||||||
src = "https://cdn.jsdelivr.net/pyodide/v0.21.2/full/pyodide.js"
|
|
||||||
name = "pyodide-0.21.2"
|
|
||||||
lang = "python"
|
|
||||||
```
|
|
||||||
|
|
||||||
This can also be done via JSON using the `type` attribute. By default, `type` is set to `"toml"` if not supplied.
|
|
||||||
|
|
||||||
```
|
|
||||||
<py-config type="json" src="./custom.json"></py-config>
|
|
||||||
```
|
|
||||||
|
|
||||||
where `custom.json` contains
|
|
||||||
|
|
||||||
```
|
|
||||||
{
|
|
||||||
"autoclose_loader": true,
|
|
||||||
"runtimes": [{
|
|
||||||
"src": "https://cdn.jsdelivr.net/pyodide/v0.21.2/full/pyodide.js",
|
|
||||||
"name": "pyodide-0.21.2",
|
|
||||||
"lang": "python"
|
|
||||||
}]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
One can also use both i.e pass the config from `src` attribute as well as specify it as `inline`. So the following snippet is also valid:
|
|
||||||
|
|
||||||
```
|
|
||||||
<py-config src="./custom.toml">
|
|
||||||
paths = ["./utils.py"]
|
|
||||||
</py-config>
|
|
||||||
```
|
|
||||||
|
|
||||||
This can also be done via JSON using the `type` attribute.
|
|
||||||
|
|
||||||
```
|
|
||||||
<py-config type="json" src="./custom.json">
|
|
||||||
{
|
|
||||||
"paths": ["./utils.py"]
|
|
||||||
}
|
|
||||||
</py-config>
|
|
||||||
```
|
|
||||||
|
|
||||||
Note: While the `<py-config>` tag supports both TOML and JSON, one cannot mix the type of config passed from 2 different sources i.e. the case when inline config is in TOML format while config from src is in JSON format is NOT allowed. Similarly for the opposite case.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
This is helpful in cases where a number of applications share a common configuration (which can be supplied via `src`), but their specific keys need to be customised and overridden.
|
|
||||||
|
|
||||||
The keys supplied through `inline` override the values present in config supplied via `src`.
|
|
||||||
|
|
||||||
One can also declare dependencies so as to get access to many 3rd party OSS packages that are supported by PyScript.
|
|
||||||
You can also link to `.whl` files directly on disk like in our [toga example](https://github.com/pyscript/pyscript/blob/main/examples/toga/freedom.html).
|
|
||||||
|
|
||||||
```
|
|
||||||
<py-config>
|
|
||||||
packages = ["./static/wheels/travertino-0.1.3-py3-none-any.whl"]
|
|
||||||
</py-config>
|
|
||||||
```
|
|
||||||
|
|
||||||
OR in JSON like
|
|
||||||
|
|
||||||
```
|
|
||||||
<py-config type="json">
|
|
||||||
{
|
|
||||||
"packages": ["./static/wheels/travertino-0.1.3-py3-none-any.whl"]
|
|
||||||
}
|
|
||||||
</py-config>
|
|
||||||
```
|
|
||||||
|
|
||||||
If your `.whl` is not a pure Python wheel, then open a PR or issue with [pyodide](https://github.com/pyodide/pyodide) to get it added [here](https://github.com/pyodide/pyodide/tree/main/packages).
|
|
||||||
If there's enough popular demand, the pyodide team will likely work on supporting your package. Regardless, things will likely move faster if you make the PR and consult with the team to get unblocked.
|
|
||||||
For example, NumPy and Matplotlib are available. Notice here we're using `<py-script output="plot">`
|
|
||||||
as a shortcut, which takes the expression on the last line of the script and runs `pyscript.write('plot', fig)`.
|
|
||||||
```html
|
```html
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
|
<title>Ice Cream Picker</title>
|
||||||
|
<meta charset="utf-8">
|
||||||
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
||||||
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
<py-config type="json">
|
</head>
|
||||||
{
|
<body>
|
||||||
"packages": ["numpy", "matplotlib"]
|
|
||||||
}
|
<py-config>
|
||||||
|
packages = ["matplotlib", "pandas"]
|
||||||
</py-config>
|
</py-config>
|
||||||
</head>
|
|
||||||
|
|
||||||
<body>
|
<py-script>
|
||||||
<h1>Let's plot random numbers</h1>
|
import pandas as pd
|
||||||
<div id="plot"></div>
|
|
||||||
<py-script output="plot">
|
|
||||||
import matplotlib.pyplot as plt
|
import matplotlib.pyplot as plt
|
||||||
import numpy as np
|
|
||||||
x = np.random.randn(1000)
|
from pyodide.http import open_url
|
||||||
y = np.random.randn(1000)
|
|
||||||
|
url = (
|
||||||
|
"https://raw.githubusercontent.com/Cheukting/pyscript-ice-cream/main/bj-products.csv"
|
||||||
|
)
|
||||||
|
ice_data = pd.read_csv(open_url(url))
|
||||||
|
|
||||||
|
def plot(data):
|
||||||
|
plt.rcParams["figure.figsize"] = (22,20)
|
||||||
fig, ax = plt.subplots()
|
fig, ax = plt.subplots()
|
||||||
ax.scatter(x, y)
|
bars = ax.barh(data["name"], data["rating"], height=0.7)
|
||||||
fig
|
ax.bar_label(bars)
|
||||||
|
plt.title("Rating of ice cream flavours of your choice")
|
||||||
|
display(fig, target="graph-area", append=False)
|
||||||
|
|
||||||
|
plot(ice_data)
|
||||||
</py-script>
|
</py-script>
|
||||||
|
|
||||||
|
<py-repl>
|
||||||
|
ice_data
|
||||||
|
</py-repl>
|
||||||
|
|
||||||
|
<div id="graph-area"></div>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
```
|
```
|
||||||
|
|
||||||
### Local modules
|
### Select specific flavours
|
||||||
In addition to packages, you can declare local Python modules that will
|
|
||||||
be imported in the `<py-script>` tag. For example, we can place the random
|
|
||||||
number generation steps in a function in the file `data.py`.
|
|
||||||
```python
|
|
||||||
# data.py
|
|
||||||
import numpy as np
|
|
||||||
def make_x_and_y(n):
|
|
||||||
x = np.random.randn(n)
|
|
||||||
y = np.random.randn(n)
|
|
||||||
return x, y
|
|
||||||
```
|
|
||||||
|
|
||||||
In the HTML tag `<py-config>`, paths to local modules are provided in the
|
Now that we have a way to explore the data using `py-repl` and a way to create the plot using all of the data, it's time for us to add a way to select specific flavours.
|
||||||
`paths:` key.
|
|
||||||
|
|
||||||
```html
|
```html
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
|
<title>Ice Cream Picker</title>
|
||||||
|
<meta charset="utf-8">
|
||||||
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
||||||
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
<py-config type="toml">
|
</head>
|
||||||
packages = ["numpy", "matplotlib"]
|
<body>
|
||||||
paths = ["./data.py"]
|
|
||||||
|
<py-config>
|
||||||
|
packages = ["matplotlib", "pandas"]
|
||||||
</py-config>
|
</py-config>
|
||||||
</head>
|
|
||||||
|
|
||||||
<body>
|
<py-script>
|
||||||
<h1>Let's plot random numbers</h1>
|
import js
|
||||||
<div id="plot"></div>
|
import pandas as pd
|
||||||
<py-script output="plot">
|
|
||||||
import matplotlib.pyplot as plt
|
import matplotlib.pyplot as plt
|
||||||
from data import make_x_and_y
|
|
||||||
x, y = make_x_and_y(n=1000)
|
from pyodide.http import open_url
|
||||||
|
from pyodide.ffi import create_proxy
|
||||||
|
|
||||||
|
url = (
|
||||||
|
"https://raw.githubusercontent.com/Cheukting/pyscript-ice-cream/main/bj-products.csv"
|
||||||
|
)
|
||||||
|
ice_data = pd.read_csv(open_url(url))
|
||||||
|
|
||||||
|
current_selected = []
|
||||||
|
flavour_elements = js.document.getElementsByName("flavour")
|
||||||
|
|
||||||
|
def plot(data):
|
||||||
|
plt.rcParams["figure.figsize"] = (22,20)
|
||||||
fig, ax = plt.subplots()
|
fig, ax = plt.subplots()
|
||||||
ax.scatter(x, y)
|
bars = ax.barh(data["name"], data["rating"], height=0.7)
|
||||||
fig
|
ax.bar_label(bars)
|
||||||
|
plt.title("Rating of ice cream flavours of your choice")
|
||||||
|
display(fig, target="graph-area", append=False)
|
||||||
|
|
||||||
|
def select_flavour(event):
|
||||||
|
for ele in flavour_elements:
|
||||||
|
if ele.checked:
|
||||||
|
current_selected = ele.value
|
||||||
|
break
|
||||||
|
if current_selected == "ALL":
|
||||||
|
plot(ice_data)
|
||||||
|
else:
|
||||||
|
filter = ice_data.apply(lambda x: ele.value in x["ingredients"], axis=1)
|
||||||
|
plot(ice_data[filter])
|
||||||
|
|
||||||
|
ele_proxy = create_proxy(select_flavour)
|
||||||
|
|
||||||
|
for ele in flavour_elements:
|
||||||
|
if ele.value == "ALL":
|
||||||
|
ele.checked = True
|
||||||
|
current_selected = ele.value
|
||||||
|
ele.addEventListener("change", ele_proxy)
|
||||||
|
|
||||||
|
plot(ice_data)
|
||||||
|
|
||||||
</py-script>
|
</py-script>
|
||||||
|
|
||||||
|
<div id="input" style="margin: 20px;">
|
||||||
|
Select your 🍨 flavour: <br/>
|
||||||
|
<input type="radio" id="all" name="flavour" value="ALL">
|
||||||
|
<label for="all"> All 🍧</label>
|
||||||
|
<input type="radio" id="chocolate" name="flavour" value="COCOA">
|
||||||
|
<label for="chocolate"> Chocolate 🍫</label>
|
||||||
|
<input type="radio" id="cherry" name="flavour" value="CHERRIES">
|
||||||
|
<label for="cherry"> Cherries 🍒</label>
|
||||||
|
<input type="radio" id="berries" name="flavour" value="BERRY">
|
||||||
|
<label for="berries"> Berries 🍓</label>
|
||||||
|
<input type="radio" id="cheese" name="flavour" value="CHEESE">
|
||||||
|
<label for="cheese"> Cheese 🧀</label>
|
||||||
|
<input type="radio" id="peanut" name="flavour" value="PEANUT">
|
||||||
|
<label for="peanut"> Peanut 🥜</label>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<py-repl>
|
||||||
|
ice_data
|
||||||
|
</py-repl>
|
||||||
|
|
||||||
|
<div id="graph-area"></div>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
```
|
```
|
||||||
|
|
||||||
The following optional values are supported by `<py-config>`:
|
|
||||||
| Value | Type | Description |
|
|
||||||
| ------ | ---- | ----------- |
|
|
||||||
| `name` | string | Name of the user application. This field can be any string and is to be used by the application author for their own customization purposes. |
|
|
||||||
| `description` | string | Description of the user application. This field can be any string and is to be used by the application author for their own customization purposes. |
|
|
||||||
| `version` | string | Version of the user application. This field can be any string and is to be used by the application author for their own customization purposes. It is not related to the PyScript version. |
|
|
||||||
| `schema_version` | number | The version of the config schema which determines what all keys are supported. This can be supplied by the user so PyScript knows what to expect in the config. If not supplied, the latest version for the schema is automatically used. |
|
|
||||||
| `type` | string | Type of the project. The default is an "app" i.e. a user application |
|
|
||||||
| `author_name` | string | Name of the author. |
|
|
||||||
| `author_email` | string | Email of the author. |
|
|
||||||
| `license` | string | License to be used for the user application. |
|
|
||||||
| `autoclose_loader` | boolean | If false, PyScript will not close the loading splash screen when the startup operations finish. |
|
|
||||||
| `packages` | List of Packages | Dependencies on 3rd party OSS packages are specified here. The default value is an empty list. |
|
|
||||||
| `paths` | List of Paths | Local Python modules are to be specified here. The default value is an empty list. |
|
|
||||||
| `plugins` | List of Plugins | List of Plugins are to be specified here. The default value is an empty list. |
|
|
||||||
| `runtimes` | List of Runtimes | List of runtime configurations, described below. The default value contains a single Pyodide based runtime. |
|
|
||||||
|
|
||||||
A runtime configuration consists of the following:
|
|
||||||
| Value | Type | Description |
|
|
||||||
| ----- | ---- | ----------- |
|
|
||||||
| `src` | string (Required) | URL to the runtime source. |
|
|
||||||
| `name` | string | Name of the runtime. This field can be any string and is to be used by the application author for their own customization purposes |
|
|
||||||
| `lang` | string | Programming language supported by the runtime. This field can be used by the application author to provide clarification. It currently has no implications on how PyScript behaves. |
|
|
||||||
|
|
||||||
Besides the above format, a user can also supply any extra keys and values that are relevant as metadata information or perhaps are being used within the application.
|
|
||||||
|
|
||||||
For example, a valid config could also be with the snippet below:
|
|
||||||
|
|
||||||
```
|
|
||||||
<py-config type="toml">
|
|
||||||
magic = "unicorn"
|
|
||||||
</py-config>
|
|
||||||
```
|
|
||||||
|
|
||||||
OR in JSON like
|
|
||||||
|
|
||||||
```
|
|
||||||
<py-config type="json">
|
|
||||||
{
|
|
||||||
"magic": "unicorn"
|
|
||||||
}
|
|
||||||
</py-config>
|
|
||||||
```
|
|
||||||
|
|
||||||
If this `"magic"` key is present in config supplied via `src` and also present in config supplied via `inline`, then the value in the inline config is given priority i.e. the overriding process also works for custom keys.
|
|
||||||
|
|
||||||
## The py-env tag (Deprecated)
|
|
||||||
|
|
||||||
**The <py-env> tag is deprecated as of `2022.09.1` release but you can still use the functionality explained below. It will be removed in the next release. To specify packages in the recommended way, please see the <py-config> section.**
|
|
||||||
|
|
||||||
In addition to the [Python Standard Library](https://docs.python.org/3/library/) and
|
|
||||||
the `pyscript` module, many 3rd-party OSS packages will work out-of-the-box with PyScript.
|
|
||||||
|
|
||||||
In order to use them, you will need to declare the dependencies using the `<py-env>` tag in the
|
|
||||||
HTML head. You can also link to `.whl` files directly on disk like in our [toga example](https://github.com/pyscript/pyscript/blob/main/examples/toga/freedom.html).
|
|
||||||
|
|
||||||
```
|
|
||||||
<py-env>
|
|
||||||
- './static/wheels/travertino-0.1.3-py3-none-any.whl'
|
|
||||||
</py-env>
|
|
||||||
```
|
|
||||||
|
|
||||||
If your `.whl` is not a pure Python wheel, then open a PR or issue with [pyodide](https://github.com/pyodide/pyodide) to get it added [here](https://github.com/pyodide/pyodide/tree/main/packages).
|
|
||||||
If there's enough popular demand, the pyodide team will likely work on supporting your package. Regardless, things will likely move faster if you make the PR and consult with the team to get unblocked.
|
|
||||||
|
|
||||||
For example, NumPy and Matplotlib are available. Notice here we're using `<py-script output="plot">`
|
|
||||||
as a shortcut, which takes the expression on the last line of the script and runs `pyscript.write('plot', fig)`.
|
|
||||||
|
|
||||||
```html
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
|
||||||
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
|
||||||
<py-env>
|
|
||||||
- numpy
|
|
||||||
- matplotlib
|
|
||||||
</py-env>
|
|
||||||
</head>
|
|
||||||
|
|
||||||
<body>
|
|
||||||
<h1>Let's plot random numbers</h1>
|
|
||||||
<div id="plot"></div>
|
|
||||||
<py-script output="plot">
|
|
||||||
import matplotlib.pyplot as plt
|
|
||||||
import numpy as np
|
|
||||||
|
|
||||||
x = np.random.randn(1000)
|
|
||||||
y = np.random.randn(1000)
|
|
||||||
|
|
||||||
fig, ax = plt.subplots()
|
|
||||||
ax.scatter(x, y)
|
|
||||||
fig
|
|
||||||
</py-script>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Local modules with py-env (Deprecated)
|
|
||||||
|
|
||||||
**The <py-env> tag is deprecated as of `2022.09.1` release but you can still use the functionality explained below. It will be removed in the next release. To specify local modules in the recommended way, please see the <py-config> section.**
|
|
||||||
|
|
||||||
In addition to packages, you can declare local Python modules that will
|
|
||||||
be imported in the `<py-script>` tag. For example, we can place the random
|
|
||||||
number generation steps in a function in the file `data.py`.
|
|
||||||
```python
|
|
||||||
# data.py
|
|
||||||
import numpy as np
|
|
||||||
def make_x_and_y(n):
|
|
||||||
x = np.random.randn(n)
|
|
||||||
y = np.random.randn(n)
|
|
||||||
return x, y
|
|
||||||
```
|
|
||||||
|
|
||||||
In the HTML tag `<py-env>`, paths to local modules are provided in the
|
|
||||||
`paths:` key.
|
|
||||||
|
|
||||||
```html
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
|
||||||
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
|
||||||
<py-env>
|
|
||||||
- numpy
|
|
||||||
- matplotlib
|
|
||||||
- paths:
|
|
||||||
- ./data.py
|
|
||||||
</py-env>
|
|
||||||
</head>
|
|
||||||
|
|
||||||
<body>
|
|
||||||
<h1>Let's plot random numbers</h1>
|
|
||||||
<div id="plot"></div>
|
|
||||||
<py-script output="plot">
|
|
||||||
import matplotlib.pyplot as plt
|
|
||||||
from data import make_x_and_y
|
|
||||||
x, y = make_x_and_y(n=1000)
|
|
||||||
fig, ax = plt.subplots()
|
|
||||||
ax.scatter(x, y)
|
|
||||||
fig
|
|
||||||
</py-script>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
```
|
|
||||||
|
|
||||||
## The py-repl tag
|
|
||||||
|
|
||||||
The `<py-repl>` tag creates a REPL component that is rendered to the page as a code editor, allowing you to write executable code inline.
|
|
||||||
```html
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
|
||||||
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
|
||||||
</head>
|
|
||||||
<py-repl></py-repl>
|
|
||||||
</html>
|
|
||||||
```
|
|
||||||
|
|
||||||
## Visual component tags
|
|
||||||
|
|
||||||
The following tags can be used to add visual attributes to your HTML page.
|
|
||||||
|
|
||||||
| Tag | Description |
|
|
||||||
| --- | ----------- |
|
|
||||||
| `<py-inputbox>` | Adds an input box that can be used to prompt users to enter input values. |
|
|
||||||
| `<py-box>` | Creates a container object that can be used to host one or more visual components that define how elements of `<py-box>` should align and show on the page. |
|
|
||||||
| `<py-button>` | Adds a button to which authors can add labels and event handlers for actions on the button, such as `on_focus` or `on_click`. |
|
|
||||||
| `<py-title>` | Adds a static text title component that styles the text inside the tag as a page title. |
|
|
||||||
|
|
||||||
```{note}
|
|
||||||
All the elements above are experimental and not implemented at their full functionality. Use them with the understanding that the APIs or full support might change or be removed until the visual components are more mature.
|
|
||||||
```
|
|
||||||
|
|||||||
@@ -1,12 +1,38 @@
|
|||||||
# Tutorials
|
# Tutorials
|
||||||
|
|
||||||
This is the tutorials section for beginners.
|
This section contains pyscript tutorials. Each tutorial is a self-contained document that will guide you through a specific topic.
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
This tutorial will guide you through getting started with PyScript, from installation to writing your first PyScript application. The getting started will show you how to specify dependencies, read a csv file from the web, use `pandas` and `matplotlib` and how to handle user input.
|
||||||
|
|
||||||
|
[Read the get started tutorial](getting-started.md)
|
||||||
|
|
||||||
|
|
||||||
|
## Basics
|
||||||
|
|
||||||
|
This section contains tutorials about the basics of PyScript.
|
||||||
|
|
||||||
```{toctree}
|
```{toctree}
|
||||||
---
|
---
|
||||||
maxdepth: 2
|
maxdepth: 1
|
||||||
|
glob:
|
||||||
---
|
---
|
||||||
getting-started
|
writing-to-page
|
||||||
deployment
|
py-click
|
||||||
setup
|
requests
|
||||||
|
```
|
||||||
|
|
||||||
|
## PyScript Configuration
|
||||||
|
|
||||||
|
This section contains tutorials about the PyScript configuration using the `<py-config>` tag.
|
||||||
|
|
||||||
|
|
||||||
|
```{toctree}
|
||||||
|
---
|
||||||
|
maxdepth: 1
|
||||||
|
glob:
|
||||||
|
---
|
||||||
|
py-config-fetch
|
||||||
|
py-config-interpreter
|
||||||
```
|
```
|
||||||
|
|||||||
127
docs/tutorials/py-click.md
Normal file
127
docs/tutorials/py-click.md
Normal file
@@ -0,0 +1,127 @@
|
|||||||
|
# Handling click events
|
||||||
|
|
||||||
|
This tutorial will show you how to use the `py-click` attribute to handle mouse clicks on elements on your page. The `py-click` attribute is a special attribute that allows you to specify a Python function that will be called when the element is clicked. There are many other events such as py-mouseover, py-focus, py-input, py-keyress etc, which can be used as well. They are listed here [Attr-to-Event](../reference/API/attr_to_event.html)
|
||||||
|
|
||||||
|
## Development setup
|
||||||
|
|
||||||
|
Let's start by building the base HTML page. We will create an HTML page with a button and a paragraph. When the button is clicked, the paragraph will show the current time.
|
||||||
|
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
||||||
|
|
||||||
|
<title>Current Time</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
||||||
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Adding elements to the page
|
||||||
|
|
||||||
|
Let's add a button and a paragraph to the page. The button will have the `py-click` attribute, and the paragraph will have the `id` attribute. The `id` attribute is used to identify the element on the page, and the `py-click` attribute will be used to specify the function that will be called when the button is clicked.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
||||||
|
|
||||||
|
<title>Current Time</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
||||||
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<button py-click="current_time()" id="get-time" class="py-button">Get current time</button>
|
||||||
|
<p id="current-time"></p>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
There are two things to note here:
|
||||||
|
|
||||||
|
- You must specify an id for an element that uses any `py-*` attribute
|
||||||
|
- We used the `py-button` class to style the button, this is optional, and these rules are coming from the pyscript.css that we added in the `<head>` section.
|
||||||
|
|
||||||
|
## Creating the Python function
|
||||||
|
|
||||||
|
In this step, we will create the Python function that will be called when the button is clicked. This function will get the current time and update the paragraph with the current time. We will use a `<py-script>` tag to specify the Python code that will be executed when the page is loaded.
|
||||||
|
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
||||||
|
|
||||||
|
<title>Current Time</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
||||||
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<button py-click="current_time()" id="get-time" class="py-button">Get current time</button>
|
||||||
|
<p id="current-time"></p>
|
||||||
|
|
||||||
|
<py-script>
|
||||||
|
import datetime
|
||||||
|
|
||||||
|
def current_time():
|
||||||
|
now = datetime.datetime.now()
|
||||||
|
</py-script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Writing the time to the page
|
||||||
|
|
||||||
|
If you run the example, you will notice that nothing happened. This is because we still need to update the paragraph with the current time. We can do this by using the [`Element` API](../reference/API/element.md) to get the paragraph element and then update it with the current time with the `write` method.
|
||||||
|
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
||||||
|
|
||||||
|
<title>Current Time</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
||||||
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<button py-click="current_time()" id="get-time" class="py-button">Get current time</button>
|
||||||
|
<p id="current-time"></p>
|
||||||
|
|
||||||
|
<py-script>
|
||||||
|
from pyscript import Element
|
||||||
|
import datetime
|
||||||
|
|
||||||
|
def current_time():
|
||||||
|
now = datetime.datetime.now()
|
||||||
|
|
||||||
|
# Get paragraph element by id
|
||||||
|
paragraph = Element("current-time")
|
||||||
|
|
||||||
|
# Add current time to the paragraph element
|
||||||
|
paragraph.write(now.strftime("%Y-%m-%d %H:%M:%S"))
|
||||||
|
</py-script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
Now, if you refresh the page and click the button, the paragraph will be updated with the current time.
|
||||||
188
docs/tutorials/py-config-fetch.md
Normal file
188
docs/tutorials/py-config-fetch.md
Normal file
@@ -0,0 +1,188 @@
|
|||||||
|
# Using the fetch from py-config
|
||||||
|
|
||||||
|
This tutorial shows how to use the fetch configuration from `py-config` to fetch two files from a remote server, store them in a local directory, and verify their contents.
|
||||||
|
|
||||||
|
## Development setup
|
||||||
|
|
||||||
|
We will create a todo list application similar to the one in the [examples](https://pyscript.net/examples/todo.html). To do this, we need three things:
|
||||||
|
|
||||||
|
* An `index.html` file containing the HTML for the application.
|
||||||
|
* A `todo.py` file containing the Python code for the application.
|
||||||
|
* A `utils.py` file containing some utility functions for the application.
|
||||||
|
|
||||||
|
|
||||||
|
We will use the `fetch` configuration from `py-config` to fetch these files from a remote server and store them in a local directory.
|
||||||
|
|
||||||
|
### Creating the html file
|
||||||
|
|
||||||
|
In this first step, we will create the `index.html` file and import both `pyscript.css` and `pyscript.js`. These are needed to run our Python code in the browser and style the application.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
||||||
|
|
||||||
|
<title>My Todo</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
||||||
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fetching the files
|
||||||
|
|
||||||
|
### Using `fetch` to get the python files
|
||||||
|
|
||||||
|
Now we will use the `fetch` configuration from `py-config` to fetch the `todo.py` and `utils.py` files from a remote server and store them in a local directory called `todo`. Here we will fetch files from different URLs, using a `fetch` per item.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
||||||
|
|
||||||
|
<title>My Todo</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
||||||
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<py-config>
|
||||||
|
[[fetch]]
|
||||||
|
from = "https://pyscript.net/examples/"
|
||||||
|
files = ["utils.py"]
|
||||||
|
[[fetch]]
|
||||||
|
from = "https://gist.githubusercontent.com/FabioRosado/faba0b7f6ad4438b07c9ac567c73b864/raw/37603b76dc7ef7997bf36781ea0116150f727f44/"
|
||||||
|
files = ["todo.py"]
|
||||||
|
</py-config>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Creating a todo application
|
||||||
|
|
||||||
|
### Creating the todo elements
|
||||||
|
|
||||||
|
Now we will create the todo elements in the `body` of the `index.html` file.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
||||||
|
|
||||||
|
<title>My Todo</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
||||||
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<py-config>
|
||||||
|
[[fetch]]
|
||||||
|
from = "https://pyscript.net/examples/"
|
||||||
|
files = ["utils.py"]
|
||||||
|
[[fetch]]
|
||||||
|
from = "https://gist.githubusercontent.com/FabioRosado/faba0b7f6ad4438b07c9ac567c73b864/raw/37603b76dc7ef7997bf36781ea0116150f727f44/"
|
||||||
|
files = ["todo.py"]
|
||||||
|
</py-config>
|
||||||
|
<section>
|
||||||
|
<div class="text-center w-full mb-8">
|
||||||
|
<h1 class="text-3xl font-bold text-gray-800 uppercase tracking-tight">To Do List</h1>
|
||||||
|
</div>
|
||||||
|
<div>
|
||||||
|
<input id="new-task-content" class="py-input" type="text">
|
||||||
|
<button id="new-task-btn" class="py-button" type="submit" py-click="add_task()">
|
||||||
|
Add task
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
<div id="list-tasks-container" class="flex flex-col-reverse mt-4"></div>
|
||||||
|
<template id="task-template">
|
||||||
|
<section class="task py-li-element">
|
||||||
|
<label for="flex items-center p-2 ">
|
||||||
|
<input class="mr-2" type="checkbox">
|
||||||
|
<p class="m-0 inline"></p>
|
||||||
|
</label>
|
||||||
|
</section>
|
||||||
|
</template>
|
||||||
|
</section>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
Our todo application is starting to shape up, although if you try to add any tasks, you will notice that nothing happens. This is because we have not yet imported the `todo.py` file.
|
||||||
|
|
||||||
|
### Importing the needed functions from `todo.py`
|
||||||
|
|
||||||
|
This is where the magic happens. We can import the `todo.py` file by adding it as a source to the `py-script` tag. By specifying the file, pyscript will automatically import the file and run the code in it.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
||||||
|
|
||||||
|
<title>My Todo</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
||||||
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<py-config>
|
||||||
|
[[fetch]]
|
||||||
|
from = "https://pyscript.net/examples/"
|
||||||
|
files = ["utils.py"]
|
||||||
|
[[fetch]]
|
||||||
|
from = "https://gist.githubusercontent.com/FabioRosado/faba0b7f6ad4438b07c9ac567c73b864/raw/37603b76dc7ef7997bf36781ea0116150f727f44/"
|
||||||
|
files = ["todo.py"]
|
||||||
|
</py-config>
|
||||||
|
<py-script>
|
||||||
|
from todo import add_task, add_task_event
|
||||||
|
</py-script>
|
||||||
|
<section>
|
||||||
|
<div class="text-center w-full mb-8">
|
||||||
|
<h1 class="text-3xl font-bold text-gray-800 uppercase tracking-tight">To Do List</h1>
|
||||||
|
</div>
|
||||||
|
<div>
|
||||||
|
<input id="new-task-content" class="py-input" type="text">
|
||||||
|
<button id="new-task-btn" class="py-button" type="submit" py-click="add_task()">
|
||||||
|
Add task
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
<div id="list-tasks-container" class="flex flex-col-reverse mt-4"></div>
|
||||||
|
<template id="task-template">
|
||||||
|
<section class="task py-li-element">
|
||||||
|
<label for="flex items-center p-2 ">
|
||||||
|
<input class="mr-2" type="checkbox">
|
||||||
|
<p class="m-0 inline"></p>
|
||||||
|
</label>
|
||||||
|
</section>
|
||||||
|
</template>
|
||||||
|
</section>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
You can now save the file and refresh the page. You should now be able to add tasks to your todo list.
|
||||||
|
|
||||||
|
## That's it!
|
||||||
|
|
||||||
|
You have now created a todo application using pyscript. You can add tasks and mark them as done. Let's take a recap of what we have achieved:
|
||||||
|
|
||||||
|
* We have imported three separate files into our `index.html` file using the `py-config` tag.
|
||||||
|
* We have created the necessary HTML code to create our todo's
|
||||||
|
* We have imported functions from the `todo.py` file, using the `py-script` tag.
|
||||||
|
|
||||||
|
For reference, the code from [the gist](https://gist.githubusercontent.com/FabioRosado/faba0b7f6ad4438b07c9ac567c73b864/raw/37603b76dc7ef7997bf36781ea0116150f727f44/todo.py) is the same code that our [todo example](https://pyscript.net/examples/todo.html) uses with a slight change of importing `Element` from `pyscript`.
|
||||||
88
docs/tutorials/py-config-interpreter.md
Normal file
88
docs/tutorials/py-config-interpreter.md
Normal file
@@ -0,0 +1,88 @@
|
|||||||
|
# Setting a pyodide interpreter
|
||||||
|
|
||||||
|
Pyscript will automatically set the interpreter for you, but you can also set it manually. This is useful if you want to use a different version than the one set by default.
|
||||||
|
|
||||||
|
## Development setup
|
||||||
|
|
||||||
|
To get started, let's create a new `index.html` file and import `pyscript.js`.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
||||||
|
|
||||||
|
<title>Interpreter</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
||||||
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
We are using the pyodide CDN to setup our interpreter, but you can also download the files from [the pyodide GitHub releases](https://github.com/pyodide/pyodide/releases/), unzip them and use the `pyodide.js` file as your interpreter.
|
||||||
|
|
||||||
|
## Setting the interpreter
|
||||||
|
|
||||||
|
To set the interpreter, you can use the `interpreter` configuration in the `py-config` element. In this tutorial, we will use the default `TOML` format, but know that you can also use `json` if you prefer by changing the `type` attribute of the `py-config` element.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
||||||
|
|
||||||
|
<title>Interpreter</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
||||||
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<py-config>
|
||||||
|
[[interpreters]]
|
||||||
|
src = "https://cdn.jsdelivr.net/pyodide/v0.23.0/full/pyodide.js"
|
||||||
|
name = "pyodide-0.23.0"
|
||||||
|
lang = "python"
|
||||||
|
</py-config>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Confirming the interpreter version
|
||||||
|
|
||||||
|
To confirm that the interpreter is set correctly, you can open the DevTools and check the version from the console. But for the sake of this tutorial, let's create a `py-script` tag and print pyodide's version.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
||||||
|
|
||||||
|
<title>Interpreter</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
||||||
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<py-config>
|
||||||
|
[[interpreters]]
|
||||||
|
src = "https://cdn.jsdelivr.net/pyodide/v0.23.0/full/pyodide.js"
|
||||||
|
name = "pyodide-0.23.0"
|
||||||
|
lang = "python"
|
||||||
|
</py-config>
|
||||||
|
<py-script>
|
||||||
|
import pyodide
|
||||||
|
print(pyodide.__version__)
|
||||||
|
</py-script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
123
docs/tutorials/requests.md
Normal file
123
docs/tutorials/requests.md
Normal file
@@ -0,0 +1,123 @@
|
|||||||
|
# Calling an API using Requests
|
||||||
|
|
||||||
|
This tutorial will show you how to interact with an API using the [Requests](https://requests.readthedocs.io/en/master/) library. Requests is a popular library, but it doesn't work out of the box with Pyscript. We will use the [pyodide-http](https://github.com/koenvo/pyodide-http) library to patch the Requests library, so it works with Pyscript.
|
||||||
|
|
||||||
|
We will use the [JSON Placeholder API](https://jsonplaceholder.typicode.com/), a free fake API that returns fake data.
|
||||||
|
|
||||||
|
## Development Setup
|
||||||
|
|
||||||
|
Let's build the base HTML page to add our `py-config` and `py-script` tags in the next steps.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
||||||
|
|
||||||
|
<title>Requests Tutorial</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
||||||
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Installing the dependencies
|
||||||
|
|
||||||
|
In this step, we will install the dependencies we need to use the Requests library. We will use the `py-config` tag to specify the dependencies we need to install.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
||||||
|
|
||||||
|
<title>Requests Tutorial</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
||||||
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<py-config>
|
||||||
|
packages = ["requests", "pyodide-http"]
|
||||||
|
</py-config>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Patching the Requests library
|
||||||
|
|
||||||
|
Now that we have installed the dependencies, we need to patch the Requests library to work with Pyscript. We will use the `py-script` tag to specify the code that will be executed when the page is loaded.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
||||||
|
|
||||||
|
<title>Requests Tutorial</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
||||||
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<py-config>
|
||||||
|
packages = ["requests", "pyodide-http"]
|
||||||
|
</py-config>
|
||||||
|
|
||||||
|
<py-script>
|
||||||
|
import pyodide_http
|
||||||
|
pyodide_http.patch_all()
|
||||||
|
</py-script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Making a request
|
||||||
|
|
||||||
|
Finally, let's make a request to the JSON Placeholder API to confirm that everything is working.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
||||||
|
|
||||||
|
<title>Requests Tutorial</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
||||||
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<py-config>
|
||||||
|
packages = ["requests", "pyodide-http"]
|
||||||
|
</py-config>
|
||||||
|
|
||||||
|
<py-script>
|
||||||
|
import requests
|
||||||
|
import pyodide_http
|
||||||
|
|
||||||
|
# Patch the Requests library so it works with Pyscript
|
||||||
|
pyodide_http.patch_all()
|
||||||
|
|
||||||
|
# Make a request to the JSON Placeholder API
|
||||||
|
response = requests.get("https://jsonplaceholder.typicode.com/todos")
|
||||||
|
print(response.json())
|
||||||
|
</py-script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Conclusion
|
||||||
|
|
||||||
|
In this tutorial, we learned how to use the Requests library to make requests to an API. We also learned how to use the `py-config` and `py-script` tags to install dependencies and execute code when the page is loaded.
|
||||||
|
|
||||||
|
Depending on the API you use, you may need to add additional headers to your request. You can read the [Requests documentation](https://requests.readthedocs.io/en/master/user/quickstart/#custom-headers) to learn more about how to do this.
|
||||||
|
|
||||||
|
You may also be interested in creating your module to make requests. You can read the in-depth guide on [How to make HTTP requests using `PyScript`, in pure Python](../guides/http-requests.md) to learn more about how to do this.
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
# Setup
|
|
||||||
|
|
||||||
**Coming soon!**
|
|
||||||
212
docs/tutorials/writing-to-page.md
Normal file
212
docs/tutorials/writing-to-page.md
Normal file
@@ -0,0 +1,212 @@
|
|||||||
|
# How to write content to the page
|
||||||
|
|
||||||
|
When creating your PyScript application, you will want to write content to the page. This tutorial will explore the different methods you can use to write content to the page and their differences.
|
||||||
|
|
||||||
|
## Development setup
|
||||||
|
|
||||||
|
To get started, we will create an `index.html` file, import PyScript and start building on top of it.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
||||||
|
|
||||||
|
<title>Writing to the page</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
||||||
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Writing content to an element
|
||||||
|
|
||||||
|
Let's first see how we can write content to an element on the page. We will start by creating a `div` element with an `id` of `manual-write`, then create a `py-script` tag that, upon a click of a button, will write 'Hello World' to the `div` element.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
||||||
|
|
||||||
|
<title>Writing to the page</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
||||||
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div id="manual-write"></div>
|
||||||
|
<button py-click="write_to_page()" id="manual">Say Hello</button>
|
||||||
|
|
||||||
|
<py-script>
|
||||||
|
def write_to_page():
|
||||||
|
manual_div = Element("manual-write")
|
||||||
|
manual_div.element.innerText = "Hello World"
|
||||||
|
</py-script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
```{note}
|
||||||
|
When using `py-click` you must supply an `id` to the element you want to use as the trigger.
|
||||||
|
```
|
||||||
|
|
||||||
|
We can now open our `index.html` file and click the button. You will see that "Hello World" will appear in the `div` element. You could also write HTML using `manual_div.element.innerHTML` instead of `innerText`. For example:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
||||||
|
|
||||||
|
<title>Writing to the page</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
||||||
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div id="manual-write"></div>
|
||||||
|
<button py-click="write_to_page()" id="manual">Say Hello</button>
|
||||||
|
|
||||||
|
<py-script>
|
||||||
|
def write_to_page():
|
||||||
|
manual_div = Element("manual-write")
|
||||||
|
manual_div.element.innerHTML = "<p><b>Hello World</b></p>"
|
||||||
|
</py-script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Writing content with the `display` API
|
||||||
|
|
||||||
|
The `display` API is a simple way to write content to the page. Not only does it allow you to write content to the page, but it also allows you to display a range of different content types such as images, markdown, svgs, json, etc.
|
||||||
|
|
||||||
|
Using the' display' API, let's reuse our previous example and write "Hello World" to the page.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
||||||
|
|
||||||
|
<title>Writing to the page</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
||||||
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div id="manual-write"></div>
|
||||||
|
<button py-click="write_to_page()" id="manual">Say Hello</button>
|
||||||
|
<div id="display-write"></div>
|
||||||
|
<button py-click="display_to_div()" id="display">Say Things!</button>
|
||||||
|
|
||||||
|
<py-script>
|
||||||
|
def write_to_page():
|
||||||
|
manual_div = Element("manual-write")
|
||||||
|
manual_div.element.innerHTML = "<p><b>Hello World</b></p>"
|
||||||
|
|
||||||
|
def display_to_div():
|
||||||
|
display("I display things!", target="display-write")
|
||||||
|
</py-script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
```{note}
|
||||||
|
When using the `display` API, you must specify the `target` parameter to tell PyScript where to write the content. If you do not use this parameter, an error will be thrown.
|
||||||
|
```
|
||||||
|
|
||||||
|
You may be interested in reading more about the `display` API in the [Display API](../reference/api/display) section of the documentation.
|
||||||
|
|
||||||
|
## Printing to the page
|
||||||
|
|
||||||
|
We couldn't have a tutorial on writing to the page without mentioning the `print` function. The `print` function is a simple way to write content to the page, that any Python developer will be familiar with. When you use the `print` function, the content will be written to the page in a `py-terminal` element.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
||||||
|
|
||||||
|
<title>Writing to the page</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
||||||
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div id="manual-write"></div>
|
||||||
|
<button py-click="write_to_page()" id="manual">Say Hello</button>
|
||||||
|
<div id="display-write"></div>
|
||||||
|
<button py-click="display_to_div()" id="display">Say Things!</button>
|
||||||
|
<button py-click="print_to_page()" id="print">Print Things!</button>
|
||||||
|
|
||||||
|
<py-script>
|
||||||
|
def write_to_page():
|
||||||
|
manual_div = Element("manual-write")
|
||||||
|
manual_div.element.innerHTML = "<p><b>Hello World</b></p>"
|
||||||
|
|
||||||
|
def display_to_div():
|
||||||
|
display("I display things!", target="display-write")
|
||||||
|
|
||||||
|
def print_to_page():
|
||||||
|
print("I print things!")
|
||||||
|
</py-script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
You may be surprised to see that when you click the "Print Things!" button, the content is written below the rest of the elements on the page in a black canvas. This is because the `print` function writes content to the page in a `py-terminal` element. You can read more about the `py-terminal` element in the [Terminal Element](../reference/plugins/py-terminal) section of the documentation.
|
||||||
|
|
||||||
|
PyScript comes with the `py-terminal` plugin by default and any `stdout` or `stderr` content will be shown in this element. We can be explicit about where we want the terminal to be shown by adding the `<py-terminal>` tag to our HTML.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
||||||
|
|
||||||
|
<title>Writing to the page</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
||||||
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div id="manual-write"></div>
|
||||||
|
<button py-click="write_to_page()" id="manual">Say Hello</button>
|
||||||
|
<div id="display-write"></div>
|
||||||
|
<button py-click="display_to_div()" id="display">Say Things!</button>
|
||||||
|
<div>
|
||||||
|
<py-terminal>
|
||||||
|
</div>
|
||||||
|
<button py-click="print_to_page()" id="print">Print Things!</button>
|
||||||
|
|
||||||
|
<py-script>
|
||||||
|
def write_to_page():
|
||||||
|
manual_div = Element("manual-write")
|
||||||
|
manual_div.element.innerHTML = "<p><b>Hello World</b></p>"
|
||||||
|
|
||||||
|
def display_to_div():
|
||||||
|
display("I display things!", target="display-write")
|
||||||
|
|
||||||
|
def print_to_page():
|
||||||
|
print("I print things!")
|
||||||
|
</py-script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
@@ -1,62 +1,90 @@
|
|||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<title>Altair</title>
|
<title>Altair</title>
|
||||||
<meta charset="utf-8">
|
<meta charset="utf-8" />
|
||||||
<link rel="icon" type="image/x-icon" href="./favicon.png">
|
<link rel="icon" type="image/x-icon" href="./favicon.png" />
|
||||||
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
<link
|
||||||
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
rel="stylesheet"
|
||||||
|
href="https://pyscript.net/latest/pyscript.css"
|
||||||
|
/>
|
||||||
|
<link rel="stylesheet" href="./assets/css/examples.css" />
|
||||||
|
<style>
|
||||||
|
py-script {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
<script
|
||||||
|
type="module"
|
||||||
|
src="https://esm.sh/@pyscript/core@latest/core.js"
|
||||||
|
></script>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<nav class="navbar" style="background-color: #000000">
|
||||||
|
<div class="app-header">
|
||||||
|
<a href="/">
|
||||||
|
<img src="./logo.png" class="logo" />
|
||||||
|
</a>
|
||||||
|
<a class="title" href="" style="color: #f0ab3c">Altair</a>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
<section class="pyscript">
|
||||||
|
<div id="altair"></div>
|
||||||
|
<py-tutor>
|
||||||
<py-config>
|
<py-config>
|
||||||
packages = [
|
packages = [
|
||||||
"altair",
|
"altair",
|
||||||
"pandas",
|
"pandas",
|
||||||
"vega_datasets"
|
"vega_datasets"
|
||||||
]
|
]
|
||||||
|
plugins = [
|
||||||
|
"https://pyscript.net/latest/plugins/python/py_tutor.py"
|
||||||
|
]
|
||||||
</py-config>
|
</py-config>
|
||||||
</head>
|
<py-script>
|
||||||
<body>
|
from pyscript import display
|
||||||
<div id="altair" style="width: 100%; height: 100%"></div>
|
import altair as alt
|
||||||
<py-script output="altair">
|
from vega_datasets import data
|
||||||
import altair as alt
|
|
||||||
from vega_datasets import data
|
|
||||||
|
|
||||||
source = data.movies.url
|
source = data.movies.url
|
||||||
|
|
||||||
pts = alt.selection(type="single", encodings=['x'])
|
pts = alt.selection(type="single", encodings=['x'])
|
||||||
|
|
||||||
rect = alt.Chart(data.movies.url).mark_rect().encode(
|
rect = alt.Chart(data.movies.url).mark_rect().encode(
|
||||||
alt.X('IMDB_Rating:Q', bin=True),
|
alt.X('IMDB_Rating:Q', bin=True),
|
||||||
alt.Y('Rotten_Tomatoes_Rating:Q', bin=True),
|
alt.Y('Rotten_Tomatoes_Rating:Q', bin=True),
|
||||||
alt.Color('count()',
|
alt.Color('count()',
|
||||||
scale=alt.Scale(scheme='greenblue'),
|
scale=alt.Scale(scheme='greenblue'),
|
||||||
legend=alt.Legend(title='Total Records')
|
legend=alt.Legend(title='Total Records')
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
|
|
||||||
circ = rect.mark_point().encode(
|
circ = rect.mark_point().encode(
|
||||||
alt.ColorValue('grey'),
|
alt.ColorValue('grey'),
|
||||||
alt.Size('count()',
|
alt.Size('count()',
|
||||||
legend=alt.Legend(title='Records in Selection')
|
legend=alt.Legend(title='Records in Selection')
|
||||||
)
|
)
|
||||||
).transform_filter(
|
).transform_filter(
|
||||||
pts
|
pts
|
||||||
)
|
)
|
||||||
|
|
||||||
bar = alt.Chart(source).mark_bar().encode(
|
bar = alt.Chart(source).mark_bar().encode(
|
||||||
x='Major_Genre:N',
|
x='Major_Genre:N',
|
||||||
y='count()',
|
y='count()',
|
||||||
color=alt.condition(pts, alt.ColorValue("steelblue"), alt.ColorValue("grey"))
|
color=alt.condition(pts, alt.ColorValue("steelblue"), alt.ColorValue("grey"))
|
||||||
).properties(
|
).properties(
|
||||||
width=550,
|
width=550,
|
||||||
height=200
|
height=200
|
||||||
).add_selection(pts)
|
).add_selection(pts)
|
||||||
|
|
||||||
alt.vconcat(
|
display(alt.vconcat(
|
||||||
rect + circ,
|
rect + circ,
|
||||||
bar
|
bar
|
||||||
).resolve_legend(
|
).resolve_legend(
|
||||||
color="independent",
|
color="independent",
|
||||||
size="independent"
|
size="independent"
|
||||||
)
|
), target="altair")
|
||||||
</py-script>
|
</py-script>
|
||||||
|
</py-tutor>
|
||||||
|
</section>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|||||||
@@ -1,21 +1,39 @@
|
|||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<title>Antigravity</title>
|
<title>Antigravity</title>
|
||||||
<meta charset="utf-8">
|
<meta charset="utf-8" />
|
||||||
<link rel="icon" type="image/x-icon" href="./favicon.png">
|
<link rel="icon" type="image/x-icon" href="./favicon.png" />
|
||||||
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
<link
|
||||||
|
rel="stylesheet"
|
||||||
|
href="https://pyscript.net/latest/pyscript.css"
|
||||||
|
/>
|
||||||
|
<link rel="stylesheet" href="./assets/css/examples.css" />
|
||||||
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
</head>
|
</head>
|
||||||
<py-config>
|
|
||||||
paths = [
|
|
||||||
"./antigravity.py"
|
|
||||||
]
|
|
||||||
</py-config>
|
|
||||||
<body>
|
<body>
|
||||||
|
<nav class="navbar" style="background-color: #000000">
|
||||||
|
<div class="app-header">
|
||||||
|
<a href="/">
|
||||||
|
<img src="./logo.png" class="logo" />
|
||||||
|
</a>
|
||||||
|
<a class="title" href="" style="color: #f0ab3c">Antigravity</a>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
<py-tutor modules="antigravity.py">
|
||||||
|
<section class="pyscript">
|
||||||
|
<py-config>
|
||||||
|
plugins = [
|
||||||
|
"https://pyscript.net/latest/plugins/python/py_tutor.py"
|
||||||
|
]
|
||||||
|
[[fetch]]
|
||||||
|
files = ["./antigravity.py"]
|
||||||
|
</py-config>
|
||||||
<b>Based on xkcd: antigravity https://xkcd.com/353/.</b>
|
<b>Based on xkcd: antigravity https://xkcd.com/353/.</b>
|
||||||
<py-script>
|
<py-script>
|
||||||
import antigravity
|
import antigravity
|
||||||
antigravity.fly()
|
antigravity.fly()
|
||||||
</py-script>
|
</py-script>
|
||||||
|
</section>
|
||||||
|
</py-tutor>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
import random
|
import random
|
||||||
import sys
|
|
||||||
|
|
||||||
from js import DOMParser, document, setInterval
|
from js import DOMParser, document, setInterval
|
||||||
from pyodide.ffi import create_proxy
|
from pyodide.ffi import create_proxy
|
||||||
@@ -7,13 +6,13 @@ from pyodide.http import open_url
|
|||||||
|
|
||||||
|
|
||||||
class Antigravity:
|
class Antigravity:
|
||||||
|
|
||||||
url = "./antigravity.svg"
|
url = "./antigravity.svg"
|
||||||
|
|
||||||
def __init__(self, target=None, interval=10, append=True, fly=False):
|
def __init__(self, target=None, interval=10, append=True, fly=False):
|
||||||
target = target or sys.stdout._out
|
|
||||||
self.target = (
|
self.target = (
|
||||||
document.getElementById(target) if isinstance(target, str) else target
|
document.getElementById(target)
|
||||||
|
if isinstance(target, str)
|
||||||
|
else document.body
|
||||||
)
|
)
|
||||||
doc = DOMParser.new().parseFromString(
|
doc = DOMParser.new().parseFromString(
|
||||||
open_url(self.url).read(), "image/svg+xml"
|
open_url(self.url).read(), "image/svg+xml"
|
||||||
|
|||||||
91
examples/assets/css/examples.css
Normal file
91
examples/assets/css/examples.css
Normal file
@@ -0,0 +1,91 @@
|
|||||||
|
body {
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.pyscript {
|
||||||
|
margin: 0.5rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.code {
|
||||||
|
display: flex;
|
||||||
|
position: absolute;
|
||||||
|
right: 0px;
|
||||||
|
z-index: 9998;
|
||||||
|
top: 7rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (max-width: 1300px) {
|
||||||
|
.code:has(> .code-section-visible) {
|
||||||
|
width: 90%;
|
||||||
|
/* Absolute position is messing up the layout on small screens */
|
||||||
|
right: 70px;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.code-section-hidden {
|
||||||
|
width: 0px;
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.code-section-visible {
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
width: 100%;
|
||||||
|
background-color: rgb(45 46 53 / 90%);
|
||||||
|
padding: 1rem;
|
||||||
|
border-radius: 10px 0px 0px 10px;
|
||||||
|
color: #c6c6c8;
|
||||||
|
}
|
||||||
|
.code-section-visible p {
|
||||||
|
margin: 0;
|
||||||
|
font-style: italic;
|
||||||
|
font-size: small;
|
||||||
|
}
|
||||||
|
|
||||||
|
.language-html,
|
||||||
|
.language-python {
|
||||||
|
float: left;
|
||||||
|
}
|
||||||
|
|
||||||
|
#view-code-button {
|
||||||
|
writing-mode: tb-rl;
|
||||||
|
text-orientation: sideways-right;
|
||||||
|
background-color: #1d1d22;
|
||||||
|
color: white;
|
||||||
|
padding: 0.5rem;
|
||||||
|
border-radius: 5px;
|
||||||
|
cursor: pointer;
|
||||||
|
height: 81px;
|
||||||
|
}
|
||||||
|
|
||||||
|
nav {
|
||||||
|
position: sticky;
|
||||||
|
width: 100%;
|
||||||
|
top: 0;
|
||||||
|
left: 0;
|
||||||
|
z-index: 9999;
|
||||||
|
}
|
||||||
|
|
||||||
|
.logo {
|
||||||
|
padding-right: 10px;
|
||||||
|
font-size: 28px;
|
||||||
|
height: 30px;
|
||||||
|
max-width: inherit;
|
||||||
|
}
|
||||||
|
|
||||||
|
.title {
|
||||||
|
text-decoration: none;
|
||||||
|
text-decoration-line: none;
|
||||||
|
text-decoration-style: initial;
|
||||||
|
text-decoration-color: initial;
|
||||||
|
font-weight: 400;
|
||||||
|
font-size: 1.5em;
|
||||||
|
line-height: 2em;
|
||||||
|
white-space: nowrap;
|
||||||
|
}
|
||||||
|
|
||||||
|
.app-header {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
padding: 0.5rem 1rem;
|
||||||
|
}
|
||||||
@@ -2,8 +2,8 @@
|
|||||||
margin-bottom: 5rem;
|
margin-bottom: 5rem;
|
||||||
}
|
}
|
||||||
|
|
||||||
.example h2{
|
.example h2 {
|
||||||
color: #000000;
|
/* color: #000000; */
|
||||||
font-family: "Inconsolata", monospace;
|
font-family: "Inconsolata", monospace;
|
||||||
font-size: 2.25rem;
|
font-size: 2.25rem;
|
||||||
margin-bottom: 1rem;
|
margin-bottom: 1rem;
|
||||||
@@ -11,10 +11,17 @@
|
|||||||
|
|
||||||
.card {
|
.card {
|
||||||
height: 15rem;
|
height: 15rem;
|
||||||
background-color: #FFFFFF;
|
background-color: var(--color-secondary);
|
||||||
padding: 1rem;
|
padding: 1rem;
|
||||||
-webkit-box-shadow: var(--card-shadow);
|
border-radius: 10px;
|
||||||
box-shadow: var(--card-shadow);
|
}
|
||||||
|
|
||||||
|
.card:hover,
|
||||||
|
.card:hover a,
|
||||||
|
.card:hover a:visited,
|
||||||
|
.card:hover h2 {
|
||||||
|
background-color: var(--color-primary);
|
||||||
|
color: #1d1d22;
|
||||||
}
|
}
|
||||||
|
|
||||||
.card a h2 {
|
.card a h2 {
|
||||||
@@ -24,6 +31,17 @@
|
|||||||
font-size: 2.25rem;
|
font-size: 2.25rem;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.card a p {
|
||||||
|
color: var(--text-color);
|
||||||
|
}
|
||||||
|
|
||||||
|
a .card {
|
||||||
|
height: 100%;
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
justify-content: space-between;
|
||||||
|
}
|
||||||
|
|
||||||
.card-content {
|
.card-content {
|
||||||
height: 100%;
|
height: 100%;
|
||||||
display: flex;
|
display: flex;
|
||||||
@@ -31,6 +49,11 @@
|
|||||||
justify-content: space-between;
|
justify-content: space-between;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.card-content a,
|
||||||
|
.card-content a:visited {
|
||||||
|
color: var(--color-primary);
|
||||||
|
}
|
||||||
|
|
||||||
.container-card {
|
.container-card {
|
||||||
max-width: 1500px;
|
max-width: 1500px;
|
||||||
margin: 0 auto;
|
margin: 0 auto;
|
||||||
|
|||||||
@@ -2,6 +2,15 @@
|
|||||||
@import "./variables.css";
|
@import "./variables.css";
|
||||||
@import "./reset.css";
|
@import "./reset.css";
|
||||||
|
|
||||||
|
body {
|
||||||
|
background: #2d2e35
|
||||||
|
url("https://assets.anaconda.com/production/Content/1650828148240.png?w=3240&auto=compress%2Cformat&fit=crop&dm=1650828161&s=c558dc55e0ed1f8419a892e842a5728f")
|
||||||
|
repeat-x center bottom / 250px;
|
||||||
|
background-attachment: fixed;
|
||||||
|
overflow-x: hidden;
|
||||||
|
color: var(--text-color);
|
||||||
|
}
|
||||||
|
|
||||||
.container {
|
.container {
|
||||||
max-width: 1510px;
|
max-width: 1510px;
|
||||||
margin: auto;
|
margin: auto;
|
||||||
@@ -9,7 +18,6 @@
|
|||||||
}
|
}
|
||||||
|
|
||||||
.title-main {
|
.title-main {
|
||||||
color: #000000;
|
|
||||||
font-size: 4.25rem;
|
font-size: 4.25rem;
|
||||||
font-family: "Inconsolata", monospace;
|
font-family: "Inconsolata", monospace;
|
||||||
text-align: center;
|
text-align: center;
|
||||||
|
|||||||
@@ -1,4 +1,6 @@
|
|||||||
:root {
|
:root {
|
||||||
--color-primary: #2563eb;
|
--color-primary: #fda703;
|
||||||
|
--color-secondary: #1d1d22;
|
||||||
|
--text-color: white;
|
||||||
--card-shadow: 0px 5px 11px 0px rgb(0 0 0 / 15%);
|
--card-shadow: 0px 5px 11px 0px rgb(0 0 0 / 15%);
|
||||||
}
|
}
|
||||||
|
|||||||
3
examples/assets/prism/prism.min.css
vendored
Normal file
3
examples/assets/prism/prism.min.css
vendored
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
/* PrismJS 1.29.0
|
||||||
|
https://prismjs.com/download.html#themes=prism-okaidia&languages=markup+clike+javascript+python */
|
||||||
|
code[class*=language-],pre[class*=language-]{color:#f8f8f2;background:0 0;text-shadow:0 1px rgba(0,0,0,.3);font-family:Consolas,Monaco,'Andale Mono','Ubuntu Mono',monospace;font-size:1em;text-align:left;white-space:pre;word-spacing:normal;word-break:normal;word-wrap:normal;line-height:1.5;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-hyphens:none;-moz-hyphens:none;-ms-hyphens:none;hyphens:none}pre[class*=language-]{padding:1em;margin:.5em 0;overflow:auto;border-radius:.3em}:not(pre)>code[class*=language-],pre[class*=language-]{background:#272822}:not(pre)>code[class*=language-]{padding:.1em;border-radius:.3em;white-space:normal}.token.cdata,.token.comment,.token.doctype,.token.prolog{color:#8292a2}.token.punctuation{color:#f8f8f2}.token.namespace{opacity:.7}.token.constant,.token.deleted,.token.property,.token.symbol,.token.tag{color:#f92672}.token.boolean,.token.number{color:#ae81ff}.token.attr-name,.token.builtin,.token.char,.token.inserted,.token.selector,.token.string{color:#a6e22e}.language-css .token.string,.style .token.string,.token.entity,.token.operator,.token.url,.token.variable{color:#f8f8f2}.token.atrule,.token.attr-value,.token.class-name,.token.function{color:#e6db74}.token.keyword{color:#66d9ef}.token.important,.token.regex{color:#fd971f}.token.bold,.token.important{font-weight:700}.token.italic{font-style:italic}.token.entity{cursor:help}
|
||||||
7
examples/assets/prism/prism.min.js
vendored
Normal file
7
examples/assets/prism/prism.min.js
vendored
Normal file
File diff suppressed because one or more lines are too long
@@ -1,10 +1,13 @@
|
|||||||
<!DOCTYPE html>
|
<!doctype html>
|
||||||
<html lang="en">
|
<html lang="en">
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8" />
|
<meta charset="utf-8" />
|
||||||
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
||||||
<title>Async Await BLOCKING LOOP Pyscript Twice</title>
|
<title>Async Await BLOCKING LOOP Pyscript Twice</title>
|
||||||
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
<link
|
||||||
|
rel="stylesheet"
|
||||||
|
href="https://pyscript.net/latest/pyscript.css"
|
||||||
|
/>
|
||||||
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
|
|||||||
@@ -1,15 +1,19 @@
|
|||||||
<!DOCTYPE html>
|
<!doctype html>
|
||||||
<html lang="en">
|
<html lang="en">
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8" />
|
<meta charset="utf-8" />
|
||||||
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
||||||
<title>Async Await BLOCKING LOOP Pyscript Twice</title>
|
<title>Async Await BLOCKING LOOP Pyscript Twice</title>
|
||||||
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
<link
|
||||||
|
rel="stylesheet"
|
||||||
|
href="https://pyscript.net/latest/pyscript.css"
|
||||||
|
/>
|
||||||
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<div>
|
<div>
|
||||||
Pyscript - FIRST ASYNC WITH INVOKED LOOP BLOCKING AWAIT AT SAME LEVEL AS LOOP Pyscript writing to console.log:
|
Pyscript - FIRST ASYNC WITH INVOKED LOOP BLOCKING AWAIT AT SAME
|
||||||
|
LEVEL AS LOOP Pyscript writing to console.log:
|
||||||
<py-script>
|
<py-script>
|
||||||
import js
|
import js
|
||||||
import asyncio
|
import asyncio
|
||||||
@@ -23,7 +27,8 @@
|
|||||||
</py-script>
|
</py-script>
|
||||||
</div>
|
</div>
|
||||||
<div>
|
<div>
|
||||||
Pyscript - SECOND ASYNC WITH INVOKED LOOP BLOCKING AWAIT AT SAME LEVEL AS LOOP Pyscript writing to console.log:
|
Pyscript - SECOND ASYNC WITH INVOKED LOOP BLOCKING AWAIT AT SAME
|
||||||
|
LEVEL AS LOOP Pyscript writing to console.log:
|
||||||
<py-script>
|
<py-script>
|
||||||
import js
|
import js
|
||||||
import asyncio
|
import asyncio
|
||||||
|
|||||||
@@ -1,15 +1,19 @@
|
|||||||
<!DOCTYPE html>
|
<!doctype html>
|
||||||
<html lang="en">
|
<html lang="en">
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8" />
|
<meta charset="utf-8" />
|
||||||
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
||||||
<title>Async Await BLOCKING LOOP Pyscript Twice</title>
|
<title>Async Await BLOCKING LOOP Pyscript Twice</title>
|
||||||
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
<link
|
||||||
|
rel="stylesheet"
|
||||||
|
href="https://pyscript.net/latest/pyscript.css"
|
||||||
|
/>
|
||||||
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<div>
|
<div>
|
||||||
Pyscript - FIRST ASYNC WITH INVOKED LOOP BLOCKING AWAIT AT SAME LEVEL AS LOOP Pyscript writing to console.log:
|
Pyscript - FIRST ASYNC WITH INVOKED LOOP BLOCKING AWAIT AT SAME
|
||||||
|
LEVEL AS LOOP Pyscript writing to console.log:
|
||||||
<py-script>
|
<py-script>
|
||||||
import js
|
import js
|
||||||
import asyncio
|
import asyncio
|
||||||
@@ -23,7 +27,8 @@
|
|||||||
</py-script>
|
</py-script>
|
||||||
</div>
|
</div>
|
||||||
<div>
|
<div>
|
||||||
Pyscript - SECOND ASYNC WITH TOP-LEVEL LOOP BLOCKING AWAIT AT SAME LEVEL AS LOOP Pyscript writing to console.log:
|
Pyscript - SECOND ASYNC WITH TOP-LEVEL LOOP BLOCKING AWAIT AT SAME
|
||||||
|
LEVEL AS LOOP Pyscript writing to console.log:
|
||||||
<py-script>
|
<py-script>
|
||||||
import js
|
import js
|
||||||
import asyncio
|
import asyncio
|
||||||
|
|||||||
@@ -1,15 +1,19 @@
|
|||||||
<!DOCTYPE html>
|
<!doctype html>
|
||||||
<html lang="en">
|
<html lang="en">
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8" />
|
<meta charset="utf-8" />
|
||||||
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
||||||
<title>Async Await NON-BLOCKING Pyscript Twice</title>
|
<title>Async Await NON-BLOCKING Pyscript Twice</title>
|
||||||
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
<link
|
||||||
|
rel="stylesheet"
|
||||||
|
href="https://pyscript.net/latest/pyscript.css"
|
||||||
|
/>
|
||||||
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<div>
|
<div>
|
||||||
Pyscript - FIRST ASYNC WITH NON-BLOCKING AWAIT AT ONE LEVEL LOWER THAN LOOP Pyscript writing to console.log:
|
Pyscript - FIRST ASYNC WITH NON-BLOCKING AWAIT AT ONE LEVEL LOWER
|
||||||
|
THAN LOOP Pyscript writing to console.log:
|
||||||
<py-script>
|
<py-script>
|
||||||
import js
|
import js
|
||||||
import asyncio
|
import asyncio
|
||||||
@@ -23,7 +27,8 @@
|
|||||||
</py-script>
|
</py-script>
|
||||||
</div>
|
</div>
|
||||||
<div>
|
<div>
|
||||||
Pyscript - SECOND ASYNC WITH NON-BLOCKING AWAIT AT ONE LEVEL LOWER THAN LOOP Pyscript writing to console.log:
|
Pyscript - SECOND ASYNC WITH NON-BLOCKING AWAIT AT ONE LEVEL LOWER
|
||||||
|
THAN LOOP Pyscript writing to console.log:
|
||||||
<py-script>
|
<py-script>
|
||||||
import js
|
import js
|
||||||
import asyncio
|
import asyncio
|
||||||
|
|||||||
@@ -1,15 +1,19 @@
|
|||||||
<!DOCTYPE html>
|
<!doctype html>
|
||||||
<html lang="en">
|
<html lang="en">
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8" />
|
<meta charset="utf-8" />
|
||||||
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
||||||
<title>Async Await BLOCKING LOOP Pyscript Twice</title>
|
<title>Async Await BLOCKING LOOP Pyscript Twice</title>
|
||||||
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
<link
|
||||||
|
rel="stylesheet"
|
||||||
|
href="https://pyscript.net/latest/pyscript.css"
|
||||||
|
/>
|
||||||
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<div>
|
<div>
|
||||||
Pyscript - FIRST ASYNC WITH TOP-LEVEL LOOP BLOCKING AWAIT AT SAME LEVEL AS LOOP Pyscript writing to console.log:
|
Pyscript - FIRST ASYNC WITH TOP-LEVEL LOOP BLOCKING AWAIT AT SAME
|
||||||
|
LEVEL AS LOOP Pyscript writing to console.log:
|
||||||
<py-script>
|
<py-script>
|
||||||
import js
|
import js
|
||||||
import asyncio
|
import asyncio
|
||||||
@@ -20,7 +24,8 @@
|
|||||||
</py-script>
|
</py-script>
|
||||||
</div>
|
</div>
|
||||||
<div>
|
<div>
|
||||||
Pyscript - SECOND ASYNC WITH TOP-LEVEL LOOP BLOCKING AWAIT AT SAME LEVEL AS LOOP Pyscript writing to console.log:
|
Pyscript - SECOND ASYNC WITH TOP-LEVEL LOOP BLOCKING AWAIT AT SAME
|
||||||
|
LEVEL AS LOOP Pyscript writing to console.log:
|
||||||
<py-script>
|
<py-script>
|
||||||
import js
|
import js
|
||||||
import asyncio
|
import asyncio
|
||||||
@@ -30,5 +35,5 @@
|
|||||||
await asyncio.sleep(2)
|
await asyncio.sleep(2)
|
||||||
</py-script>
|
</py-script>
|
||||||
</div>
|
</div>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|||||||
@@ -1,13 +1,16 @@
|
|||||||
<!DOCTYPE html>
|
<!doctype html>
|
||||||
<html lang="en">
|
<html lang="en">
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8" />
|
<meta charset="utf-8" />
|
||||||
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
||||||
<title>Async Await BLOCKING LOOP Pyscript Twice</title>
|
<title>Async Await BLOCKING LOOP Pyscript Twice</title>
|
||||||
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
<link
|
||||||
|
rel="stylesheet"
|
||||||
|
href="https://pyscript.net/latest/pyscript.css"
|
||||||
|
/>
|
||||||
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<py-script>
|
<py-script>
|
||||||
import asyncio
|
import asyncio
|
||||||
from itertools import count
|
from itertools import count
|
||||||
@@ -15,5 +18,5 @@
|
|||||||
print(f"Count: {i}")
|
print(f"Count: {i}")
|
||||||
await asyncio.sleep(1)
|
await asyncio.sleep(1)
|
||||||
</py-script>
|
</py-script>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|||||||
@@ -1,50 +1,94 @@
|
|||||||
<html><head>
|
<html>
|
||||||
|
<head>
|
||||||
<title>Bokeh Example</title>
|
<title>Bokeh Example</title>
|
||||||
<meta charset="iso-8859-1">
|
<meta charset="iso-8859-1" />
|
||||||
<link rel="icon" type="image/x-icon" href="./favicon.png">
|
<link rel="icon" type="image/x-icon" href="./favicon.png" />
|
||||||
<script type="text/javascript" src="https://cdn.bokeh.org/bokeh/release/bokeh-2.4.2.min.js"></script>
|
<script
|
||||||
<script type="text/javascript" src="https://cdn.bokeh.org/bokeh/release/bokeh-gl-2.4.2.min.js"></script>
|
type="text/javascript"
|
||||||
<script type="text/javascript" src="https://cdn.bokeh.org/bokeh/release/bokeh-widgets-2.4.2.min.js"></script>
|
src="https://cdn.bokeh.org/bokeh/release/bokeh-3.0.3.min.js"
|
||||||
<script type="text/javascript" src="https://cdn.bokeh.org/bokeh/release/bokeh-tables-2.4.2.min.js"></script>
|
></script>
|
||||||
<script type="text/javascript" src="https://cdn.bokeh.org/bokeh/release/bokeh-mathjax-2.4.2.min.js"></script>
|
<script
|
||||||
|
type="text/javascript"
|
||||||
|
src="https://cdn.bokeh.org/bokeh/release/bokeh-gl-3.0.3.min.js"
|
||||||
|
></script>
|
||||||
|
<script
|
||||||
|
type="text/javascript"
|
||||||
|
src="https://cdn.bokeh.org/bokeh/release/bokeh-widgets-3.0.3.min.js"
|
||||||
|
></script>
|
||||||
|
<script
|
||||||
|
type="text/javascript"
|
||||||
|
src="https://cdn.bokeh.org/bokeh/release/bokeh-tables-3.0.3.min.js"
|
||||||
|
></script>
|
||||||
|
<script
|
||||||
|
type="text/javascript"
|
||||||
|
src="https://cdn.bokeh.org/bokeh/release/bokeh-mathjax-3.0.3.min.js"
|
||||||
|
></script>
|
||||||
|
|
||||||
<script type="text/javascript">
|
<script type="text/javascript">
|
||||||
Bokeh.set_log_level("info");
|
Bokeh.set_log_level("info");
|
||||||
</script>
|
</script>
|
||||||
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
<link
|
||||||
|
rel="stylesheet"
|
||||||
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
href="https://pyscript.net/latest/pyscript.css"
|
||||||
|
/>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="./assets/css/examples.css" />
|
||||||
|
<style>
|
||||||
|
py-script {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
<script
|
||||||
|
type="module"
|
||||||
|
src="https://esm.sh/@pyscript/core@latest/core.js"
|
||||||
|
></script>
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<py-config>
|
<nav class="navbar" style="background-color: #000000">
|
||||||
packages = [
|
<div class="app-header">
|
||||||
"bokeh",
|
<a href="/">
|
||||||
"numpy"
|
<img src="./logo.png" class="logo" />
|
||||||
]
|
</a>
|
||||||
</py-config>
|
<a class="title" href="" style="color: #f0ab3c"
|
||||||
<h1>Bokeh Example</h1>
|
>Bokeh Example</a
|
||||||
|
>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
<py-tutor>
|
||||||
|
<section class="pyscript">
|
||||||
<div id="myplot"></div>
|
<div id="myplot"></div>
|
||||||
|
|
||||||
|
<py-config>
|
||||||
|
packages = [
|
||||||
|
"pandas",
|
||||||
|
"bokeh",
|
||||||
|
"xyzservices"
|
||||||
|
]
|
||||||
|
plugins = [
|
||||||
|
"https://pyscript.net/latest/plugins/python/py_tutor.py"
|
||||||
|
]
|
||||||
|
</py-config>
|
||||||
|
|
||||||
<py-script id="main">
|
<py-script id="main">
|
||||||
import json
|
import json
|
||||||
import pyodide
|
import pyodide
|
||||||
|
|
||||||
from js import Bokeh, console, JSON
|
from js import Bokeh, console, JSON
|
||||||
|
|
||||||
from bokeh.embed import json_item
|
from bokeh.embed import json_item
|
||||||
from bokeh.plotting import figure
|
from bokeh.plotting import figure
|
||||||
from bokeh.resources import CDN
|
from bokeh.resources import CDN
|
||||||
|
|
||||||
# create a new plot with default tools, using figure
|
# create a new plot with default tools, using figure
|
||||||
p = figure(plot_width=400, plot_height=400)
|
p = figure(width=400, height=400)
|
||||||
|
|
||||||
# add a circle renderer with x and y coordinates, size, color, and alpha
|
# add a circle renderer with x and y coordinates, size, color, and alpha
|
||||||
p.circle([1, 2, 3, 4, 5], [6, 7, 2, 4, 5], size=15, line_color="navy", fill_color="orange", fill_alpha=0.5)
|
p.circle([1, 2, 3, 4, 5], [6, 7, 2, 4, 5], size=15, line_color="navy", fill_color="orange", fill_alpha=0.5)
|
||||||
p_json = json.dumps(json_item(p, "myplot"))
|
p_json = json.dumps(json_item(p, "myplot"))
|
||||||
|
|
||||||
Bokeh.embed.embed_item(JSON.parse(p_json))
|
Bokeh.embed.embed_item(JSON.parse(p_json))
|
||||||
</py-script>
|
</py-script>
|
||||||
|
</section>
|
||||||
</body>
|
</py-tutor>
|
||||||
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|||||||
@@ -1,57 +1,92 @@
|
|||||||
<html><head>
|
<html>
|
||||||
|
<head>
|
||||||
<title>Bokeh Example</title>
|
<title>Bokeh Example</title>
|
||||||
<meta charset="iso-8859-1">
|
<meta charset="iso-8859-1" />
|
||||||
<link rel="icon" type="image/x-icon" href="./favicon.png">
|
<link rel="icon" type="image/x-icon" href="./favicon.png" />
|
||||||
<script type="text/javascript" src="https://cdn.bokeh.org/bokeh/release/bokeh-2.4.2.js"></script>
|
<script
|
||||||
<script type="text/javascript" src="https://cdn.bokeh.org/bokeh/release/bokeh-gl-2.4.2.min.js"></script>
|
type="text/javascript"
|
||||||
<script type="text/javascript" src="https://cdn.bokeh.org/bokeh/release/bokeh-widgets-2.4.2.min.js"></script>
|
src="https://cdn.bokeh.org/bokeh/release/bokeh-2.4.3.js"
|
||||||
<script type="text/javascript" src="https://cdn.bokeh.org/bokeh/release/bokeh-tables-2.4.2.min.js"></script>
|
></script>
|
||||||
<script type="text/javascript" src="https://cdn.bokeh.org/bokeh/release/bokeh-mathjax-2.4.2.min.js"></script>
|
<script
|
||||||
|
type="text/javascript"
|
||||||
|
src="https://cdn.bokeh.org/bokeh/release/bokeh-gl-2.4.3.min.js"
|
||||||
|
></script>
|
||||||
|
<script
|
||||||
|
type="text/javascript"
|
||||||
|
src="https://cdn.bokeh.org/bokeh/release/bokeh-widgets-2.4.3.min.js"
|
||||||
|
></script>
|
||||||
|
<script
|
||||||
|
type="text/javascript"
|
||||||
|
src="https://cdn.bokeh.org/bokeh/release/bokeh-tables-2.4.3.min.js"
|
||||||
|
></script>
|
||||||
|
<script
|
||||||
|
type="text/javascript"
|
||||||
|
src="https://cdn.bokeh.org/bokeh/release/bokeh-mathjax-2.4.3.min.js"
|
||||||
|
></script>
|
||||||
|
<link rel="stylesheet" href="./assets/css/examples.css" />
|
||||||
|
|
||||||
<script type="text/javascript">
|
<script type="text/javascript">
|
||||||
Bokeh.set_log_level("info");
|
Bokeh.set_log_level("info");
|
||||||
</script>
|
</script>
|
||||||
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
<link
|
||||||
|
rel="stylesheet"
|
||||||
|
href="https://pyscript.net/latest/pyscript.css"
|
||||||
|
/>
|
||||||
|
|
||||||
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
|
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<py-config>
|
<nav class="navbar" style="background-color: #000000">
|
||||||
packages = [
|
<div class="app-header">
|
||||||
"bokeh",
|
<a href="/">
|
||||||
"numpy"
|
<img src="./logo.png" class="logo" />
|
||||||
]
|
</a>
|
||||||
</py-config>
|
<a class="title" href="" style="color: #f0ab3c"
|
||||||
|
>Bokeh Example</a
|
||||||
|
>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
<py-tutor>
|
||||||
|
<section class="pyscript">
|
||||||
<h1>Bokeh Example</h1>
|
<h1>Bokeh Example</h1>
|
||||||
<div id="myplot"></div>
|
<div id="myplot"></div>
|
||||||
|
|
||||||
|
<py-config>
|
||||||
|
packages = [
|
||||||
|
"https://cdn.holoviz.org/panel/0.14.3/dist/wheels/bokeh-2.4.3-py3-none-any.whl",
|
||||||
|
"numpy",
|
||||||
|
]
|
||||||
|
plugins = [
|
||||||
|
"https://pyscript.net/latest/plugins/python/py_tutor.py"
|
||||||
|
]
|
||||||
|
</py-config>
|
||||||
|
|
||||||
<py-script id="main">
|
<py-script id="main">
|
||||||
import asyncio
|
import asyncio
|
||||||
import json
|
import json
|
||||||
import pyodide
|
import pyodide
|
||||||
|
|
||||||
from js import Bokeh, console, JSON
|
from js import Bokeh, console, JSON
|
||||||
|
|
||||||
from bokeh import __version__
|
from bokeh import __version__
|
||||||
from bokeh.document import Document
|
from bokeh.document import Document
|
||||||
from bokeh.embed.util import OutputDocumentFor, standalone_docs_json_and_render_items
|
from bokeh.embed.util import OutputDocumentFor, standalone_docs_json_and_render_items
|
||||||
from bokeh.models import Slider, Div
|
from bokeh.models import Slider, Div
|
||||||
from bokeh.layouts import Row
|
from bokeh.layouts import Row
|
||||||
from bokeh.protocol.messages.patch_doc import process_document_events
|
from bokeh.protocol.messages.patch_doc import process_document_events
|
||||||
|
|
||||||
# create a new plot with default tools, using figure
|
# create a new plot with default tools, using figure
|
||||||
p = Slider(start=0.1, end=10, value=1, step=.1, title="Amplitude")
|
p = Slider(start=0.1, end=10, value=1, step=.1, title="Amplitude")
|
||||||
div = Div(text=f'Amplitude is: {p.value}')
|
div = Div(text=f'Amplitude is: {p.value}')
|
||||||
|
|
||||||
def callback(attr, old, new):
|
def callback(attr, old, new):
|
||||||
div.text = f'Amplitude is: {new}'
|
div.text = f'Amplitude is: {new}'
|
||||||
|
|
||||||
p.on_change('value', callback)
|
p.on_change('value', callback)
|
||||||
|
|
||||||
row = Row(children=[p, div])
|
row = Row(children=[p, div])
|
||||||
|
|
||||||
def doc_json(model, target):
|
def doc_json(model, target):
|
||||||
with OutputDocumentFor([model]) as doc:
|
with OutputDocumentFor([model]) as doc:
|
||||||
doc.title = ""
|
doc.title = ""
|
||||||
docs_json, _ = standalone_docs_json_and_render_items(
|
docs_json, _ = standalone_docs_json_and_render_items(
|
||||||
@@ -68,7 +103,7 @@ def doc_json(model, target):
|
|||||||
version = __version__,
|
version = __version__,
|
||||||
))
|
))
|
||||||
|
|
||||||
def _link_docs(pydoc, jsdoc):
|
def _link_docs(pydoc, jsdoc):
|
||||||
def jssync(event):
|
def jssync(event):
|
||||||
if getattr(event, 'setter_id', None) is not None:
|
if getattr(event, 'setter_id', None) is not None:
|
||||||
return
|
return
|
||||||
@@ -87,14 +122,15 @@ def _link_docs(pydoc, jsdoc):
|
|||||||
|
|
||||||
pydoc.on_change(pysync)
|
pydoc.on_change(pysync)
|
||||||
|
|
||||||
async def show(plot, target):
|
async def show(plot, target):
|
||||||
pydoc, model_json = doc_json(plot, target)
|
pydoc, model_json = doc_json(plot, target)
|
||||||
views = await Bokeh.embed.embed_item(JSON.parse(model_json))
|
views = await Bokeh.embed.embed_item(JSON.parse(model_json))
|
||||||
jsdoc = views[0].model.document
|
jsdoc = views[0].model.document
|
||||||
_link_docs(pydoc, jsdoc)
|
_link_docs(pydoc, jsdoc)
|
||||||
|
|
||||||
await show(row, 'myplot')
|
asyncio.ensure_future(show(row, 'myplot'))
|
||||||
</py-script>
|
</py-script>
|
||||||
|
</section>
|
||||||
</body>
|
</py-tutor>
|
||||||
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|||||||
222
examples/d3.html
222
examples/d3.html
@@ -1,12 +1,16 @@
|
|||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<title>d3: JavaScript & PyScript visualizations side-by-side</title>
|
<title>d3: JavaScript & PyScript visualizations side-by-side</title>
|
||||||
<meta charset="utf-8">
|
<meta charset="utf-8" />
|
||||||
<link rel="icon" type="image/x-icon" href="./favicon.png">
|
<link rel="icon" type="image/x-icon" href="./favicon.png" />
|
||||||
|
|
||||||
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
<link
|
||||||
|
rel="stylesheet"
|
||||||
|
href="https://pyscript.net/latest/pyscript.css"
|
||||||
|
/>
|
||||||
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
||||||
|
<link rel="stylesheet" href="./assets/css/examples.css" />
|
||||||
|
<script src="https://d3js.org/d3.v7.min.js"></script>
|
||||||
<style>
|
<style>
|
||||||
.loading {
|
.loading {
|
||||||
display: inline-block;
|
display: inline-block;
|
||||||
@@ -24,11 +28,38 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
</style>
|
</style>
|
||||||
|
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
|
<nav class="navbar" style="background-color: #000000">
|
||||||
|
<div class="app-header">
|
||||||
|
<a href="/">
|
||||||
|
<img src="./logo.png" class="logo" />
|
||||||
|
</a>
|
||||||
|
<a class="title" href="" style="color: #f0ab3c"
|
||||||
|
>Simple d3 visualization</a
|
||||||
|
>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section class="pyscript">
|
||||||
|
<py-tutor modules="d3.py">
|
||||||
|
<py-config>
|
||||||
|
plugins = [
|
||||||
|
"https://pyscript.net/latest/plugins/python/py_tutor.py"
|
||||||
|
]
|
||||||
|
[[fetch]]
|
||||||
|
files = ["./d3.py"]
|
||||||
|
</py-config>
|
||||||
|
</py-tutor>
|
||||||
<b>
|
<b>
|
||||||
Based on <i><a href="https://observablehq.com/@d3/learn-d3-shapes?collection=@d3/learn-d3>">Learn D3: Shapes</a></i> tutorial.
|
Based on
|
||||||
|
<i
|
||||||
|
><a
|
||||||
|
href="https://observablehq.com/@d3/learn-d3-shapes?collection=@d3/learn-d3>"
|
||||||
|
>Learn D3: Shapes</a
|
||||||
|
></i
|
||||||
|
>
|
||||||
|
tutorial.
|
||||||
</b>
|
</b>
|
||||||
<div style="display: flex; flex-direction: row">
|
<div style="display: flex; flex-direction: row">
|
||||||
<div>
|
<div>
|
||||||
@@ -44,127 +75,64 @@
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
<py-script src="d3.py"></py-script>
|
||||||
|
</section>
|
||||||
|
|
||||||
<script type="importmap">
|
<script type="module">
|
||||||
{
|
const fruits = [
|
||||||
"imports": {
|
{ name: "🍊", count: 21 },
|
||||||
"d3": "https://cdn.skypack.dev/pin/d3@v7.6.1-1Q0NZ0WZnbYeSjDusJT3/mode=imports,min/optimized/d3.js"
|
{ name: "🍇", count: 13 },
|
||||||
|
{ name: "🍏", count: 8 },
|
||||||
|
{ name: "🍌", count: 5 },
|
||||||
|
{ name: "🍐", count: 3 },
|
||||||
|
{ name: "🍋", count: 2 },
|
||||||
|
{ name: "🍎", count: 1 },
|
||||||
|
{ name: "🍉", count: 1 },
|
||||||
|
];
|
||||||
|
|
||||||
|
const fn = (d) => d.count;
|
||||||
|
const data = d3.pie().value(fn)(fruits);
|
||||||
|
|
||||||
|
const arc = d3
|
||||||
|
.arc()
|
||||||
|
.innerRadius(210)
|
||||||
|
.outerRadius(310)
|
||||||
|
.padRadius(300)
|
||||||
|
.padAngle(2 / 300)
|
||||||
|
.cornerRadius(8);
|
||||||
|
|
||||||
|
const js = d3.select("#js");
|
||||||
|
js.select(".loading").remove();
|
||||||
|
|
||||||
|
const svg = js
|
||||||
|
.append("svg")
|
||||||
|
.attr("viewBox", "-320 -320 640 640")
|
||||||
|
.attr("width", "400")
|
||||||
|
.attr("height", "400");
|
||||||
|
|
||||||
|
for (const d of data) {
|
||||||
|
svg.append("path").style("fill", "steelblue").attr("d", arc(d));
|
||||||
|
|
||||||
|
const text = svg
|
||||||
|
.append("text")
|
||||||
|
.style("fill", "white")
|
||||||
|
.attr(
|
||||||
|
"transform",
|
||||||
|
`translate(${arc.centroid(d).join(",")})`,
|
||||||
|
)
|
||||||
|
.attr("text-anchor", "middle");
|
||||||
|
|
||||||
|
text.append("tspan")
|
||||||
|
.style("font-size", "24")
|
||||||
|
.attr("x", "0")
|
||||||
|
.text(d.data.name);
|
||||||
|
|
||||||
|
text.append("tspan")
|
||||||
|
.style("font-size", "18")
|
||||||
|
.attr("x", "0")
|
||||||
|
.attr("dy", "1.3em")
|
||||||
|
.text(d.value);
|
||||||
}
|
}
|
||||||
}
|
</script>
|
||||||
</script>
|
</body>
|
||||||
|
|
||||||
<script type="module">
|
|
||||||
import * as d3 from "https://cdn.skypack.dev/pin/d3@v7.6.1-1Q0NZ0WZnbYeSjDusJT3/mode=imports,min/optimized/d3.js";
|
|
||||||
|
|
||||||
const fruits = [
|
|
||||||
{name: "🍊", count: 21},
|
|
||||||
{name: "🍇", count: 13},
|
|
||||||
{name: "🍏", count: 8},
|
|
||||||
{name: "🍌", count: 5},
|
|
||||||
{name: "🍐", count: 3},
|
|
||||||
{name: "🍋", count: 2},
|
|
||||||
{name: "🍎", count: 1},
|
|
||||||
{name: "🍉", count: 1},
|
|
||||||
]
|
|
||||||
|
|
||||||
const fn = (d) => d.count
|
|
||||||
const data = d3.pie().value(fn)(fruits)
|
|
||||||
|
|
||||||
const arc = d3.arc()
|
|
||||||
.innerRadius(210)
|
|
||||||
.outerRadius(310)
|
|
||||||
.padRadius(300)
|
|
||||||
.padAngle(2 / 300)
|
|
||||||
.cornerRadius(8)
|
|
||||||
|
|
||||||
const js = d3.select("#js")
|
|
||||||
js.select(".loading").remove()
|
|
||||||
|
|
||||||
const svg = js
|
|
||||||
.append("svg")
|
|
||||||
.attr("viewBox", "-320 -320 640 640")
|
|
||||||
.attr("width", "400")
|
|
||||||
.attr("height", "400")
|
|
||||||
|
|
||||||
for (const d of data) {
|
|
||||||
svg.append("path")
|
|
||||||
.style("fill", "steelblue")
|
|
||||||
.attr("d", arc(d))
|
|
||||||
|
|
||||||
const text = svg.append("text")
|
|
||||||
.style("fill", "white")
|
|
||||||
.attr("transform", `translate(${arc.centroid(d).join(",")})`)
|
|
||||||
.attr("text-anchor", "middle")
|
|
||||||
|
|
||||||
text.append("tspan")
|
|
||||||
.style("font-size", "24")
|
|
||||||
.attr("x", "0").text(d.data.name)
|
|
||||||
|
|
||||||
text.append("tspan")
|
|
||||||
.style("font-size", "18")
|
|
||||||
.attr("x", "0")
|
|
||||||
.attr("dy", "1.3em")
|
|
||||||
.text(d.value)
|
|
||||||
}
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<py-script>
|
|
||||||
from pyodide.ffi import create_proxy, to_js
|
|
||||||
import d3
|
|
||||||
|
|
||||||
fruits = [
|
|
||||||
dict(name="🍊", count=21),
|
|
||||||
dict(name="🍇", count=13),
|
|
||||||
dict(name="🍏", count=8),
|
|
||||||
dict(name="🍌", count=5),
|
|
||||||
dict(name="🍐", count=3),
|
|
||||||
dict(name="🍋", count=2),
|
|
||||||
dict(name="🍎", count=1),
|
|
||||||
dict(name="🍉", count=1),
|
|
||||||
]
|
|
||||||
|
|
||||||
fn = create_proxy(lambda d, *_: d["count"])
|
|
||||||
data = d3.pie().value(fn)(to_js(fruits))
|
|
||||||
|
|
||||||
arc = (d3.arc()
|
|
||||||
.innerRadius(210)
|
|
||||||
.outerRadius(310)
|
|
||||||
.padRadius(300)
|
|
||||||
.padAngle(2 / 300)
|
|
||||||
.cornerRadius(8))
|
|
||||||
|
|
||||||
py = d3.select("#py")
|
|
||||||
py.select(".loading").remove()
|
|
||||||
|
|
||||||
svg = (py
|
|
||||||
.append("svg")
|
|
||||||
.attr("viewBox", "-320 -320 640 640")
|
|
||||||
.attr("width", "400")
|
|
||||||
.attr("height", "400"))
|
|
||||||
|
|
||||||
for d in data:
|
|
||||||
d_py = d.to_py()
|
|
||||||
|
|
||||||
(svg.append("path")
|
|
||||||
.style("fill", "steelblue")
|
|
||||||
.attr("d", arc(d)))
|
|
||||||
|
|
||||||
text = (svg.append("text")
|
|
||||||
.style("fill", "white")
|
|
||||||
.attr("transform", f"translate({arc.centroid(d).join(',')})")
|
|
||||||
.attr("text-anchor", "middle"))
|
|
||||||
|
|
||||||
(text.append("tspan")
|
|
||||||
.style("font-size", "24")
|
|
||||||
.attr("x", "0")
|
|
||||||
.text(d_py["data"]["name"]))
|
|
||||||
|
|
||||||
(text.append("tspan")
|
|
||||||
.style("font-size", "18")
|
|
||||||
.attr("x", "0")
|
|
||||||
.attr("dy", "1.3em")
|
|
||||||
.text(d_py["value"]))
|
|
||||||
</py-script>
|
|
||||||
|
|
||||||
</body>
|
|
||||||
</html>
|
</html>
|
||||||
|
|||||||
64
examples/d3.py
Normal file
64
examples/d3.py
Normal file
@@ -0,0 +1,64 @@
|
|||||||
|
import js
|
||||||
|
from pyodide.ffi import create_proxy, to_js
|
||||||
|
|
||||||
|
d3 = js.d3
|
||||||
|
|
||||||
|
fruits = [
|
||||||
|
{"name": "🍊", "count": 21},
|
||||||
|
{"name": "🍇", "count": 13},
|
||||||
|
{"name": "🍏", "count": 8},
|
||||||
|
{"name": "🍌", "count": 5},
|
||||||
|
{"name": "🍐", "count": 3},
|
||||||
|
{"name": "🍋", "count": 2},
|
||||||
|
{"name": "🍎", "count": 1},
|
||||||
|
{"name": "🍉", "count": 1},
|
||||||
|
]
|
||||||
|
|
||||||
|
fn = create_proxy(lambda d, *_: d["count"])
|
||||||
|
data = d3.pie().value(fn)(to_js(fruits))
|
||||||
|
|
||||||
|
arc = (
|
||||||
|
d3.arc()
|
||||||
|
.innerRadius(210)
|
||||||
|
.outerRadius(310)
|
||||||
|
.padRadius(300)
|
||||||
|
.padAngle(2 / 300)
|
||||||
|
.cornerRadius(8)
|
||||||
|
)
|
||||||
|
|
||||||
|
py = d3.select("#py")
|
||||||
|
py.select(".loading").remove()
|
||||||
|
|
||||||
|
svg = (
|
||||||
|
py.append("svg")
|
||||||
|
.attr("viewBox", "-320 -320 640 640")
|
||||||
|
.attr("width", "400")
|
||||||
|
.attr("height", "400")
|
||||||
|
)
|
||||||
|
|
||||||
|
for d in data:
|
||||||
|
d_py = d.to_py()
|
||||||
|
|
||||||
|
(svg.append("path").style("fill", "steelblue").attr("d", arc(d)))
|
||||||
|
|
||||||
|
text = (
|
||||||
|
svg.append("text")
|
||||||
|
.style("fill", "white")
|
||||||
|
.attr("transform", f"translate({arc.centroid(d).join(',')})")
|
||||||
|
.attr("text-anchor", "middle")
|
||||||
|
)
|
||||||
|
|
||||||
|
(
|
||||||
|
text.append("tspan")
|
||||||
|
.style("font-size", "24")
|
||||||
|
.attr("x", "0")
|
||||||
|
.text(d_py["data"]["name"])
|
||||||
|
)
|
||||||
|
|
||||||
|
(
|
||||||
|
text.append("tspan")
|
||||||
|
.style("font-size", "18")
|
||||||
|
.attr("x", "0")
|
||||||
|
.attr("dy", "1.3em")
|
||||||
|
.text(d_py["value"])
|
||||||
|
)
|
||||||
@@ -1,37 +1,65 @@
|
|||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<title>Folium</title>
|
<title>Folium</title>
|
||||||
<meta charset="utf-8">
|
<meta charset="utf-8" />
|
||||||
<link rel="icon" type="image/x-icon" href="./favicon.png">
|
<link rel="icon" type="image/x-icon" href="./favicon.png" />
|
||||||
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
<link
|
||||||
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
rel="stylesheet"
|
||||||
<py-config>
|
href="https://pyscript.net/latest/pyscript.css"
|
||||||
packages = [
|
/>
|
||||||
"folium",
|
<link rel="stylesheet" href="./assets/css/examples.css" />
|
||||||
"pandas"
|
<style>
|
||||||
]
|
py-script {
|
||||||
</py-config>
|
display: none;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
<script
|
||||||
|
type="module"
|
||||||
|
src="https://esm.sh/@pyscript/core@latest/core.js"
|
||||||
|
></script>
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<div id="folium" style="width: 100%; height: 100%"></div>
|
<nav class="navbar" style="background-color: #000000">
|
||||||
<py-script output="folium">
|
<div class="app-header">
|
||||||
import folium
|
<a href="/">
|
||||||
import json
|
<img src="./logo.png" class="logo" />
|
||||||
import pandas as pd
|
</a>
|
||||||
|
<a class="title" href="" style="color: #f0ab3c">Folium</a>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
<section class="pyscript">
|
||||||
|
<div id="folium"></div>
|
||||||
|
|
||||||
from pyodide.http import open_url
|
<py-tutor>
|
||||||
|
<py-config>
|
||||||
|
packages = [
|
||||||
|
"folium",
|
||||||
|
"pandas"
|
||||||
|
]
|
||||||
|
plugins = [
|
||||||
|
"https://pyscript.net/latest/plugins/python/py_tutor.py"
|
||||||
|
]
|
||||||
|
</py-config>
|
||||||
|
|
||||||
url = (
|
<py-script>
|
||||||
|
from pyscript import display
|
||||||
|
import folium
|
||||||
|
import json
|
||||||
|
import pandas as pd
|
||||||
|
|
||||||
|
from pyodide.http import open_url
|
||||||
|
|
||||||
|
url = (
|
||||||
"https://raw.githubusercontent.com/python-visualization/folium/master/examples/data"
|
"https://raw.githubusercontent.com/python-visualization/folium/master/examples/data"
|
||||||
)
|
)
|
||||||
state_geo = f"{url}/us-states.json"
|
state_geo = f"{url}/us-states.json"
|
||||||
state_unemployment = f"{url}/US_Unemployment_Oct2012.csv"
|
state_unemployment = f"{url}/US_Unemployment_Oct2012.csv"
|
||||||
state_data = pd.read_csv(open_url(state_unemployment))
|
state_data = pd.read_csv(open_url(state_unemployment))
|
||||||
geo_json = json.loads(open_url(state_geo).read())
|
geo_json = json.loads(open_url(state_geo).read())
|
||||||
|
|
||||||
m = folium.Map(location=[48, -102], zoom_start=3)
|
m = folium.Map(location=[48, -102], zoom_start=3)
|
||||||
|
|
||||||
folium.Choropleth(
|
folium.Choropleth(
|
||||||
geo_data=geo_json,
|
geo_data=geo_json,
|
||||||
name="choropleth",
|
name="choropleth",
|
||||||
data=state_data,
|
data=state_data,
|
||||||
@@ -41,11 +69,13 @@ folium.Choropleth(
|
|||||||
fill_opacity=0.7,
|
fill_opacity=0.7,
|
||||||
line_opacity=0.2,
|
line_opacity=0.2,
|
||||||
legend_name="Unemployment Rate (%)",
|
legend_name="Unemployment Rate (%)",
|
||||||
).add_to(m)
|
).add_to(m)
|
||||||
|
|
||||||
folium.LayerControl().add_to(m)
|
folium.LayerControl().add_to(m)
|
||||||
|
|
||||||
m
|
display(m, target="folium")
|
||||||
</py-script>
|
</py-script>
|
||||||
|
</py-tutor>
|
||||||
|
</section>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|||||||
@@ -1,36 +1,42 @@
|
|||||||
<!DOCTYPE html>
|
<!doctype html>
|
||||||
<html lang="en">
|
<html lang="en">
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8" />
|
<meta charset="utf-8" />
|
||||||
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
||||||
|
|
||||||
<title>Svelte app</title>
|
<title>Say Hello</title>
|
||||||
|
|
||||||
<link rel="icon" type="image/png" href="../favicon.png" />
|
<link rel="icon" type="image/png" href="../favicon.png" />
|
||||||
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
<link
|
||||||
|
rel="stylesheet"
|
||||||
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
href="https://pyscript.net/latest/pyscript.css"
|
||||||
|
/>
|
||||||
|
<script defer src="../../pyscriptjs/build/pyscript.js"></script>
|
||||||
|
<!-- <script defer src="https://pyscript.net/latest/pyscript.js"></script> -->
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body>
|
<body>
|
||||||
<py-script>
|
<py-script>
|
||||||
from js import handTrack, requestAnimationFrame
|
from js import handTrack, requestAnimationFrame, console
|
||||||
from pyodide import create_once_callable
|
from pyodide import create_once_callable
|
||||||
import asyncio
|
import asyncio
|
||||||
|
|
||||||
context = canvas.element.getContext("2d")
|
update_note = Element("update-note")
|
||||||
|
canvas = Element("canvas")
|
||||||
|
video = Element("myvideo")
|
||||||
|
context = canvas.element.getContext("2d")
|
||||||
|
|
||||||
isVideo = False
|
isVideo = False
|
||||||
model = None
|
model = None
|
||||||
|
|
||||||
modelParams = {
|
modelParams = {
|
||||||
"flipHorizontal": True, # flip e.g for video
|
"flipHorizontal": True, # flip e.g for video
|
||||||
"maxNumBoxes": 20, # maximum number of boxes to detect
|
"maxNumBoxes": 20, # maximum number of boxes to detect
|
||||||
"iouThreshold": 0.5, # ioU threshold for non-max suppression
|
"iouThreshold": 0.5, # ioU threshold for non-max suppression
|
||||||
"scoreThreshold": 0.6, # confidence threshold for predictions.
|
"scoreThreshold": 0.6, # confidence threshold for predictions.
|
||||||
}
|
}
|
||||||
|
|
||||||
def toggle_video(evt):
|
def toggle_video():
|
||||||
global isVideo
|
global isVideo
|
||||||
if (not isVideo):
|
if (not isVideo):
|
||||||
update_note.write("Starting video")
|
update_note.write("Starting video")
|
||||||
@@ -41,7 +47,7 @@ def toggle_video(evt):
|
|||||||
isVideo = False
|
isVideo = False
|
||||||
update_note.write("Video stopped")
|
update_note.write("Video stopped")
|
||||||
|
|
||||||
async def start_video():
|
async def start_video():
|
||||||
global isVideo
|
global isVideo
|
||||||
update_note.write("Inside sstart video")
|
update_note.write("Inside sstart video")
|
||||||
status = await handTrack.startVideo(video.element)
|
status = await handTrack.startVideo(video.element)
|
||||||
@@ -54,10 +60,10 @@ async def start_video():
|
|||||||
else:
|
else:
|
||||||
update_note.write( "Please enable video")
|
update_note.write( "Please enable video")
|
||||||
|
|
||||||
def sync_run_detection(evt):
|
def sync_run_detection(evt):
|
||||||
pyscript.run_until_complete(run_detection())
|
pyscript.run_until_complete(run_detection())
|
||||||
|
|
||||||
async def run_detection():
|
async def run_detection():
|
||||||
console.log("in RUN DETECTION: ");
|
console.log("in RUN DETECTION: ");
|
||||||
global model
|
global model
|
||||||
global isVideo
|
global isVideo
|
||||||
@@ -74,7 +80,7 @@ async def run_detection():
|
|||||||
await requestAnimationFrame(create_once_callable(sync_run_detection));
|
await requestAnimationFrame(create_once_callable(sync_run_detection));
|
||||||
console.log("...2")
|
console.log("...2")
|
||||||
|
|
||||||
def run_detection_image(img):
|
def run_detection_image(img):
|
||||||
console.log("in RUN DETECTION IMAGE", predictions);
|
console.log("in RUN DETECTION IMAGE", predictions);
|
||||||
global model
|
global model
|
||||||
def detect(predition):
|
def detect(predition):
|
||||||
@@ -84,12 +90,12 @@ def run_detection_image(img):
|
|||||||
model.detect(img).then(detect)
|
model.detect(img).then(detect)
|
||||||
console.log("...4")
|
console.log("...4")
|
||||||
|
|
||||||
def handle_model(lmodel):
|
def handle_model(lmodel):
|
||||||
global model
|
global model
|
||||||
model = lmodel
|
model = lmodel
|
||||||
update_note.write("Loaded Model!")
|
update_note.write("Loaded Model!")
|
||||||
|
|
||||||
async def start():
|
async def start():
|
||||||
console.log("creating x")
|
console.log("creating x")
|
||||||
console.log("calling x")
|
console.log("calling x")
|
||||||
model = await handTrack.load(modelParams)#.then(handle_model)
|
model = await handTrack.load(modelParams)#.then(handle_model)
|
||||||
@@ -99,24 +105,34 @@ async def start():
|
|||||||
print(dir(x))
|
print(dir(x))
|
||||||
print(x)
|
print(x)
|
||||||
|
|
||||||
pyscript.run_until_complete(start())
|
pyscript.run_until_complete(start())
|
||||||
|
|
||||||
#});
|
|
||||||
|
|
||||||
|
#});
|
||||||
</py-script>
|
</py-script>
|
||||||
|
|
||||||
<div class="mb10">
|
<div class="mb10">
|
||||||
<button id="trackbutton" class="bx--btn bx--btn--secondary" type="button" py-onClick="toggle_video()">
|
<button
|
||||||
|
id="trackbutton"
|
||||||
|
class="bx--btn bx--btn--secondary"
|
||||||
|
type="button"
|
||||||
|
py-click="toggle_video()"
|
||||||
|
>
|
||||||
Toggle Video
|
Toggle Video
|
||||||
</button>
|
</button>
|
||||||
<button id="nextimagebutton" class="mt10 bx--btn bx--btn--secondary" type="button" disabled>
|
<button
|
||||||
|
id="nextimagebutton"
|
||||||
|
class="mt10 bx--btn bx--btn--secondary"
|
||||||
|
type="button"
|
||||||
|
disabled
|
||||||
|
>
|
||||||
Next Image
|
Next Image
|
||||||
</button>
|
</button>
|
||||||
<div id="update-note" py-mount class="updatenote mt10">loading model ..</div>
|
<div id="update-note" class="updatenote mt10">loading model ..</div>
|
||||||
</div>
|
</div>
|
||||||
<div>
|
<div>
|
||||||
<video autoplay="autoplay" id="myvideo" py-mount="video"></video>
|
<video autoplay="autoplay" id="myvideo" py-mount="video"></video>
|
||||||
<canvas id="canvas" py-mount class="border canvasbox"></canvas>
|
<canvas id="canvas" class="border canvasbox"></canvas>
|
||||||
</div>
|
</div>
|
||||||
<script src="lib/handtrack.min.js"> </script>
|
<script src="lib/handtrack.min.js"></script>
|
||||||
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
<!DOCTYPE html>
|
<!doctype html>
|
||||||
<html lang="en">
|
<html lang="en">
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8" />
|
<meta charset="utf-8" />
|
||||||
@@ -7,18 +7,49 @@
|
|||||||
<title>PyScript Hello World</title>
|
<title>PyScript Hello World</title>
|
||||||
|
|
||||||
<link rel="icon" type="image/png" href="favicon.png" />
|
<link rel="icon" type="image/png" href="favicon.png" />
|
||||||
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
|
<link
|
||||||
|
rel="stylesheet"
|
||||||
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
|
href="https://pyscript.net/latest/pyscript.css"
|
||||||
|
/>
|
||||||
|
<link rel="stylesheet" href="./assets/css/examples.css" />
|
||||||
|
<style>
|
||||||
|
py-script {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
<script
|
||||||
|
type="module"
|
||||||
|
src="https://esm.sh/@pyscript/core@latest/core.js"
|
||||||
|
></script>
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body>
|
<body>
|
||||||
Hello world! <br>
|
<nav class="navbar" style="background-color: #000000">
|
||||||
|
<div class="app-header">
|
||||||
|
<a href="/">
|
||||||
|
<img src="./logo.png" class="logo" />
|
||||||
|
</a>
|
||||||
|
<a class="title" href="" style="color: #f0ab3c">Hello World</a>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<py-tutor>
|
||||||
|
<py-config>
|
||||||
|
plugins = [
|
||||||
|
"https://pyscript.net/latest/plugins/python/py_tutor.py"
|
||||||
|
]
|
||||||
|
</py-config>
|
||||||
|
|
||||||
|
<section class="pyscript">
|
||||||
|
Hello world! <br />
|
||||||
This is the current date and time, as computed by Python:
|
This is the current date and time, as computed by Python:
|
||||||
<py-script>
|
<py-script>
|
||||||
from datetime import datetime
|
from pyscript import display
|
||||||
now = datetime.now()
|
from datetime import datetime
|
||||||
now.strftime("%m/%d/%Y, %H:%M:%S")
|
now = datetime.now()
|
||||||
|
display(now.strftime("%m/%d/%Y, %H:%M:%S"))
|
||||||
</py-script>
|
</py-script>
|
||||||
|
</section>
|
||||||
|
</py-tutor>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|||||||
@@ -1,15 +1,15 @@
|
|||||||
<!DOCTYPE html>
|
<!doctype html>
|
||||||
<html lang="en">
|
<html lang="en">
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8" />
|
<meta charset="utf-8" />
|
||||||
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
||||||
<title>PyScript demo</title>
|
<title>PyScript demo</title>
|
||||||
<link rel="icon" type="image/png" href="favicon.png" />
|
<link rel="icon" type="image/png" href="favicon.png" />
|
||||||
<link rel="stylesheet" href="./assets/css/main.css" />
|
<link rel="stylesheet" href="./assets/css/main.css" />
|
||||||
<link rel="stylesheet" href="./assets/css/index.css" />
|
<link rel="stylesheet" href="./assets/css/index.css" />
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="container">
|
<body class="container">
|
||||||
<h1 class="title-main">PyScript demos</h1>
|
<h1 class="title-main">PyScript demos</h1>
|
||||||
<section class="example">
|
<section class="example">
|
||||||
<h2>Basic examples</h2>
|
<h2>Basic examples</h2>
|
||||||
@@ -20,7 +20,8 @@
|
|||||||
<h2>Hello world</h2>
|
<h2>Hello world</h2>
|
||||||
</a>
|
</a>
|
||||||
<p>
|
<p>
|
||||||
A static demo of the <code><py-script></code> tag
|
A static demo of the
|
||||||
|
<code><py-script></code> tag
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
@@ -31,7 +32,8 @@
|
|||||||
<h2>Simple clock</h2>
|
<h2>Simple clock</h2>
|
||||||
</a>
|
</a>
|
||||||
<p>
|
<p>
|
||||||
A dynamic demo of the <code><py-script></code> tag
|
A dynamic demo of the
|
||||||
|
<code><py-script></code> tag
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
@@ -41,9 +43,7 @@
|
|||||||
<a href="./repl.html" target="_blank">
|
<a href="./repl.html" target="_blank">
|
||||||
<h2>REPL</h2>
|
<h2>REPL</h2>
|
||||||
</a>
|
</a>
|
||||||
<p>
|
<p>A Python REPL (Read Eval Print Loop)</p>
|
||||||
A Python REPL (Read Eval Print Loop)
|
|
||||||
</p>
|
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@@ -53,7 +53,8 @@
|
|||||||
<h2>REPL2</h2>
|
<h2>REPL2</h2>
|
||||||
</a>
|
</a>
|
||||||
<p>
|
<p>
|
||||||
A Python REPL (Read Eval Print Loop) with slightly better formatting
|
A Python REPL (Read Eval Print Loop) with slightly
|
||||||
|
better formatting
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
@@ -63,9 +64,7 @@
|
|||||||
<a href="./todo.html" target="_blank">
|
<a href="./todo.html" target="_blank">
|
||||||
<h2>TODO App</h2>
|
<h2>TODO App</h2>
|
||||||
</a>
|
</a>
|
||||||
<p>
|
<p>Simple TODO App</p>
|
||||||
Simple TODO App
|
|
||||||
</p>
|
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@@ -91,7 +90,11 @@
|
|||||||
<h2>Matplotlib</h2>
|
<h2>Matplotlib</h2>
|
||||||
</a>
|
</a>
|
||||||
<p>
|
<p>
|
||||||
Demonstrates rendering a <a href="https://matplotlib.org/" target="_blank">Matplotlib</a> figure as output of the py-script tag
|
Demonstrates rendering a
|
||||||
|
<a href="https://matplotlib.org/" target="_blank"
|
||||||
|
>Matplotlib</a
|
||||||
|
>
|
||||||
|
figure as output of the py-script tag
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
@@ -99,12 +102,16 @@
|
|||||||
<div class="card">
|
<div class="card">
|
||||||
<div class="card-content">
|
<div class="card-content">
|
||||||
<a href="./altair.html" target="_blank">
|
<a href="./altair.html" target="_blank">
|
||||||
<h2>
|
<h2>Altair</h2>
|
||||||
Altair
|
|
||||||
</h2>
|
|
||||||
</a>
|
</a>
|
||||||
<p>
|
<p>
|
||||||
Demonstrates rendering a <a href="https://altair-viz.github.io/" target="_blank">Altair</a> plot as output of the py-script tag
|
Demonstrates rendering a
|
||||||
|
<a
|
||||||
|
href="https://altair-viz.github.io/"
|
||||||
|
target="_blank"
|
||||||
|
>Altair</a
|
||||||
|
>
|
||||||
|
plot as output of the py-script tag
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
@@ -112,13 +119,15 @@
|
|||||||
<div class="card">
|
<div class="card">
|
||||||
<div class="card-content">
|
<div class="card-content">
|
||||||
<a href="./folium.html" target="_blank">
|
<a href="./folium.html" target="_blank">
|
||||||
<h2>
|
<h2>Folium</h2>
|
||||||
Folium
|
|
||||||
</h2>
|
|
||||||
</a>
|
</a>
|
||||||
<p>
|
<p>
|
||||||
Demonstrates rendering a
|
Demonstrates rendering a
|
||||||
<a href="https://python-visualization.github.io/folium/" target="_blank">Folium</a>
|
<a
|
||||||
|
href="https://python-visualization.github.io/folium/"
|
||||||
|
target="_blank"
|
||||||
|
>Folium</a
|
||||||
|
>
|
||||||
map as output of the py-script tag
|
map as output of the py-script tag
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
@@ -132,12 +141,11 @@
|
|||||||
<div class="card">
|
<div class="card">
|
||||||
<div class="card-content">
|
<div class="card-content">
|
||||||
<a href="./d3.html" target="_blank">
|
<a href="./d3.html" target="_blank">
|
||||||
<h2>
|
<h2>Simple d3 visualization</h2>
|
||||||
Simple d3 visualization
|
|
||||||
</h2>
|
|
||||||
</a>
|
</a>
|
||||||
<p>
|
<p>
|
||||||
Minimal <a href="https://d3js.org/" target="_blank">D3</a>
|
Minimal
|
||||||
|
<a href="https://d3js.org/" target="_blank">D3</a>
|
||||||
demo demonstrating how to create a visualization
|
demo demonstrating how to create a visualization
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
@@ -146,13 +154,17 @@
|
|||||||
<div class="card">
|
<div class="card">
|
||||||
<div class="card-content">
|
<div class="card-content">
|
||||||
<a href="./webgl/raycaster/index.html" target="_blank">
|
<a href="./webgl/raycaster/index.html" target="_blank">
|
||||||
<h2>
|
<h2>Webgl Icosahedron Example</h2>
|
||||||
Webgl Icosahedron Example
|
|
||||||
</h2>
|
|
||||||
</a>
|
</a>
|
||||||
<p>
|
<p>
|
||||||
Demo showing how a Simple <a href="https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API" target="_blank">WebGL</a>
|
Demo showing how a Simple
|
||||||
scene would work in PyScript</code> tag
|
<a
|
||||||
|
href="https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API"
|
||||||
|
target="_blank"
|
||||||
|
>WebGL</a
|
||||||
|
>
|
||||||
|
scene would work in the
|
||||||
|
<code><py-script></code> tag
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
@@ -165,13 +177,14 @@
|
|||||||
<div class="card">
|
<div class="card">
|
||||||
<div class="card-content">
|
<div class="card-content">
|
||||||
<a href="./bokeh.html" target="_blank">
|
<a href="./bokeh.html" target="_blank">
|
||||||
<h2>
|
<h2>Simple Static Bokeh Plot</h2>
|
||||||
Simple Static Bokeh Plot
|
|
||||||
</h2>
|
|
||||||
</a>
|
</a>
|
||||||
<p>
|
<p>
|
||||||
Minimal Bokeh demo demonstrating how to create a simple
|
Minimal Bokeh demo demonstrating how to create a
|
||||||
<a href="https://bokeh.org/" target="_blank">Bokeh</a>
|
simple
|
||||||
|
<a href="https://bokeh.org/" target="_blank"
|
||||||
|
>Bokeh</a
|
||||||
|
>
|
||||||
plot from code
|
plot from code
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
@@ -186,9 +199,12 @@
|
|||||||
</a>
|
</a>
|
||||||
<p>
|
<p>
|
||||||
Interactive demo using a
|
Interactive demo using a
|
||||||
<a href="https://bokeh.org/" target="_blank">Bokeh</a>
|
<a href="https://bokeh.org/" target="_blank"
|
||||||
slider widget to dynamically change a value in the page
|
>Bokeh</a
|
||||||
WARNING: This examples takes a little longer to load. So be patient :)
|
>
|
||||||
|
slider widget to dynamically change a value in the
|
||||||
|
page WARNING: This examples takes a little longer to
|
||||||
|
load. So be patient :)
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
@@ -202,8 +218,11 @@
|
|||||||
</a>
|
</a>
|
||||||
<p>
|
<p>
|
||||||
Interactive KMeans Chart using
|
Interactive KMeans Chart using
|
||||||
<a href="https://panel.holoviz.org/" target="_blank">Panel</a>
|
<a href="https://panel.holoviz.org/" target="_blank"
|
||||||
WARNING: This examples takes a little longer to load. So be patient :)
|
>Panel</a
|
||||||
|
>
|
||||||
|
WARNING: This examples takes a little longer to
|
||||||
|
load. So be patient :)
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
@@ -217,8 +236,11 @@
|
|||||||
</a>
|
</a>
|
||||||
<p>
|
<p>
|
||||||
Interactive Streaming Table and Bokeh plot using
|
Interactive Streaming Table and Bokeh plot using
|
||||||
<a href="https://panel.holoviz.org/" target="_blank">Panel</a>
|
<a href="https://panel.holoviz.org/" target="_blank"
|
||||||
WARNING: This examples takes a little longer to load. So be patient :)
|
>Panel</a
|
||||||
|
>
|
||||||
|
WARNING: This examples takes a little longer to
|
||||||
|
load. So be patient :)
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
@@ -232,9 +254,12 @@
|
|||||||
</a>
|
</a>
|
||||||
<p>
|
<p>
|
||||||
Simple demo showing
|
Simple demo showing
|
||||||
<a href="https://panel.holoviz.org/" target="_blank">Panel</a>
|
<a href="https://panel.holoviz.org/" target="_blank"
|
||||||
widgets interacting with parts of the page
|
>Panel</a
|
||||||
WARNING: This examples takes a little longer to load. So be patient :)
|
>
|
||||||
|
widgets interacting with parts of the page WARNING:
|
||||||
|
This examples takes a little longer to load. So be
|
||||||
|
patient :)
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
@@ -247,23 +272,17 @@
|
|||||||
</h2>
|
</h2>
|
||||||
</a>
|
</a>
|
||||||
<p>
|
<p>
|
||||||
Interactive application exploring the NYC Taxi dataset using
|
Interactive application exploring the NYC Taxi
|
||||||
<a href="https://panel.holoviz.org/" target="_blank">Panel</a> and <a href="https://deck.gl/" target="_blank">DeckGL</a>
|
dataset using
|
||||||
WARNING: This examples takes a little longer to load. So be patient :)
|
<a href="https://panel.holoviz.org/" target="_blank"
|
||||||
</p>
|
>Panel</a
|
||||||
</div>
|
>
|
||||||
</div>
|
and
|
||||||
|
<a href="https://deck.gl/" target="_blank"
|
||||||
<div class="card">
|
>DeckGL</a
|
||||||
<div class="card-content">
|
>
|
||||||
<a href="./toga/freedom.html" target="_blank">
|
WARNING: This examples takes a little longer to
|
||||||
<h2 class="text-2xl font-bold text-blue-600">
|
load. So be patient :)
|
||||||
Freedom Units!
|
|
||||||
</h2>
|
|
||||||
</a>
|
|
||||||
<p>
|
|
||||||
A <a href="https://beeware.org/project/projects/libraries/toga/" target="_blank">Toga</a>
|
|
||||||
application (a Fahrenheit to Celsius converter), rendered as a Single Page App
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
@@ -277,8 +296,14 @@
|
|||||||
</a>
|
</a>
|
||||||
<p>
|
<p>
|
||||||
Visualization of Mandelbrot and Julia sets with
|
Visualization of Mandelbrot and Julia sets with
|
||||||
<a href="https://numpy.org/" target="_blank">Numpy</a> and
|
<a href="https://numpy.org/" target="_blank"
|
||||||
<a href="https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API" target="_blank">
|
>Numpy</a
|
||||||
|
>
|
||||||
|
and
|
||||||
|
<a
|
||||||
|
href="https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API"
|
||||||
|
target="_blank"
|
||||||
|
>
|
||||||
HTML5 canvas
|
HTML5 canvas
|
||||||
</a>
|
</a>
|
||||||
</p>
|
</p>
|
||||||
@@ -286,5 +311,5 @@
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|||||||
@@ -1,4 +1,7 @@
|
|||||||
html, body, ul, li {
|
html,
|
||||||
|
body,
|
||||||
|
ul,
|
||||||
|
li {
|
||||||
margin: 0;
|
margin: 0;
|
||||||
border: 0;
|
border: 0;
|
||||||
padding: 0;
|
padding: 0;
|
||||||
|
|||||||
@@ -1,21 +1,20 @@
|
|||||||
(function() {
|
(function () {
|
||||||
if (typeof Mario === 'undefined')
|
if (typeof Mario === "undefined") window.Mario = {};
|
||||||
window.Mario = {};
|
|
||||||
|
|
||||||
var Bcoin = Mario.Bcoin = function(pos) {
|
var Bcoin = (Mario.Bcoin = function (pos) {
|
||||||
Mario.Entity.call(this, {
|
Mario.Entity.call(this, {
|
||||||
pos: pos,
|
pos: pos,
|
||||||
sprite: level.bcoinSprite(),
|
sprite: level.bcoinSprite(),
|
||||||
hitbox: [0,0,16,16]
|
hitbox: [0, 0, 16, 16],
|
||||||
|
});
|
||||||
});
|
});
|
||||||
}
|
|
||||||
|
|
||||||
Mario.Util.inherits(Bcoin, Mario.Entity);
|
Mario.Util.inherits(Bcoin, Mario.Entity);
|
||||||
|
|
||||||
//I'm not sure whether it makes sense to use an array for vel and acc here
|
//I'm not sure whether it makes sense to use an array for vel and acc here
|
||||||
//in order to keep with convention, or to just use a single value, since
|
//in order to keep with convention, or to just use a single value, since
|
||||||
//it's literally impossible for these to move left or right.
|
//it's literally impossible for these to move left or right.
|
||||||
Bcoin.prototype.spawn = function() {
|
Bcoin.prototype.spawn = function () {
|
||||||
sounds.coin.currentTime = 0.05;
|
sounds.coin.currentTime = 0.05;
|
||||||
sounds.coin.play();
|
sounds.coin.play();
|
||||||
this.idx = level.items.length;
|
this.idx = level.items.length;
|
||||||
@@ -23,9 +22,9 @@
|
|||||||
this.active = true;
|
this.active = true;
|
||||||
this.vel = -12;
|
this.vel = -12;
|
||||||
this.targetpos = this.pos[1] - 32;
|
this.targetpos = this.pos[1] - 32;
|
||||||
}
|
};
|
||||||
|
|
||||||
Bcoin.prototype.update = function(dt) {
|
Bcoin.prototype.update = function (dt) {
|
||||||
if (!this.active) return;
|
if (!this.active) return;
|
||||||
|
|
||||||
if (this.vel > 0 && this.pos[1] >= this.targetpos) {
|
if (this.vel > 0 && this.pos[1] >= this.targetpos) {
|
||||||
@@ -38,8 +37,7 @@
|
|||||||
this.vel += this.acc;
|
this.vel += this.acc;
|
||||||
this.pos[1] += this.vel;
|
this.pos[1] += this.vel;
|
||||||
this.sprite.update(dt);
|
this.sprite.update(dt);
|
||||||
}
|
};
|
||||||
|
|
||||||
Bcoin.prototype.checkCollisions = function() {;}
|
|
||||||
|
|
||||||
|
Bcoin.prototype.checkCollisions = function () {};
|
||||||
})();
|
})();
|
||||||
|
|||||||
@@ -1,11 +1,10 @@
|
|||||||
(function() {
|
(function () {
|
||||||
if (typeof Mario === 'undefined')
|
if (typeof Mario === "undefined") window.Mario = {};
|
||||||
window.Mario = {};
|
|
||||||
|
|
||||||
//TODO: clean up the logic for sprite switching.
|
//TODO: clean up the logic for sprite switching.
|
||||||
//TODO: There's a weird bug with the collision logic. Look into it.
|
//TODO: There's a weird bug with the collision logic. Look into it.
|
||||||
|
|
||||||
var Block = Mario.Block = function(options) {
|
var Block = (Mario.Block = function (options) {
|
||||||
this.item = options.item;
|
this.item = options.item;
|
||||||
this.usedSprite = options.usedSprite;
|
this.usedSprite = options.usedSprite;
|
||||||
this.bounceSprite = options.bounceSprite;
|
this.bounceSprite = options.bounceSprite;
|
||||||
@@ -14,26 +13,27 @@
|
|||||||
Mario.Entity.call(this, {
|
Mario.Entity.call(this, {
|
||||||
pos: options.pos,
|
pos: options.pos,
|
||||||
sprite: options.sprite,
|
sprite: options.sprite,
|
||||||
hitbox: [0,0,16,16]
|
hitbox: [0, 0, 16, 16],
|
||||||
});
|
});
|
||||||
|
|
||||||
this.standing = true;
|
this.standing = true;
|
||||||
}
|
});
|
||||||
|
|
||||||
Mario.Util.inherits(Block, Mario.Floor);
|
Mario.Util.inherits(Block, Mario.Floor);
|
||||||
|
|
||||||
Block.prototype.break = function() {
|
Block.prototype.break = function () {
|
||||||
sounds.breakBlock.play();
|
sounds.breakBlock.play();
|
||||||
(new Mario.Rubble()).spawn(this.pos);
|
new Mario.Rubble().spawn(this.pos);
|
||||||
var x = this.pos[0] / 16, y = this.pos[1] / 16;
|
var x = this.pos[0] / 16,
|
||||||
|
y = this.pos[1] / 16;
|
||||||
delete level.blocks[y][x];
|
delete level.blocks[y][x];
|
||||||
}
|
};
|
||||||
|
|
||||||
Block.prototype.bonk = function(power) {
|
Block.prototype.bonk = function (power) {
|
||||||
sounds.bump.play();
|
sounds.bump.play();
|
||||||
if (power > 0 && this.breakable) {
|
if (power > 0 && this.breakable) {
|
||||||
this.break();
|
this.break();
|
||||||
} else if (this.standing){
|
} else if (this.standing) {
|
||||||
this.standing = false;
|
this.standing = false;
|
||||||
if (this.item) {
|
if (this.item) {
|
||||||
this.item.spawn();
|
this.item.spawn();
|
||||||
@@ -51,9 +51,9 @@
|
|||||||
|
|
||||||
this.vel[1] = -2;
|
this.vel[1] = -2;
|
||||||
}
|
}
|
||||||
}
|
};
|
||||||
|
|
||||||
Block.prototype.update = function(dt, gameTime) {
|
Block.prototype.update = function (dt, gameTime) {
|
||||||
if (!this.standing) {
|
if (!this.standing) {
|
||||||
if (this.pos[1] < this.opos[1] - 8) {
|
if (this.pos[1] < this.opos[1] - 8) {
|
||||||
this.vel[1] = 2;
|
this.vel[1] = 2;
|
||||||
@@ -68,14 +68,17 @@
|
|||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
if (this.sprite === this.usedSprite) {
|
if (this.sprite === this.usedSprite) {
|
||||||
var x = this.pos[0] / 16, y = this.pos[1] / 16;
|
var x = this.pos[0] / 16,
|
||||||
level.statics[y][x] = new Mario.Floor(this.pos, this.usedSprite);
|
y = this.pos[1] / 16;
|
||||||
|
level.statics[y][x] = new Mario.Floor(
|
||||||
|
this.pos,
|
||||||
|
this.usedSprite,
|
||||||
|
);
|
||||||
delete level.blocks[y][x];
|
delete level.blocks[y][x];
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
this.pos[1] += this.vel[1];
|
this.pos[1] += this.vel[1];
|
||||||
this.sprite.update(dt, gameTime);
|
this.sprite.update(dt, gameTime);
|
||||||
}
|
};
|
||||||
|
|
||||||
})();
|
})();
|
||||||
|
|||||||
@@ -1,47 +1,62 @@
|
|||||||
(function() {
|
(function () {
|
||||||
if (typeof Mario === 'undefined')
|
if (typeof Mario === "undefined") window.Mario = {};
|
||||||
window.Mario = {};
|
|
||||||
|
|
||||||
var Coin = Mario.Coin = function(pos, sprite) {
|
var Coin = (Mario.Coin = function (pos, sprite) {
|
||||||
Mario.Entity.call(this, {
|
Mario.Entity.call(this, {
|
||||||
pos: pos,
|
pos: pos,
|
||||||
sprite: sprite,
|
sprite: sprite,
|
||||||
hitbox: [0,0,16,16]
|
hitbox: [0, 0, 16, 16],
|
||||||
|
});
|
||||||
|
this.idx = level.items.length;
|
||||||
});
|
});
|
||||||
this.idx = level.items.length
|
|
||||||
}
|
|
||||||
|
|
||||||
Mario.Util.inherits(Coin, Mario.Entity);
|
Mario.Util.inherits(Coin, Mario.Entity);
|
||||||
|
|
||||||
Coin.prototype.isPlayerCollided = function() {
|
Coin.prototype.isPlayerCollided = function () {
|
||||||
//the first two elements of the hitbox array are an offset, so let's do this now.
|
//the first two elements of the hitbox array are an offset, so let's do this now.
|
||||||
var hpos1 = [this.pos[0] + this.hitbox[0], this.pos[1] + this.hitbox[1]];
|
var hpos1 = [
|
||||||
var hpos2 = [player.pos[0] + player.hitbox[0], player.pos[1] + player.hitbox[1]];
|
this.pos[0] + this.hitbox[0],
|
||||||
|
this.pos[1] + this.hitbox[1],
|
||||||
|
];
|
||||||
|
var hpos2 = [
|
||||||
|
player.pos[0] + player.hitbox[0],
|
||||||
|
player.pos[1] + player.hitbox[1],
|
||||||
|
];
|
||||||
|
|
||||||
//if the hitboxes actually overlap
|
//if the hitboxes actually overlap
|
||||||
if (!(hpos1[0] > hpos2[0]+player.hitbox[2] || (hpos1[0]+this.hitbox[2] < hpos2[0]))) {
|
if (
|
||||||
if (!(hpos1[1] > hpos2[1]+player.hitbox[3] || (hpos1[1]+this.hitbox[3] < hpos2[1]))) {
|
!(
|
||||||
|
hpos1[0] > hpos2[0] + player.hitbox[2] ||
|
||||||
|
hpos1[0] + this.hitbox[2] < hpos2[0]
|
||||||
|
)
|
||||||
|
) {
|
||||||
|
if (
|
||||||
|
!(
|
||||||
|
hpos1[1] > hpos2[1] + player.hitbox[3] ||
|
||||||
|
hpos1[1] + this.hitbox[3] < hpos2[1]
|
||||||
|
)
|
||||||
|
) {
|
||||||
this.collect();
|
this.collect();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
};
|
||||||
|
|
||||||
Coin.prototype.render = function(ctx, vX, vY) {
|
Coin.prototype.render = function (ctx, vX, vY) {
|
||||||
this.sprite.render(ctx, this.pos[0], this.pos[1], vX, vY);
|
this.sprite.render(ctx, this.pos[0], this.pos[1], vX, vY);
|
||||||
}
|
};
|
||||||
|
|
||||||
//money is not affected by gravity, you see.
|
//money is not affected by gravity, you see.
|
||||||
Coin.prototype.update = function(dt) {
|
Coin.prototype.update = function (dt) {
|
||||||
this.sprite.update(dt);
|
this.sprite.update(dt);
|
||||||
}
|
};
|
||||||
Coin.prototype.checkCollisions = function() {
|
Coin.prototype.checkCollisions = function () {
|
||||||
this.isPlayerCollided();
|
this.isPlayerCollided();
|
||||||
}
|
};
|
||||||
|
|
||||||
Coin.prototype.collect = function() {
|
Coin.prototype.collect = function () {
|
||||||
sounds.coin.currentTime = 0.05;
|
sounds.coin.currentTime = 0.05;
|
||||||
sounds.coin.play();
|
sounds.coin.play();
|
||||||
player.coins += 1;
|
player.coins += 1;
|
||||||
delete level.items[this.idx]
|
delete level.items[this.idx];
|
||||||
}
|
};
|
||||||
})();
|
})();
|
||||||
|
|||||||
@@ -1,22 +1,21 @@
|
|||||||
(function() {
|
(function () {
|
||||||
if (typeof Mario === 'undefined')
|
if (typeof Mario === "undefined") window.Mario = {};
|
||||||
window.Mario = {};
|
|
||||||
|
|
||||||
var Entity = Mario.Entity = function(options) {
|
var Entity = (Mario.Entity = function (options) {
|
||||||
this.vel = [0,0];
|
this.vel = [0, 0];
|
||||||
this.acc = [0,0];
|
this.acc = [0, 0];
|
||||||
this.standing = true;
|
this.standing = true;
|
||||||
this.pos = options.pos;
|
this.pos = options.pos;
|
||||||
this.sprite = options.sprite;
|
this.sprite = options.sprite;
|
||||||
this.hitbox = options.hitbox;
|
this.hitbox = options.hitbox;
|
||||||
this.left = false;
|
this.left = false;
|
||||||
}
|
});
|
||||||
|
|
||||||
Entity.prototype.render = function(ctx, vX, vY) {
|
Entity.prototype.render = function (ctx, vX, vY) {
|
||||||
this.sprite.render(ctx, this.pos[0], this.pos[1], vX, vY)
|
this.sprite.render(ctx, this.pos[0], this.pos[1], vX, vY);
|
||||||
}
|
};
|
||||||
|
|
||||||
Entity.prototype.collideWall = function(wall) {
|
Entity.prototype.collideWall = function (wall) {
|
||||||
//the wall will always be a 16x16 block with hitbox = [0,0,16,16].
|
//the wall will always be a 16x16 block with hitbox = [0,0,16,16].
|
||||||
if (this.pos[0] > wall.pos[0]) {
|
if (this.pos[0] > wall.pos[0]) {
|
||||||
//from the right
|
//from the right
|
||||||
@@ -24,11 +23,12 @@
|
|||||||
this.vel[0] = Math.max(0, this.vel[0]);
|
this.vel[0] = Math.max(0, this.vel[0]);
|
||||||
this.acc[0] = Math.max(0, this.acc[0]);
|
this.acc[0] = Math.max(0, this.acc[0]);
|
||||||
} else {
|
} else {
|
||||||
this.pos[0] = wall.pos[0] + wall.hitbox[0] - this.hitbox[2] - this.hitbox[0];
|
this.pos[0] =
|
||||||
|
wall.pos[0] + wall.hitbox[0] - this.hitbox[2] - this.hitbox[0];
|
||||||
this.vel[0] = Math.min(0, this.vel[0]);
|
this.vel[0] = Math.min(0, this.vel[0]);
|
||||||
this.acc[0] = Math.min(0, this.acc[0]);
|
this.acc[0] = Math.min(0, this.acc[0]);
|
||||||
}
|
}
|
||||||
}
|
};
|
||||||
|
|
||||||
Entity.prototype.bump = function() {;}
|
Entity.prototype.bump = function () {};
|
||||||
})();
|
})();
|
||||||
|
|||||||
@@ -1,21 +1,26 @@
|
|||||||
(function() {
|
(function () {
|
||||||
if (typeof Mario === 'undefined')
|
if (typeof Mario === "undefined") window.Mario = {};
|
||||||
window.Mario = {};
|
|
||||||
|
|
||||||
var Fireball = Mario.Fireball = function(pos) {
|
var Fireball = (Mario.Fireball = function (pos) {
|
||||||
this.hit = 0;
|
this.hit = 0;
|
||||||
this.standing = false;
|
this.standing = false;
|
||||||
|
|
||||||
Mario.Entity.call(this, {
|
Mario.Entity.call(this, {
|
||||||
pos: pos,
|
pos: pos,
|
||||||
sprite: new Mario.Sprite('sprites/items.png', [96, 144], [8,8], 5, [0,1,2,3]),
|
sprite: new Mario.Sprite(
|
||||||
hitbox: [0,0,8,8]
|
"sprites/items.png",
|
||||||
|
[96, 144],
|
||||||
|
[8, 8],
|
||||||
|
5,
|
||||||
|
[0, 1, 2, 3],
|
||||||
|
),
|
||||||
|
hitbox: [0, 0, 8, 8],
|
||||||
|
});
|
||||||
});
|
});
|
||||||
}
|
|
||||||
|
|
||||||
Mario.Util.inherits(Fireball, Mario.Entity);
|
Mario.Util.inherits(Fireball, Mario.Entity);
|
||||||
|
|
||||||
Fireball.prototype.spawn = function(left) {
|
Fireball.prototype.spawn = function (left) {
|
||||||
sounds.fireball.currentTime = 0;
|
sounds.fireball.currentTime = 0;
|
||||||
sounds.fireball.play();
|
sounds.fireball.play();
|
||||||
if (fireballs[0]) {
|
if (fireballs[0]) {
|
||||||
@@ -25,20 +30,20 @@
|
|||||||
this.idx = 0;
|
this.idx = 0;
|
||||||
fireballs[0] = this;
|
fireballs[0] = this;
|
||||||
}
|
}
|
||||||
this.vel[0] = (left ? -5 : 5);
|
this.vel[0] = left ? -5 : 5;
|
||||||
this.standing = false;
|
this.standing = false;
|
||||||
this.vel[1] = 0;
|
this.vel[1] = 0;
|
||||||
}
|
};
|
||||||
|
|
||||||
Fireball.prototype.render = function(ctx, vX, vY) {
|
Fireball.prototype.render = function (ctx, vX, vY) {
|
||||||
this.sprite.render(ctx, this.pos[0], this.pos[1], vX, vY);
|
this.sprite.render(ctx, this.pos[0], this.pos[1], vX, vY);
|
||||||
}
|
};
|
||||||
|
|
||||||
Fireball.prototype.update = function(dt) {
|
Fireball.prototype.update = function (dt) {
|
||||||
if (this.hit == 1) {
|
if (this.hit == 1) {
|
||||||
this.sprite.pos = [96, 160];
|
this.sprite.pos = [96, 160];
|
||||||
this.sprite.size = [16,16];
|
this.sprite.size = [16, 16];
|
||||||
this.sprite.frames = [0,1,2];
|
this.sprite.frames = [0, 1, 2];
|
||||||
this.sprite.speed = 8;
|
this.sprite.speed = 8;
|
||||||
this.hit += 1;
|
this.hit += 1;
|
||||||
return;
|
return;
|
||||||
@@ -67,13 +72,13 @@
|
|||||||
this.hit = 1;
|
this.hit = 1;
|
||||||
}
|
}
|
||||||
this.sprite.update(dt);
|
this.sprite.update(dt);
|
||||||
}
|
};
|
||||||
|
|
||||||
Fireball.prototype.collideWall = function() {
|
Fireball.prototype.collideWall = function () {
|
||||||
if (!this.hit) this.hit = 1;
|
if (!this.hit) this.hit = 1;
|
||||||
}
|
};
|
||||||
|
|
||||||
Fireball.prototype.checkCollisions = function() {
|
Fireball.prototype.checkCollisions = function () {
|
||||||
if (this.hit) return;
|
if (this.hit) return;
|
||||||
var h = this.pos[1] % 16 < 8 ? 1 : 2;
|
var h = this.pos[1] % 16 < 8 ? 1 : 2;
|
||||||
var w = this.pos[0] % 16 < 8 ? 1 : 2;
|
var w = this.pos[0] % 16 < 8 ? 1 : 2;
|
||||||
@@ -99,28 +104,42 @@
|
|||||||
}
|
}
|
||||||
|
|
||||||
var that = this;
|
var that = this;
|
||||||
level.enemies.forEach(function(enemy){
|
level.enemies.forEach(function (enemy) {
|
||||||
if (enemy.flipping || enemy.pos[0] - vX > 336){ //stop checking once we get to far away dudes.
|
if (enemy.flipping || enemy.pos[0] - vX > 336) {
|
||||||
|
//stop checking once we get to far away dudes.
|
||||||
return;
|
return;
|
||||||
} else {
|
} else {
|
||||||
that.isCollideWith(enemy);
|
that.isCollideWith(enemy);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
}
|
};
|
||||||
|
|
||||||
Fireball.prototype.isCollideWith = function(ent) {
|
Fireball.prototype.isCollideWith = function (ent) {
|
||||||
//the first two elements of the hitbox array are an offset, so let's do this now.
|
//the first two elements of the hitbox array are an offset, so let's do this now.
|
||||||
var hpos1 = [this.pos[0] + this.hitbox[0], this.pos[1] + this.hitbox[1]];
|
var hpos1 = [
|
||||||
|
this.pos[0] + this.hitbox[0],
|
||||||
|
this.pos[1] + this.hitbox[1],
|
||||||
|
];
|
||||||
var hpos2 = [ent.pos[0] + ent.hitbox[0], ent.pos[1] + ent.hitbox[1]];
|
var hpos2 = [ent.pos[0] + ent.hitbox[0], ent.pos[1] + ent.hitbox[1]];
|
||||||
|
|
||||||
//if the hitboxes actually overlap
|
//if the hitboxes actually overlap
|
||||||
if (!(hpos1[0] > hpos2[0]+ent.hitbox[2] || (hpos1[0]+this.hitbox[2] < hpos2[0]))) {
|
if (
|
||||||
if (!(hpos1[1] > hpos2[1]+ent.hitbox[3] || (hpos1[1]+this.hitbox[3] < hpos2[1]))) {
|
!(
|
||||||
|
hpos1[0] > hpos2[0] + ent.hitbox[2] ||
|
||||||
|
hpos1[0] + this.hitbox[2] < hpos2[0]
|
||||||
|
)
|
||||||
|
) {
|
||||||
|
if (
|
||||||
|
!(
|
||||||
|
hpos1[1] > hpos2[1] + ent.hitbox[3] ||
|
||||||
|
hpos1[1] + this.hitbox[3] < hpos2[1]
|
||||||
|
)
|
||||||
|
) {
|
||||||
this.hit = 1;
|
this.hit = 1;
|
||||||
ent.bump();
|
ent.bump();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
Fireball.prototype.bump = function() {;}
|
Fireball.prototype.bump = function () {};
|
||||||
})();
|
})();
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user