SAGIRI-BOT 项目的启动和配置教程

1. 项目目录结构及介绍

SAGIRI-BOT 项目的目录结构如下所示：

sagiri-bot/
│
├── .idea/                    # PyCharm 的项目配置文件目录
├── modules/                  # 存放各功能模块的目录
├── resources/                # 存放静态资源，如图片、配置文件等
├── shared/                   # 公共库和工具类目录
├── main.py                   # 项目的主入口文件
├── pdm.lock                   # PDM（Python 包管理器）的锁文件
├── pyproject.toml            # 项目配置文件
├── README.md                 # 项目说明文件
├── LICENSE                   # 项目许可证文件
└── .gitignore                # Git 忽略文件

详细介绍：

• .idea/: PyCharm 的项目配置文件目录，一般不需要手动修改。
• modules/: 包含所有的功能模块，这些模块实现了机器人的各种功能。
• resources/: 存放项目所需的静态资源，比如配置文件、图片等。
• shared/: 存放项目公共的库和工具类。
• main.py: 项目的主入口文件，用于启动和运行整个机器人。
• pdm.lock: PDM 的锁文件，记录了项目依赖的具体版本。
• pyproject.toml: 项目配置文件，定义了项目的基本信息和依赖关系。
• README.md: 项目说明文件，包含了项目的基本信息和如何使用。
• LICENSE: 项目许可证文件，本项目采用 AGPL-3.0 许可。
• .gitignore: Git 忽略文件，定义了哪些文件和目录应该被 Git 忽略。

2. 项目的启动文件介绍

项目的启动文件是 main.py，它是整个机器人的入口。以下是 main.py 的基本结构：

# 引入必要的模块和库
from sagiri_bot import SagiriBot

# 配置机器人
bot = SagiriBot()

# 启动机器人
if __name__ == "__main__":
    bot.run()

在这个文件中，通常会实例化一个机器人对象，并调用它的 run 方法来启动机器人。

3. 项目的配置文件介绍

项目的配置文件是 pyproject.toml，它采用了 TOML 格式。以下是 pyproject.toml 的一个基本示例：

[tool.pdm]
name = "sagiri-bot"
version = "0.1.0"
description = "一个基于 Mirai 和 Graia-Ariadne 的QQ机器人"

[tool.pdm.dependencies]
python = ">=3.8,<3.10"
mirai = ">=2.0.0"
graia-ariadne = ">=2.0.0"
sqlalchemy = ">=1.4.0"

[tool.pdm.dev-dependencies]
pytest = ">=6.2.0"

在这个配置文件中，定义了项目的名称、版本、描述以及项目依赖的 Python 版本和其他库的版本。这些配置信息会被 PDM 使用来管理和安装项目的依赖。