nonebot2/archive/2.0.0a12/guide/creating-a-project.md
2021-03-31 21:37:01 +08:00

1.5 KiB
Raw Blame History

创建一个完整的项目

上一章中我们已经运行了一个简单的 NoneBot 实例,在这一章,我们将从零开始一个完整的项目。

目录结构

可以使用 nb-cli 或者自行创建完整的项目目录:

nb create

:::vue AweSome-Bot ├── awesome_bot (或是 src) │ └── plugins ├── .env (可选的) ├── .env.dev (可选的) ├── .env.prod (可选的) ├── .gitignore ├── bot.py ├── docker-compose.yml ├── Dockerfile ├── pyproject.toml └── README.md :::

  • awesome_bot/pluginssrc/plugins: 用于存放编写的 bot 插件
  • .env, .env.dev, .env.prod: 各环境配置文件
  • bot.py: bot 入口文件
  • pyproject.toml: 项目依赖管理文件,默认使用 poetry

启动 Bot

:::warning 提示 如果您使用如 VSCode / PyCharm 等 IDE 启动 nonebot请检查 IDE 当前工作空间目录是否与当前侧边栏打开目录一致。

  • 在二者不一致的环境下可能导致 nonebot 读取配置文件和插件等不符合预期 :::

通过 nb-cli

nb run [--file=bot.py] [--app=app]

python bot.py

:::tip 提示 如果在 bot 入口文件内定义了 asgi server nb-cli 将会为你启动冷重载模式(当文件发生变动时自动重启 NoneBot 实例) :::