HarukaBot 项目教程

HarukaBot 项目教程

HarukaBot 将 B 站的动态和直播信息推送至 QQ，基于 NoneBot2 开发 项目地址: https://gitcode.com/gh_mirrors/ha/HarukaBot

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

HarukaBot 项目的目录结构如下：

HarukaBot/
├── docs/
│   └── haruka_bot/
├── env/
│   └── prod/
├── flake8/
├── .gitignore
├── Dockerfile
├── LICENSE
├── README.md
├── bot.py
├── pdm.lock
├── pyproject.toml
└── test/
    └── pytest.py

目录结构介绍

• docs/: 存放项目文档的目录。
  • haruka_bot/: 具体的文档文件夹。
• env/: 环境配置文件夹。
  • prod/: 生产环境配置文件夹。
• flake8/: 代码风格检查配置文件夹。
• .gitignore: Git 忽略文件配置。
• Dockerfile: Docker 构建文件。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• bot.py: 项目的主启动文件。
• pdm.lock: PDM（Python 包管理工具）的锁定文件。
• pyproject.toml: Python 项目配置文件。
• test/: 测试文件夹。
  • pytest.py: 测试脚本。

2. 项目的启动文件介绍

bot.py

bot.py 是 HarukaBot 项目的主启动文件。它包含了启动 HarukaBot 所需的所有初始化代码和配置。通过运行 bot.py，你可以启动 HarukaBot 并开始接收和推送 B 站的动态和直播信息。

# bot.py 文件示例
from nonebot import get_driver
from nonebot.adapters.onebot.v11 import Adapter as ONEBOT_V11Adapter

driver = get_driver()
driver.register_adapter(ONEBOT_V11Adapter)

# 其他初始化代码...

3. 项目的配置文件介绍

pyproject.toml

pyproject.toml 是 Python 项目的配置文件，用于定义项目的依赖、构建系统和工具配置。HarukaBot 使用 PDM 作为包管理工具，因此 pyproject.toml 中包含了 PDM 的相关配置。

# pyproject.toml 文件示例
[project]
name = "HarukaBot"
version = "1.0.0"
description = "将 B 站的动态和直播信息推送至 QQ 的机器人"
authors = [
    { name="SK-415", email="sk415@example.com" }
]
dependencies = [
    "nonebot2>=2.0.0",
    "go-cqhttp>=1.0.0"
]

[tool.pdm]
plugins = [
    "pdm-backend"
]

.env

.env 文件用于存储环境变量配置。HarukaBot 使用 .env 文件来配置数据库连接、API 密钥等敏感信息。

# .env 文件示例
DATABASE_URL=sqlite:///database.db
BILIBILI_API_KEY=your_api_key_here

通过以上配置文件，你可以轻松地配置和启动 HarukaBot，使其能够正常运行并推送 B 站的动态和直播信息。

HarukaBot 将 B 站的动态和直播信息推送至 QQ，基于 NoneBot2 开发 项目地址: https://gitcode.com/gh_mirrors/ha/HarukaBot