Streamlit-Folium 项目使用教程

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

Streamlit-Folium 项目的目录结构如下：

streamlit-folium/
├── examples/
├── streamlit_folium/
├── tests/
├── .gitignore
├── .pre-commit-config.yaml
├── LICENSE
├── MANIFEST.in
├── README.md
├── pyproject.toml
├── requirements.txt
└── setup.py

目录介绍：

• examples/: 包含示例代码，展示如何使用 Streamlit-Folium 组件。
• streamlit_folium/: 核心代码目录，包含 Streamlit 和 Folium 集成的实现。
• tests/: 测试代码目录，包含项目的单元测试。
• .gitignore: Git 忽略文件配置。
• .pre-commit-config.yaml: 预提交钩子配置文件。
• LICENSE: 项目许可证文件，采用 MIT 许可证。
• MANIFEST.in: 打包清单文件。
• README.md: 项目说明文档。
• pyproject.toml: 项目配置文件，用于 Poetry 等工具。
• requirements.txt: 项目依赖文件。
• setup.py: 项目安装脚本。

2. 项目的启动文件介绍

项目的启动文件主要是 setup.py 和 examples/ 目录下的示例文件。

setup.py

setup.py 是项目的安装脚本，用于配置和安装项目。它通常包含项目的元数据和依赖项。

示例文件

examples/ 目录下的文件展示了如何使用 Streamlit-Folium 组件。例如：

import streamlit as st
from streamlit_folium import st_folium
import folium

# 创建一个 Folium 地图
m = folium.Map(location=[39.949610, -75.150282], zoom_start=16)

# 使用 st_folium 函数在 Streamlit 中显示地图
output = st_folium(m, width=725)

st.write(output)

3. 项目的配置文件介绍

项目的配置文件主要包括 pyproject.toml 和 requirements.txt。

pyproject.toml

pyproject.toml 是用于配置项目的文件，支持 Poetry 等工具。它包含项目的元数据、依赖项和其他配置。

requirements.txt

requirements.txt 列出了项目运行所需的所有依赖项。可以使用以下命令安装这些依赖项：

pip install -r requirements.txt

以上是 Streamlit-Folium 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该项目。