Python gRPC SDK

基本安装

Python gRPC SDK 已发布到PyPI，并且可以像任何其他 Python 包一样通过pip. 安装它所需要做的就是运行：

pip install stability-sdk

开发者安装

要访问前沿功能，您可以从源代码构建包。对于大多数用途，建议的安装是上述基本安装。

在开始使用API之前，我们需要搭建本地开发环境。

本文将引导您了解如何设置本地开发环境、下载我们的存储库（其中包括入门所需的所有内容）以及验证您的环境设置。

0.（可选）创建并激活Python虚拟环境...

使用venvPython 安装附带的模块，创建一个名为“venv”的虚拟环境：

python3 -m venv venv

我们python3在这里调用来访问“系统”Python 可执行文件。

激活环境：

source venv/bin/activate

成功激活环境后，您应该在终端提示符中看到环境名称作为前缀，例如

# prompt before activating
/path/to/current/directory >

# prompt after activating
(venv) /path/to/current/directory >

激活环境后，调用python将访问激活环境的 Python 可执行文件，而不是系统 Python。安装 Python 包——无论是从源代码（如下所述）还是通过 pip——只会影响环境 Python 可执行文件。

要停用虚拟环境，只需运行命令即可deactivate。

1.stability-sdk1.从 GitHub克隆存储库...

存储stability-sdk库（从 0.3.0 开始）依赖于 git 子模块。要在克隆时获取这些子模块，请使用--recurse-submodules参数：

git clone --recurse-submodules https://github.com/Stability-AI/stability-sdk

如果您在没有此参数的情况下进行克隆，则可以在导航到存储库后运行以下命令来提取子模块依赖项：

git submodule init
git submodule update

如果要克隆特定分支，可以使用参数--branch：

git clone --branch branchName --recurse-submodules https://github.com/Stability-AI/stability-sdk

或者，您可以switch在克隆后使用该命令拉取并检出到origin远程托管的任何分支（按照这些说明，您的原始远程将设置为https://github.com/stability-ai/stability-sdk.git） 。导航到存储库后：

git fetch
git switch branchName

2. 导航到stability-sdk存储库目录...

cd stability-sdk

3.安装Python SDK...

要使用 pip 从本地代码库安装而不是从 PyPI 中提取包，我们只需将当前位置（即.）作为参数传递：

pip install .

如果您计划对本地代码进行更改，您可能会发现以“可编辑”模式安装很有用，这样一旦您进行代码更改，它就会尊重您的代码更改。否则，每次更改后都需要重新安装。要以可编辑模式安装，我们只需添加-e参数：

pip install -e 。

4. （可选）设置STABILITY_HOST和STABILITY_KEY环境变量...

我们也会在示例脚本中设置这些值，但这会将它们设置在环境中，以便您不需要将这些值作为显式参数传递。

请注意，这export是 Linux / MacOS 语法。如果您使用的是 Windows，则需要使用该set命令。

# Sign up for an account at the following link to get an API Key.
# https://platform.stability.ai/

# Click on the following link once you have created an account to be taken to your API Key.
# https://platform.stability.ai/account/keys

# Paste your API Key below.

export STABILITY_HOST=grpc.stability.ai:443
export STABILITY_KEY=yourkeyhere

5. 调用 API 来测试您的设置...

python -m stability_sdk generate "A stunning house."

成功安装后，您应该会看到连接和生成日志输出到您的终端，并且根据您的请求生成的图像保存到当前目录。