Streamlit Plotly Events 项目使用教程

Streamlit Plotly Events 项目使用教程

streamlit-plotly-events Streamlit component that allows Plotly events to bubble back up to streamlit. Makes Plotly charts interactive! 项目地址: https://gitcode.com/gh_mirrors/st/streamlit-plotly-events

1. 项目目录结构及介绍

该项目包含了以下目录和文件：

streamlit-plotly-events/
├── .gitignore
├── LICENSE
├── MANIFEST.in
├── README.md
├── example.gif
├── setup.py
├── src/
│   ├── __init__.py
│   ├── streamlit_plotly_events/
│   │   ├── __init__.py
│   │   ├── frontend/
│   │   │   ├── package.json
│   │   │   ├── ...
│   │   ├── ...
│   ├── ...

• .gitignore：Git 忽略文件列表，用于指定在 Git 版本控制中应该忽略的文件和目录。
• LICENSE：项目的开源许可证文件，本项目采用 MIT 许可证。
• MANIFEST.in：用于指定打包时需要包含的文件和目录。
• README.md：项目的自述文件，包含了项目的介绍、安装和使用说明。
• example.gif：示例动图，用于展示组件的使用效果。
• setup.py：Python 打包配置文件，用于定义项目的包信息和依赖。
• src/：源代码目录，包含了项目的核心代码和前端资源。

2. 项目的启动文件介绍

该项目的启动主要通过 src/streamlit_plotly_events/__init__.py 文件进行。

在 __init__.py 文件中，通常包含以下内容：

from .streamlit_plotly_events import plotly_events

该文件的作用是将 streamlit_plotly_events 模块中的 plotly_events 函数导入到当前命名空间下，使得用户可以方便地使用该函数。

3. 项目的配置文件介绍

该项目的配置主要通过 setup.py 文件进行。

在 setup.py 文件中，定义了项目的元数据以及依赖信息，以下是一个示例：

from setuptools import setup, find_packages

setup(
    name='streamlit-plotly-events',
    version='0.1.0',
    packages=find_packages(),
    install_requires=[
        'streamlit',
        'plotly'
    ],
    description='Streamlit component that allows Plotly events to bubble back up to streamlit.',
    long_description_content_type='text/markdown',
    long_description=open('README.md').read(),
    author='null-jones',
    author_email='your_email@example.com',
    url='https://github.com/null-jones/streamlit-plotly-events',
    license='MIT',
    keywords='streamlit plotly events',
    python_requires='>=3.6',
    classifiers=[
        'Programming Language :: Python :: 3',
        'License :: OSI Approved :: MIT License',
        'Operating System :: OS Independent',
    ],
)

该配置文件定义了项目的名称、版本、包含的包、依赖项、描述、作者、许可证等信息，是项目打包和分发的重要配置文件。

streamlit-plotly-events Streamlit component that allows Plotly events to bubble back up to streamlit. Makes Plotly charts interactive! 项目地址: https://gitcode.com/gh_mirrors/st/streamlit-plotly-events