使用源码安装

安装

如果你想使用 Docker，请转到使用 Docker。

在你的机器上安装好 Python。
INFO
Python 版本：3.12+。

下载源码：

克隆仓库：

sh

git clone https://github.com/TTB-Network/python-openbmclapi-v2.git

TIP

你亦可以使用镜像源加速：

sh

git clone https://ghproxy.bugungu.top/https://github.com/TTB-Network/python-openbmclapi-v2.git

打开仓库所在文件夹：
sh
```
cd python-openbmclapi
```

安装依赖：
TIP
你亦可设置 pip 镜像源来加快你在中国大陆地区的下载速度：
sh
```
pip config set global.index-url https://mirrors.tuna.tsinghua.edu.cn/pypi/web/simple
```
1. 安装 pipx:
  sh
```
pip install --user pipx
```
2. 重新启动终端。
3. 安装 Poetry:
  sh
```
pipx install poetry
pipx ensurepath
```
  INFO
  在 Linux 系统下，pipx 需要安装 python3.10-venv 包来进行依赖的安装：
  sh
```
apt-get install python3.10-venv
```
4. 重新启动终端。
5. 安装依赖：
  sh
```
poetry install
```
TIP
你可能需要先安装 Microsoft C++ 生成工具。

配置 #

运行一次主程序生成配置文件：
INFO
如果你使用 Poetry 安装依赖，你需要先激活虚拟环境。
sh
```
poetry shell
```
sh
```
python main.py
```
如果你看到以下报错信息：core.exceptions.ClusterIdNotSetError，恭喜你！你可以进行下一步的配置了。

在 config/config.yml 中，填写你的 id（即 CLUSTER_ID）和 secret（即 CLUSTER_SECRET）。

yml

cluster:
  byoc: false
  id: '' # OpenBMCLAPI 的 CLUSTER_ID
  public_host: ''
  ...
  secret: '' # OpenBMCLAPI 的 CLUSTER_SECRET

重新启动程序以应用最新配置。