<a href="https://nicegui.io/#about"> <img src="https://yellow-cdn.veclightyear.com/835a84d5/6d7a1e3b-ecb2-43c3-9dc1-07881367ddb1.png" width="200" align="right" alt="在线试用！" /> </a>

NiceGUI

NiceGUI 是一个易于使用的、基于 Python 的 UI 框架，可在您的网络浏览器中显示。 您可以创建按钮、对话框、Markdown、3D 场景、图表等多种元素。

它非常适合微型网络应用、仪表板、机器人项目、智能家居解决方案和类似用途。 您也可以在开发过程中使用它，例如调整/配置机器学习算法或调整电机控制器。

NiceGUI 可通过 PyPI 包、Docker 镜像以及 conda-forge 和 GitHub 获取。

<br />

功能特性

• 基于浏览器的图形用户界面
• 代码更改时自动重新加载
• 可作为网络服务器（通过浏览器访问）或本地模式（如桌面窗口）运行
• 标准 GUI 元素，如标签、按钮、复选框、开关、滑块、输入框、文件上传等
• 使用行、列、卡片和对话框进行简单分组
• 通用 HTML 和 Markdown 元素
• 强大的高级元素，用于：
  • 绘制图形和图表
  • 渲染 3D 场景
  • 通过虚拟摇杆获取操控事件
  • 注释和叠加图像
  • 与表格交互
  • 导航可折叠的树形结构
  • 嵌入视频和音频文件
• 内置定时器，可定期刷新数据（最短可至 10 毫秒）
• 直观的数据绑定和可刷新函数，减少代码编写
• 通知、对话框和菜单，提供最新的用户交互体验
• 共享和个人网页
• 易于使用的用户和通用持久化功能
• 能够添加自定义路由和数据响应
• 捕获键盘输入，用于全局快捷键等
• 通过定义主要、次要和强调色来自定义外观
• 生命周期事件和会话数据
• 可在 Jupyter Notebooks 中运行，支持 Python 交互模式
• 支持 Tailwind CSS 的自动补全
• 支持 SVG、Base64 和 emoji 格式的网站图标
• 基于 pytest 的测试框架

安装

python3 -m pip install nicegui

使用方法

在 main.py 文件中编写您的 NiceGUI 界面：

from nicegui import ui

ui.label('你好，NiceGUI！')
ui.button('按钮', on_click=lambda: ui.notify('按钮被点击了'))

ui.run()

使用以下命令启动：

python3 main.py

现在可以通过浏览器访问 http://localhost:8080/ 来使用 GUI。 注意：当您修改代码时，NiceGUI 将自动重新加载页面。

文档和示例

文档托管在 https://nicegui.io/documentation，并提供了大量实时演示。 https://nicegui.io 的全部内容都是使用 NiceGUI 自身实现的， 可以通过 docker run -p 8080:8080 zauberzeug/nicegui 在本地启动，或者从此仓库执行 main.py。

您也可以查看我们的深入示例，了解使用 NiceGUI 可以实现的功能。 在我们的 wiki 中，有一个社区 NiceGUI 项目列表、教程部分、不断增长的 FAQ 列表，以及一些使用 ChatGPT / LLMs 获取 NiceGUI 帮助的策略。

为什么选择 NiceGUI？

我们 Zauberzeug 喜欢 Streamlit， 但觉得它在状态处理方面过于神奇。 在寻找用 Python 编写简单图形用户界面的替代方案时，我们发现了 JustPy。 虽然我们喜欢这种方法，但对于日常使用来说它太"低级 HTML"了。 不过它启发我们在前端使用 Vue 和 Quasar。

我们基于 FastAPI 构建， 而 FastAPI 本身基于 ASGI 框架 Starlette 和 ASGI 网络服务器 Uvicorn， 因为它们性能出色且易于使用。

赞助商

本项目的维护得益于所有贡献者和赞助商。 如果您想支持这个项目并在下方展示您的头像或公司标志，请赞助我们。 💖

<p align="center"> <a href="https://github.com/lechler-gmbh"><img src="https://yellow-cdn.veclightyear.com/835a84d5/1b33e79d-ec8b-4e1f-bc33-175b44834f88.png" width="50px" alt="Lechler GmbH" /></a> </p>

请考虑这种低门槛的贡献形式。 我们非常感谢您的支持。

贡献

感谢您有兴趣为 NiceGUI 做出贡献！我们很高兴有您的加入，并感谢您为使这个项目变得更好所做的努力。

作为一个不断成长的开源项目，我们深知实现我们的目标需要社区的共同努力。因此，我们欢迎各种形式的贡献，无论大小。无论是添加新功能、修复错误、改进文档，还是提出新想法，我们都相信每一份贡献都很重要，都能为我们的项目增添价值。

我们在 CONTRIBUTING.md 文件中提供了详细的贡献指南。我们建议您在做出任何贡献之前仔细阅读，以确保您的工作符合项目的目标和标准。

如果您有任何问题或需要帮助，请随时联系我们。我们随时准备为您提供支持，并指导您完成贡献过程。

包含的网络依赖

有关 NiceGUI 依赖的网络框架列表，请参阅 DEPENDENCIES.md。