jprdonnelly/pyscript
1
0
Fork 0
mirror of https://github.com/pyscript/pyscript.git synced 2026-02-12 13:00:31 -05:00
Code Issues Projects Releases Wiki Activity

split py-config into sections (#1022)

Browse Source 
* split into sections

* new section about custom keys

* link to fetch section

* add example for using runtime
This commit is contained in:
Madhur Tandon
2022-12-06 19:26:19 +05:30
committed by GitHub
parent 4337e6833a
commit ee2f46cfb9
1 changed files with 43 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

55
docs/reference/elements/py-config.md
View File

@@ -15,14 +15,18 @@ The `<py-config>` element should be placed within the `<body>` element.
## Examples
### `<py-config>` using TOML (default)
### Defining an inline config
- `<py-config>` using TOML (default)
```{note}
Reminder: when using TOML, any Arrays of Tables defined with double-brackets (like `[[runtimes]]` and `[[fetch]]` must come after individual keys (like `paths = ...` and `packages=...`)
Reminder: when using TOML, any Arrays of Tables defined with double-brackets (like `[[runtimes]]` and `[[fetch]]` must come after individual keys (like `plugins = ...` and `packages=...`)
```
```html
<py-config>
autoclose_loader = true
[splashscreen]
autoclose = true
[[runtimes]]
src = "https://cdn.jsdelivr.net/pyodide/v0.21.2/full/pyodide.js"
@@ -31,12 +35,14 @@ Reminder: when using TOML, any Arrays of Tables defined with double-brackets (li
</py-config>
```
### JSON config using the `type` attribute.
- `<py-config>` using JSON via `type` attribute
```html
<py-config type="json">
{
"autoclose_loader": true,
"splashscreen": {
"autoclose": true
},
"runtimes": [{
"src": "https://cdn.jsdelivr.net/pyodide/v0.21.2/full/pyodide.js",
"name": "pyodide-0.21.2",
@@ -46,7 +52,9 @@ Reminder: when using TOML, any Arrays of Tables defined with double-brackets (li
</py-config>
```
### Use of the `src` attribute:
### Defining a file based config
- Use of the `src` attribute
```html
<py-config src="./custom.toml"></py-config>
@@ -54,14 +62,17 @@ Reminder: when using TOML, any Arrays of Tables defined with double-brackets (li
where `custom.toml` contains
```toml
autoclose_loader = true
[splashscreen]
autoclose = true
[[runtimes]]
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.
- JSON using the `type` and `src` attribute
```html
<py-config type="json" src="./custom.json"></py-config>
```
@@ -69,7 +80,9 @@ where `custom.json` contains
```json
{
"autoclose_loader": true,
"splashscreen": {
"autoclose": true,
},
"runtimes": [{
"src": "https://cdn.jsdelivr.net/pyodide/v0.21.2/full/pyodide.js",
"name": "pyodide-0.21.2",
@@ -78,7 +91,7 @@ where `custom.json` contains
}
```
### Expanding with inline configuration
### 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:
@@ -109,6 +122,8 @@ This is helpful in cases where a number of applications share a common configura
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).
@@ -183,7 +198,8 @@ def make_x_and_y(n):
```
In the HTML tag `<py-config>`, paths to local modules are provided in the
`files` key within the `fetch` section.
`files` key within the `fetch` section. Refer to the [fetch](#fetch) section for
more details.
```html
<html>
@@ -232,7 +248,7 @@ The following optional values are supported by `<py-config>`:
| `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. |
### Fetch
### <a name="fetch">Fetch</a>
A fetch configuration consists of the following:
| Value | Type | Description |
@@ -253,6 +269,21 @@ A runtime configuration consists of the following:
| `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. |
#### Example
- The default runtime is `pyodide`, another version of which can be specified as following
```html
<py-config>
[[runtimes]]
src = "https://cdn.jsdelivr.net/pyodide/v0.20.0/full/pyodide.js"
name = "pyodide-0.20.0"
lang = "python"
</py-config>
```
## 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: