8000 Merge pull request #94 from pyscript/2024.5.1 · pyscript/docs@bd3041c · GitHub
[go: up one dir, main page]

Skip to content

Commit bd3041c

Browse files
authored
Merge pull request #94 from pyscript/2024.5.1
Editing, rewrite and corrections for all docs, and bump to 2024.5.
2 parents 5f73c10 + a0fd3a5 commit bd3041c

23 files changed

+2160
-1279
lines changed

docs/assets/images/pyscript.com.png

46.7 KB
Loading

docs/beginning-pyscript.md

Lines changed: 26 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
# Beginning PyScript
22

3-
PyScript is a platform for running Python in modern web browsers.
3+
PyScript is a platform for running
4+
<a href="https://python.org/" target="_blank">Python</a>
5+
in modern web browsers.
46

5-
Create apps with a PyScript development environment: write code, curate the
6-
project's assets, and test your application.
7+
Create apps with a
8+
<a href="https://pyscript.com/" target="_blank">PyScript development environment</a>:
9+
write code, curate the project's assets, and test your application.
710

8-
To distribute a PyScript application, host it as a static web site, then click
11+
To distribute a PyScript application, host it on the web, then click
912
on the link to your application. PyScript and the browser do the rest.
1013

1114
This page covers these core aspects of PyScript in a beginner friendly manner.
@@ -38,12 +41,6 @@ Create these files with your favourite code editor on your local file system.
3841
Alternatively, [pyscript.com](https://pyscript.com) will take away all the pain
3942
of organising, previewing and deploying your application.
4043

41-
If you decide to use [pyscript.com](https://pyscript.com) (recommended for first
42-
steps), once signed in, create a new project by pressing the "+" button on the
43-
left hand side below the site's logo. You'll be presented with a page
44-
containing three columns (listing your files, showing your code and previewing
45-
the app). The "save" and "run" buttons do exactly what you'd expect.
46-
4744
If you're using your local file system, you'll need a way to view your
4845
application in your browser. If you already have Python installed on
4946
your local machine, serve your files with the following command run from your
@@ -62,22 +59,31 @@ refresh the page (`CTRL-R`) to see any updates you may have made.
6259
[Live Server extension](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer)
6360
can be used to reload the page as you edit your files.
6461

62+
If you decide to use [pyscript.com](https://pyscript.com) (recommended for
63+
first steps), once signed in, create a new project by pressing the "+" button
64+
on the left hand side below the site's logo. You'll be presented with a page
65+
containing three columns (listing your files, showing your code and previewing
66+
the app). The "save" and "run" buttons do exactly what you'd expect.
67+
68+
![PyScript.com](assets/images/pyscript.com.png)
69+
6570
Let's build a simple PyScript application that translates English 🇬🇧 into
6671
Pirate 🏴‍☠️ speak. In order to do this we'll make use of the
6772
[arrr](https://arrr.readthedocs.io/en/latest/) library. By building this app
6873
you'll be introduced to all the core concepts of PyScript at an introductory
6974
level.
7075

71-
You can see this application embedded into the page below:
76+
You can see this application embedded into the page below (try it out!):
7277

7378
<iframe src="https://ntoll.pyscriptapps.com/piratical/v5/" style="border: 1px solid black; width:100%;min-height: 400px; border-radius: 0.2rem; box-shadow: var(--md-shadow-z1);"></iframe>
7479

7580
Let's explore each of the three files that make this app work.
7681

7782
### pyscript.json
7883

79-
This file tells PyScript and your browser about various configurable aspects of
80-
your application. Put simply, it tells PyScript what it needs in order to run
84+
This file tells PyScript and your browser about various
85+
[configurable aspects](../user-guide/configuration)
86+
of your application. Put simply, it tells PyScript what it needs in order to run
8187
your application. The only thing we need to show is that we require the third
8288
party `arrr` module to do the
8389
[actual translation](https://arrr.readthedocs.io/en/latest/).
@@ -106,8 +112,8 @@ module in the document's `<head>` tag:
106112
<meta charset="utf-8" />
107113
<meta name="viewport" content="width=device-width,initial-scale=1" />
108114
<title>🦜 Polyglot - Piratical PyScript</title>
109-
<link rel="stylesheet" href="https://pyscript.net/releases/2024.4.1/core.css">
110-
<script type="module" src="https://pyscript.net/releases/2024.4.1/core.js"></script>
115+
<link rel="stylesheet" href="https://pyscript.net/releases/2024.5.1/core.css">
116+
<script type="module" src="https://pyscript.net/releases/2024.5.1/core.js"></script>
111117
</head>
112118
<body>
113119

@@ -157,8 +163,8 @@ In the end, our HTML should look like this:
157163
<meta charset="utf-8" />
158164
<meta name="viewport" content="width=device-width,initial-scale=1" />
159165
<title>🦜 Polyglot - Piratical PyScript</title>
160-
<link rel="stylesheet" href="https://pyscript.net/releases/2024.4.1/core.css">
161-
<script type="module" src="https://pyscript.net/releases/2024.4.1/core.js"></script>
166+
<link rel="stylesheet" href="https://pyscript.net/releases/2024.5.1/core.css">
167+
<script type="module" src="https://pyscript.net/releases/2024.5.1/core.js"></script>
162168
</head>
163169
<body>
164170
<h1>Polyglot 🦜 💬 🇬🇧 ➡️ 🏴‍☠️</h1>
@@ -232,7 +238,7 @@ Pirate-ish.
232238
Alternatively, [click here to see a working example of this app](https://ntoll.pyscriptapps.com/piratical/v5/).
233239
Notice that the bottom right hand corner contains a link to view the code on
234240
[pyscript.com](https://pyscript.com). Why not explore the code, copy it to your own
235-
account and change it to your satisfaction.
241+
account and change it to your satisfaction?
236242

237243
### From a web server
238244

@@ -261,4 +267,5 @@ needed to build yet more interesting things of your own.
261267

262268
PyScript is extremely powerful, and these beginner steps only just scratch the
263269
surface. To learn about PyScript in more depth, check out
264-
[our user guide](user-guide/index.md).
270+
[our user guide](user-guide/index.md) or
271+
[explore our example applications](../examples).

docs/contributing.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Bugs are tracked on the
1818

1919
!!! warning "Check first"
2020

21-
Please check your bug has not already been reported by someone else byi
21+
Please check your bug has not already been reported by someone else by
2222
searching the existing issues before filing a new one. Once your issue is
2323
filed, it will be triaged by another contributor or maintainer. If there
2424
are questions raised about your issue, please respond promptly.
@@ -50,6 +50,9 @@ If you have an interesting project, a cool hack, or an innovative way to
5050
implement a new capability or feature, please share your work and tell us about
5151
it so we can celebrate and amplify your contribution.
5252

53+
- Show off your creation at our fortnightly
54+
[PyScript FUN](https://discord.com/events/972017612454232116/1227275336115556402)
55+
community call on discord.
5356
- Write up your creation in a blog post.
5457
- Share it on social media.
5558
- Create a demo video.
@@ -63,11 +66,16 @@ Please reach out to us if you'd like advice and feedback.
6366
As an open source project, PyScript has community at its core. In addition to
6467
the ways to engage already outlined, you could join our live community calls.
6568

66-
- PyScript Community Call - weekly on Tuesdays. A coordination call for anyone
67-
participating in the PyScript project.
68-
- PyScript FUN - held every two weeks on a Thursday, this call is an informal,
69+
- [PyScript Community Call](https://discord.com/events/972017612454232116/1227274094366556279)
70+
- weekly on Tuesdays. A coordination call for anyone participating in the
71+
PyScript project.
72+
- [Community Engagement Call](https://discord.com/events/972017612454232116/1227275045965922376)
73+
- weekly on Wednesdays. A non-technical meeting where we coordinate how the
74+
PyScript project engages with, nourishes and grows our wonderful community.
75+
- [PyScript FUN](https://discord.com/events/972017612454232116/1227275336115556402)
76+
- held every two weeks on a Thursday, this call is an informal,
6977
supportive and often humorous "show and tell" of community created projects,
70-
hacks and plugins.
78+
hacks, feedback and plugins.
7179

7280
Announcement of connection details is made via the PyScript
7381
[discord server](https://discord.gg/HxvBtukrg2).
@@ -117,7 +125,9 @@ git remote add upstream https://github.com/pyscript/pyscript.git
117125
git pull upstream main
118126
```
119127

120-
* ???
128+
* Contribute changes using the
129+
[GitHub flow](https://docs.github.com/en/get-started/using-github/github-flow)
130+
model of coding collaboration.
121131

122132
### License terms for contributions
123133

@@ -140,9 +150,3 @@ the existing maintainers.
140150

141151
The Project abides by the Organization's
142152
[trademark policy](https://github.com/pyscript/governance/blob/main/TRADEMARKS.md).
143-
144-
---
145-
146-
Part of MVG-0.1-beta.
147-
Made with love by GitHub. Licensed under the
148-
[CC-BY 4.0 License](https://creativecommons.org/licenses/by-sa/4.0/).

docs/developers.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -253,9 +253,15 @@ is through this environment that you contribute to PyScript.
253253
[discussions section](https://github.com/pyscript/pyscript/discussions) of
254254
our GitHub repository.
255255
256-
* Every Tuesday is a community video call, the details of which are posted onto
256+
* Every Tuesday is a [technical community video call](https://discord.com/events/972017612454232116/1227274094366556279),
257+
the details of which are posted onto
257258
the discord server. Face to face technical discussions happen here.
258259
259-
* Every two weeks, on a Thursday, is a PyScript FUN call, the details of which
260+
* Every Wednesday is a [non-technical community engagement call](https://discord.com/events/972017612454232116/1227275045965922376),
261+
in which we organise how to engage with, grow and nourish our community.
262+
263+
* Every two weeks, on a Thursday, is a
264+
[PyScript FUN call](https://discord.com/events/972017612454232116/1227275336115556402),
265+
the details of which
260266
are also posted to discord. Project show-and-tells, cool hacks, new features
261267
and a generally humorous and creative time is had by all.
File renamed without changes.

0 commit comments

Comments
 (0)
0