diff --git a/README.md b/README.md index e9cfb5b..f4d59b3 100644 --- a/README.md +++ b/README.md @@ -8,12 +8,32 @@ ## 安装 +本项目**不发布到 PyPI**——通过克隆仓库安装(推荐先用 [pipx](https://pipx.pypa.io/) 隔离环境;或用 venv + pip): + ```bash -pip install hy3d # 纯 API 客户端 -pip install "hy3d[browser]" # 额外安装浏览器工具(登录/抓包/浏览器自动化) +# 1. 克隆仓库 +git clone https://gitea.akasei.top/KawasakiAkasei/hy3d.git +cd hy3d + +# 2. 安装(pipx 装进独立 venv,hy3d 命令进 PATH) +pipx install ".[browser]" + +# 3. 验证 +hy3d auth status ``` -不安装也能用——克隆仓库后直接用源码跑(无需 `pip install`): +不想保留仓库副本也能直接装: + +```bash +pipx install "git+https://gitea.akasei.top/KawasakiAkasei/hy3d.git" +``` + +> **「browser」扩展**提供登录/抓包/浏览器自动化(cloakbrowser + playwright); +> 只调用 API 可以省略。已装过纯客户端、想补 browser 扩展: +> `cd hy3d && pipx install --force ".[browser]"`。 +> **私有仓库**场景:clone 用 SSH —— `git clone git@gitea.akasei.top:KawasakiAkasei/hy3d.git`;git 直装同理。 + +不安装也能用——直接以源码方式运行(无需 pip install): ```bash cd hy3d @@ -137,7 +157,7 @@ CLI 等价写法:`hy3d --cookies /path/to/cookies.txt quota`,或环境变量 | `hy3d-sniffer` | API 请求/响应抓包(`api_requests.log.json`) | | `hy3d-generate [wait]` | 浏览器内图生 3D(走浏览器签名,适合对照验证) | -需要 `pip install "hy3d[browser]"`(cloakbrowser + playwright)。 +需要 browser 扩展(安装时加 `[browser]`,见上文安装节)。 ## 配置文件与目录 diff --git a/README_CN.md b/README_CN.md index 216a393..66016ca 100644 --- a/README_CN.md +++ b/README_CN.md @@ -8,12 +8,32 @@ ## 安装 +本项目**不发布到 PyPI**——通过克隆仓库安装(推荐先用 [pipx](https://pipx.pypa.io/) 隔离环境;或用 venv + pip): + ```bash -pip install hy3d # 纯 API 客户端 -pip install "hy3d[browser]" # 额外安装浏览器工具(登录/抓包/浏览器自动化) +# 1. 克隆仓库 +git clone https://gitea.akasei.top/KawasakiAkasei/hy3d.git +cd hy3d + +# 2. 安装(pipx 装进独立 venv,hy3d 命令进 PATH) +pipx install ".[browser]" + +# 3. 验证 +hy3d auth status ``` -不安装也能用——克隆仓库后直接用源码跑(无需 `pip install`): +不想保留仓库副本也能直接装: + +```bash +pipx install "git+https://gitea.akasei.top/KawasakiAkasei/hy3d.git" +``` + +> **「browser」扩展**提供登录/抓包/浏览器自动化(cloakbrowser + playwright); +> 只调用 API 可以省略。已装过纯客户端、想补 browser 扩展: +> `cd hy3d && pipx install --force ".[browser]"`。 +> **私有仓库**场景:clone 用 SSH —— `git clone git@gitea.akasei.top:KawasakiAkasei/hy3d.git`;git 直装同理。 + +不安装也能用——直接以源码方式运行(无需 pip install): ```bash cd hy3d @@ -137,7 +157,7 @@ CLI 等价写法:`hy3d --cookies /path/to/cookies.txt quota`,或环境变量 | `hy3d-sniffer` | API 请求/响应抓包(`api_requests.log.json`) | | `hy3d-generate [wait]` | 浏览器内图生 3D(走浏览器签名,适合对照验证) | -需要 `pip install "hy3d[browser]"`(cloakbrowser + playwright)。 +需要 browser 扩展(安装时加 `[browser]`,见上文安装节)。 ## 配置与目录