nonebot2/docs/guide/installation.md

92 lines
2.5 KiB
Markdown
Raw Normal View History

2020-09-12 05:45:03 +00:00
# 安装
## NoneBot
:::warning 注意
请确保你的 Python 版本 >= 3.7。
:::
2020-12-01 04:24:14 +00:00
:::warning 注意
2020-10-16 09:15:40 +00:00
请在安装 nonebot2 之前卸载 nonebot 1.x
2020-09-12 05:45:03 +00:00
```bash
2020-10-16 09:15:40 +00:00
pip uninstall nonebot
2020-12-01 04:24:14 +00:00
```
:::
### 通过脚手架安装(推荐安装方式)
2020-12-07 13:02:08 +00:00
1. (推荐)使用你喜欢的 Python 环境管理工具(如 `poetry`)创建新的虚拟环境。
2. 使用 `pip` (或其他包管理工具) 安装 nb-clinonebot2 作为其依赖会一起被安装。
2020-12-01 04:24:14 +00:00
```bash
pip install nb-cli
```
2020-12-01 09:08:15 +00:00
3. 点个 star 吧
nonebot2: [![nb-cli](https://img.shields.io/github/stars/nonebot/nonebot2?style=social)](https://github.com/nonebot/nonebot2)
nb-cli: [![nb-cli](https://img.shields.io/github/stars/nonebot/nb-cli?style=social)](https://github.com/nonebot/nb-cli)
2020-12-01 04:24:14 +00:00
### 不使用脚手架(纯净安装)
```bash
2020-09-12 05:45:03 +00:00
pip install nonebot2
2020-12-07 13:02:08 +00:00
# 也可以通过 poetry 安装
poetry add nonebot2
2020-09-12 05:45:03 +00:00
```
2020-12-01 04:24:14 +00:00
如果你需要使用最新的(可能**尚未发布**的)特性,可以直接从 GitHub 仓库安装:
2020-11-10 06:44:24 +00:00
:::warning 注意
2020-12-07 13:02:08 +00:00
直接从 Github 仓库中安装意味着你将使用最新提交的代码,它们并没有进行充分的稳定性测试
在任何情况下请不要将其应用于生产环境!
:::
2020-11-10 06:44:24 +00:00
```bash
# master分支
2020-11-10 06:44:24 +00:00
poetry add git+https://github.com/nonebot/nonebot2.git#master
# dev分支
2020-11-10 06:44:24 +00:00
poetry add git+https://github.com/nonebot/nonebot2.git#dev
```
或者在克隆 Git 仓库后手动安装:
2020-09-12 05:45:03 +00:00
```bash
git clone https://github.com/nonebot/nonebot2.git
cd nonebot2
2020-09-17 05:12:48 +00:00
poetry install --no-dev # 推荐
pip install . # 不推荐
2020-09-12 05:45:03 +00:00
```
## 安装插件
插件可以通过 `nb-cli` 进行安装,也可以自行安装并加载插件。
```bash
# 列出所有的插件
nb plugin list
# 搜索插件
nb plugin search xxx
# 安装插件
nb plugin install xxx
```
如果急于上线 Bot 或想要使用现成的插件,以下插件可作为参考:
### 官方插件
~~自用插件~~ ~~确信~~
2020-12-01 11:10:05 +00:00
- [NoneBot-Plugin-Docs](https://github.com/nonebot/nonebot2/tree/master/packages/nonebot-plugin-docs) 离线文档插件
- [NoneBot-Plugin-Test](https://github.com/nonebot/plugin-test) 本地机器人测试前端插件
- [NoneBot-Plugin-APScheduler](https://github.com/nonebot/plugin-apscheduler) 定时任务插件
- [NoneBot-Plugin-Sentry](https://github.com/cscs181/QQ-GitHub-Bot/tree/master/src/plugins/nonebot_plugin_sentry) Sentry 在线日志分析插件
- [NoneBot-Plugin-Status](https://github.com/cscs181/QQ-GitHub-Bot/tree/master/src/plugins/nonebot_plugin_status) 服务器状态查看插件
### 其他插件
还有更多的插件在 [这里](/plugin-store.md) 等着你发现~