nonebot2/archive/2.0.0a1/guide/creating-a-project.md
2020-09-23 23:01:06 +08:00

1.2 KiB
Raw Blame History

创建一个完整的项目

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

目录结构

首先,我们可以使用 nb-cli 或者自行创建项目目录:

pip install nonebot2[cli]
# pip install 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

如果你使用 nb-cli

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

或者使用

python bot.py

:::tip 提示 如果在 bot 入口文件内定义了 asgi server nb-cli 将会为你启动冷重载模式 :::