BilibiliHistoryFetcher 使用与配置教程

1. 项目目录结构及介绍

BilibiliHistoryFetcher 项目是一个用于获取、处理和分析哔哩哔哩用户观看历史数据的开源项目。以下是项目的目录结构及其介绍：

BilibiliHistoryFetcher/
├── .github/               # GitHub 工作流和模板文件
├── config/                # 配置文件目录
├── docker/                # Docker 相关文件
├── docs/                  # 文档目录
├── scripts/               # 脚本目录
├── app.spec               # 应用打包配置文件
├── app_launcher.py        # 应用启动器脚本
├── build.py               # 构建脚本
├── logo.png               # 项目图标
├── main.py                # 项目主程序
├── pyproject.toml         # 项目依赖和配置
├── requirements.txt       # Python 依赖文件
├── uv.lock                # uv 工具的锁文件
└── ...                    # 其他文件和目录

• .github/: 包含 GitHub 工作流和问题模板等。
• config/: 包含项目的配置文件，如数据库、邮件通知等设置。
• docker/: 包含用于 Docker 容器化的 Dockerfile 文件。
• docs/: 包含项目文档，如本文档。
• scripts/: 包含项目运行过程中使用的脚本。
• app.spec: PyInstaller 打包配置文件。
• app_launcher.py: 启动项目的脚本。
• build.py: 用于构建和打包项目的脚本。
• logo.png: 项目图标文件。
• main.py: 项目的主程序，用于启动服务。
• pyproject.toml: 包含项目元数据和依赖。
• requirements.txt: 项目所需的 Python 包列表。

2. 项目的启动文件介绍

项目的主启动文件为 main.py。这个文件负责初始化和启动整个服务。以下是 main.py 的基本内容：

# 导入必要的模块
# ...

def main():
    # 配置日志
    # ...
    # 初始化服务
    # ...
    # 启动服务
    # ...

if __name__ == "__main__":
    main()

在 main.py 文件中，通常会包含以下几个步骤：

1. 导入必要的 Python 模块和第三方库。
2. 配置日志记录，以便跟踪服务的运行状态。
3. 初始化服务，包括数据库连接、API 接口等。
4. 启动服务，通常是启动一个 Web 服务器。

3. 项目的配置文件介绍

项目的配置文件位于 config/config.yaml。这个文件包含了项目运行所需的各种配置信息，如 API 密钥、数据库连接信息、邮件服务器设置等。以下是 config.yaml 的一个示例结构：

# BilibiliHistoryFetcher 配置文件

# B 站用户认证
SESSDATA: "你的 SESSDATA"

# 邮件通知配置
email:
  smtp_server: "smtp.qq.com"
  smtp_port: 587
  sender: "发件人邮箱"
  password: "邮箱授权码"
  receiver: "收件人邮箱"

# DeepSeek AI API 配置
deepseek:
  api_key: "你的 DeepSeek API 密钥"
  api_base: "https://api.deepseek.com/v1"
  default_model: "deepseek-reasoner"

# 服务器配置
server:
  host: "localhost"
  port: 8899

# ...

在 config.yaml 中，需要根据实际情况填写相应的配置信息。这些信息会在项目运行时被读取，用于配置服务器的行为。

在修改配置文件后，通常需要重启服务以使配置生效。