mirror of https://github.com/pyscript/pyscript.git synced 2025-12-19 18:27:29 -05:00

Files

Fábio Rosado 06df21e8e3 Add three new tutorials and small tweaks to docs (#972 )

2022-11-24 10:53:22 +00:00

9.9 KiB

Raw Blame History

<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(default) or JSON format.

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 unspecifed.
src	url		Source url to an external configuration file.

Examples

<py-config> using TOML (default)

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=...`)

<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>

JSON config using the type attribute.

<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>

Use of the src attribute:

<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"

JSON using the type attribute.

<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">
  [[fetch]]
  packages = ["numpy"]
</py-config>

This can also be done via JSON using the type attribute.

<py-config type="json" src="./custom.json">
  {
    "fetch": [{
      "packages": ["numpy"]
    }]
  }
</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.

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 runtime) 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 runtime 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)

<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 to get it added here.

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>
    <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 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

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.

# 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.

<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 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>

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.
`runtimes`	List of Runtimes	List of runtime configurations, described below. The default value contains a single Pyodide based runtime.

Fetch

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 string	List of files to be downloaded.

The parameters to_file and files shouldn't be supplied together.

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 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:

<py-config type="toml">
  magic = "unicorn"
</py-config>