PyScript CLI

PyScript的命令行界面。

快速将Python脚本包装到HTML模板中，预先配置了PyScript。

❯ pyscript

 Usage: pyscript [OPTIONS] COMMAND [ARGS]...

 Command Line Interface for PyScript.

╭─ Options ──────────────────────────────────────────────────────────────────────────────────────╮
│ --version          Show project version and exit.                                              │
│ --help             Show this message and exit.                                                 │
╰────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────────────────────────╮
│ create  Create a new pyscript project with the passed in name, creating a new directory in the │
│         current directory. Alternatively, use `--wrap` so as to embed a python file instead.   │
│ run     Creates a local server to run the app on the path and port specified.                  │
╰────────────────────────────────────────────────────────────────────────────────────────────────╯

安装

使用Pip

$ pip install pyscript

从存储库克隆中安装开发设置

请参阅CONTRIBUTING页面上的开发者设置部分

使用方法

运行

启动本地服务器以在指定路径和端口上运行

$ pyscript run <path_of_folder>

默认情况下，这将使用 localhost:8000 访问 path_of_folder 文件夹，并在浏览器窗口中打开URL。如果没有提供 path_of_folder，则默认为当前目录。

要使用不同的端口，请使用 --port 选项。

$ pyscript run <path_of_folder> --port 9000

要避免打开浏览器窗口，请使用 --no-view 选项。

$ pyscript run <path_of_folder> --no-view

创建

使用传递的名称创建一个新的 pyscript 项目，创建一个新目录

$ pyscript create <name_of_app>

这将创建一个名为 name_of_app 的新目录，位于当前目录下。

交互式提示将进一步询问有关 app 的描述、作者姓名、作者电子邮件 等信息。当然，可以通过 --author-name 等选项提供。使用 pyscript create --help 获取更多信息。

以下文件将被创建

• index.html：项目的起始页面
• pyscript.toml：项目元数据和配置文件
• main.py：一个“Hello world”Python启动模块

使用 --wrap 集成 Python 文件或命令字符串

• 将 Python 脚本嵌入 PyScript HTML 文件中

$ pyscript create --wrap <filename.py>

这将生成一个项目，即当前目录下名为 filename 的新目录。

类似于上面，交互式提示将进一步询问元数据信息。

以下文件将被创建

• index.html：项目的起始页面
• pyscript.toml：项目元数据和配置文件
• main.py：包含 filename.py 的代码

可以使用 -o 或 --output 选项来覆盖

$ pyscript create --wrap <filename.py> -o <another_filename.html>

例如，上述目录中创建的 HTML 文件现在将命名为 another_filename.html

• 带有 --command 选项的非常简单的命令示例

可以使用 -c 或 --command 选项来演示非常简单的案例。

默认情况下，创建的项目文件夹名称为 pyscript-command-app，HTML 文件名为 index.html。

-o/--output 选项可以与 -c/--command 选项一起使用，以配置项目文件夹的名称以及生成的 HTML 文件的名称。

$ pyscript create --wrap -c 'print("Hello World!")' -o <output_filename.html>

这将在当前目录下生成一个项目，即名为 output_filename 的新目录。

类似于上面，交互式提示将进一步询问元数据信息。

以下文件将被创建

• output_filename.html：项目的起始页面
• pyscript.toml：项目元数据和配置文件
• main.py：包含通过 -c/--command 传递的命令字符串的代码