开源项目 `dash-extensions` 使用教程

开源项目 dash-extensions 使用教程

dash-extensions项目地址:https://gitcode.com/gh_mirrors/da/dash-extensions

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

dash-extensions 项目的目录结构如下：

dash-extensions/
├── dash_extensions/
│   ├── __init__.py
│   ├── enrich.py
│   ├── javascript.py
│   ├── pages.py
│   ├── snippets.py
│   ├── validation.py
│   ├── streaming.py
│   └── components/
│       ├── __init__.py
│       ├── websocket.py
│       └── ...
├── tests/
│   ├── __init__.py
│   ├── test_enrich.py
│   ├── test_javascript.py
│   ├── test_pages.py
│   ├── test_snippets.py
│   ├── test_validation.py
│   ├── test_streaming.py
│   └── ...
├── .gitignore
├── LICENSE
├── README.md
├── setup.py
└── requirements.txt

目录结构介绍

• dash_extensions/: 包含项目的主要代码文件。
  • __init__.py: 初始化文件。
  • enrich.py: 包含各种增强版的 Dash 组件。
  • javascript.py: 包含与 JavaScript 交互的功能。
  • pages.py: 扩展 Dash Pages 的功能。
  • snippets.py: 包含代码片段。
  • validation.py: 包含验证功能。
  • streaming.py: 包含流处理功能。
  • components/: 包含自定义组件。
    • websocket.py: 包含 WebSocket 组件。
• tests/: 包含项目的测试文件。
• .gitignore: Git 忽略文件。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• setup.py: 项目安装文件。
• requirements.txt: 项目依赖文件。

2. 项目的启动文件介绍

项目的启动文件通常是 app.py 或 main.py，但在 dash-extensions 项目中，启动文件可能是一个示例文件，例如 examples/example_app.py。

示例启动文件

from dash import Dash
from dash_extensions import enrich

app = Dash(__name__)

app.layout = enrich.Div([
    enrich.H1("Hello, Dash Extensions!"),
    enrich.Button("Click me", id="button"),
    enrich.Div(id="output")
])

@app.callback(
    enrich.Output("output", "children"),
    [enrich.Input("button", "n_clicks")]
)
def update_output(n_clicks):
    return f"Button clicked {n_clicks} times"

if __name__ == "__main__":
    app.run_server(debug=True)

启动文件介绍

• from dash import Dash: 导入 Dash 核心库。
• from dash_extensions import enrich: 导入 dash-extensions 的增强模块。
• app = Dash(__name__): 创建 Dash 应用实例。
• app.layout: 定义应用的布局。
• @app.callback: 定义回调函数，处理用户交互。
• if __name__ == "__main__": app.run_server(debug=True): 启动应用服务器。

3. 项目的配置文件介绍

dash-extensions 项目的配置文件主要包括 setup.py 和 requirements.txt。

setup.py

from setuptools import setup, find_packages

setup(
    name='dash-extensions',
    version='1.0.18',
    description='Extensions for Plotly Dash',
    author='emher',
    license='MIT',
    packages=find_packages(),
    install_requires=[
        'dash>=2.0.0',
        'python-dotenv',
    ],
    classifiers=[
        'License :: OSI Approved :: MIT License',
        'Programming Language :: Python :: 3',
        'Programming Language :: Python :: 3.9',
        'Programming Language :: Python :: 3.10',
        'Programming Language :: Python :: 3.11',
    ],
)

requirements.txt

dash-extensions项目地址:https://gitcode.com/gh_mirrors/da/dash-extensions