preswald

环境要求

• Python 环境（README 指向 python.org/downloads，建议 3.9+）
• 已安装 pip 或 uv 包管理器
• 可访问 PyPI 的网络环境

安装与启动步骤

1. 1安装 Preswald

   用 pip 全局安装 preswald 包；若使用 uv，可执行 uv pip install preswald。建议在虚拟环境中安装以避免依赖冲突。

   pip install preswald

   复制

2. 2初始化应用

   在当前目录生成名为 my_app 的模板工程，包含 hello.py、preswald.toml、secrets.toml、data/sample.csv 和 images/logo.png。

   preswald init my_app

   复制

3. 3进入项目目录

   切换到刚生成的 my_app 目录，后续所有命令都在该目录下执行。

   cd my_app

   复制

4. 4编写应用逻辑

   编辑 hello.py，用 preswald 提供的 text、table、get_df 等组件写页面。README 示例先输出标题，再读取 sample.csv 并渲染表格。

5. 5启动开发服务器

   在项目目录执行 preswald run，会拉起开发服务器。默认端口通常为 8501，可在 preswald.toml 的 [project] port 中修改。

   preswald run

   复制

6. 6浏览器访问应用

   打开浏览器访问终端提示的地址，默认 http://localhost:8501，即可看到你的第一个 Preswald 应用。

关键配置

如何确认成功

运行 preswald run 后终端出现 “ App running at: http://localhost:8501”，浏览器打开该地址能看到页面内容。

常见问题

注意事项

• 初始化生成的 data/sample.csv 与 images/logo.png 分别是示例数据与品牌图片，可替换为自己的文件。
• preswald.toml 同时管理元数据、运行时设置、UI 品牌（branding）与数据源配置。
• 主题色等外观可在 [branding] 中设置，例如 primaryColor = "#F89613"。