You need to enable JavaScript to run this app.
导航

安装 Python SDK

最近更新时间2023.08.18 19:13:49

首次发布时间2023.08.18 19:13:49

使用火山引擎 Python SDK 进行各类操作前,您需要安装 Python SDK。本文介绍 Python SDK 的安装方法。

前提条件

  • 已创建并获取火山引擎访问密钥 AccessKey。获取方式请参考密钥管理
  • 访问密钥 AccessKey 拥有所有 API 的全部权限。建议您通过 IAM 用户进行 API 相关操作和日常运维。使用 IAM 用户前,主账号需要为 IAM 用户授予消息队列 Kafka版相关资源和操作的权限。

准备开发环境

请参考 Python 官网下载并安装 Python 开发环境,或使用 conda 创建 Python 虚拟环境。
Python SDK 支持 Python 2.7 及后续版本,您可执行以下命令检查当前 Python 的版本信息。

python -V

安装 SDK

您可以使用 pip 安装火山引擎 Python SDK。

  1. 执行以下命令,安装 Python SDK。
pip install volcengine-python-sdk
  1. 回显信息如下,表示安装成功。
Successfully installed volcengine-python-sdk

初始化客户端

初始化客户端的示例代码如下:

from __future__ import print_function
import volcenginesdkcore
import volcenginesdkkafka

if __name__ == '__main__':
    configuration = volcenginesdkcore.Configuration()
    configuration.ak = "Your AK"
    configuration.sk = "Your SK"
    configuration.region = "cn-beijing"
    # set default configuration
    volcenginesdkcore.Configuration.set_default(configuration)

    # use global default configuration
    api_instance = volcenginesdkkafka.KAFKAApi()