nonebot2/website/docs/start/installation.mdx

81 lines
1.8 KiB
Plaintext
Raw Normal View History

2021-12-27 22:08:59 +08:00
---
sidebar_position: 0
2022-02-05 19:46:33 +08:00
description: 通过脚手架、PyPI 或 GitHub 安装 NoneBot2
2021-12-27 22:08:59 +08:00
options:
menu:
weight: 10
category: guide
---
import Asciinema from "@site/src/components/Asciinema";
2022-02-05 19:46:33 +08:00
# 安装 NoneBot2
2021-12-27 22:08:59 +08:00
:::warning 注意
请确保你的 Python 版本 >= 3.8。
2021-12-27 22:08:59 +08:00
:::
:::warning 注意
请在安装 NoneBot v2 之前卸载 NoneBot v1
```bash
pip uninstall nonebot
```
:::
2022-02-05 19:46:33 +08:00
## 通过脚手架安装(推荐)
2021-12-27 22:08:59 +08:00
2022-02-05 19:46:33 +08:00
1. (可选)使用你喜欢的 Python 环境管理工具(如 Poetry、venv、Conda 等)创建新的虚拟环境
2. 使用 pip 或其他包管理工具安装 nb-cliNoneBot2 会作为其依赖被一起安装
2021-12-27 22:08:59 +08:00
```bash
pip install nb-cli
```
<Asciinema
url="https://asciinema.org/a/464654.cast"
options={{ theme: "monokai", poster: "npt:2.8" }}
/>
2021-12-27 22:08:59 +08:00
:::important 提示
2022-02-05 19:46:33 +08:00
nb-cli 的使用方法详见[使用脚手架](./nb-cli.md)
2021-12-27 22:08:59 +08:00
:::
2022-02-05 19:46:33 +08:00
## 不使用脚手架(纯净安装)
2021-12-27 22:08:59 +08:00
2022-02-05 19:46:33 +08:00
如果你不想使用脚手架,可以直接安装 NoneBot2并自行完成开发配置。
2021-12-27 22:08:59 +08:00
```bash
pip install nonebot2[fastapi]
2022-02-05 19:46:33 +08:00
# 也可以通过 Poetry 安装
poetry add nonebot2[fastapi]
2021-12-27 22:08:59 +08:00
```
## 从 GitHub 安装
如果你需要使用最新的(可能**尚未发布**的)特性,可以直接从 GitHub 仓库安装:
2021-12-27 22:08:59 +08:00
:::warning 注意
2022-02-05 19:46:33 +08:00
直接从 GitHub 仓库中安装意味着你将使用最新提交的代码,它们并没有进行充分的稳定性测试
2021-12-27 22:08:59 +08:00
在任何情况下请不要将其应用于生产环境!
:::
2022-02-05 19:46:33 +08:00
```bash title="Install From GitHub"
2021-12-27 22:08:59 +08:00
# master分支
poetry add git+https://github.com/nonebot/nonebot2.git#master
# dev分支
poetry add git+https://github.com/nonebot/nonebot2.git#dev
```
或者在克隆 Git 仓库后手动安装:
2021-12-27 22:08:59 +08:00
```bash
git clone https://github.com/nonebot/nonebot2.git
cd nonebot2
poetry install --no-dev # 推荐
pip install . # 不推荐
```