Shiny for Python 项目教程

Shiny for Python 项目教程

py-shiny Shiny for Python 项目地址: https://gitcode.com/gh_mirrors/py/py-shiny

1. 项目的目录结构及介绍

Shiny for Python 项目的目录结构如下：

py-shiny/
├── docs/
├── examples/
├── js/
├── scripts/
├── shiny/
├── tests/
├── .gitignore
├── .pre-commit-config.yaml
├── .prettierrc
├── CHANGELOG.md
├── CITATION.cff
├── LICENSE
├── MANIFEST.in
├── Makefile
├── README.md
├── pyproject.toml
├── pyrightconfig.json
└── pytest.ini

目录介绍：

• docs/: 存放项目的文档文件。
• examples/: 包含一些示例代码，帮助用户快速上手。
• js/: 存放与 JavaScript 相关的文件。
• scripts/: 包含一些脚本文件，用于项目的自动化任务。
• shiny/: 核心代码库，包含 Shiny for Python 的主要功能实现。
• tests/: 存放项目的测试代码。
• .gitignore: Git 忽略文件配置。
• .pre-commit-config.yaml: 预提交钩子配置文件。
• .prettierrc: Prettier 代码格式化配置文件。
• CHANGELOG.md: 项目变更日志。
• CITATION.cff: 项目引用信息。
• LICENSE: 项目许可证文件。
• MANIFEST.in: Python 包清单文件。
• Makefile: 项目构建文件。
• README.md: 项目介绍和使用说明。
• pyproject.toml: Python 项目配置文件。
• pyrightconfig.json: Pyright 静态类型检查配置文件。
• pytest.ini: Pytest 配置文件。

2. 项目的启动文件介绍

Shiny for Python 的启动文件通常是 app.py，用户可以通过以下命令启动应用：

shiny run app.py --reload --launch-browser

启动文件示例：

from shiny import App, render, ui

app_ui = ui.page_fluid(
    ui.input_slider("n", "N", 0, 100, 20),
    ui.output_text_verbatim("txt"),
)

def server(input, output, session):
    @output
    @render.text
    def txt():
        return f"n*2 is {input.n() * 2}"

app = App(app_ui, server)

启动文件说明：

• app_ui: 定义应用的用户界面。
• server: 定义应用的服务器逻辑。
• App: 创建并启动 Shiny 应用。

3. 项目的配置文件介绍

pyproject.toml

pyproject.toml 是 Python 项目的配置文件，包含了项目的依赖、构建工具等信息。

[build-system]
requires = ["setuptools>=42", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "shiny"
version = "1.0.0"
description = "Shiny for Python"
authors = [
    { name="Posit", email="info@posit.co" },
]
dependencies = [
    "htmltools",
    "pandas",
    "numpy",
]

配置文件说明：

• build-system: 定义构建系统的要求和后端。
• project: 定义项目的基本信息，如名称、版本、描述、作者和依赖。

通过以上内容，您可以快速了解 Shiny for Python 项目的目录结构、启动文件和配置文件，从而更好地进行项目的开发和使用。

py-shiny Shiny for Python 项目地址: https://gitcode.com/gh_mirrors/py/py-shiny