Box Python SDK 生成的

我们很高兴推出最新一代Box Python SDK的稳定版本，旨在提升开发者的体验并简化您与Box内容云的集成。

使用此SDK，您将能够访问

1. 完整API支持：新一代Box SDK为开发者提供了对Box API生态系统的全面覆盖。现在您可以访问Box提供的所有最新特性和功能，让您构建更复杂、功能更丰富的应用程序。
2. 快速API更新：告别等待新Box API被纳入SDK的时代。凭借我们新的自动生成开发方法，我们现在可以以更快的速度（仅需几天）将新的Box API添加到SDK中。这意味着您可以在不延迟的情况下利用您应用程序中最新的功能。
3. 嵌入式文档：我们深知方便地获取信息对于开发者至关重要。采用我们新的方法，我们已将所有对象和参数的全面文档直接集成到SDK的源代码中。这意味着您不再需要在开发者门户中查找这些信息，从而节省时间并简化开发流程。
4. 增强型便利方法：我们致力于提升您的开发体验，新推出了便利方法。这些方法涵盖了各种方面，如分块上传、分类等。
5. 无缝启动：新的SDK集成了认证、带指数退避的自动重试、异常处理、请求取消和类型检查等基本功能，让您能够专注于应用程序的业务逻辑。

拥抱新一代的Box SDK，释放Box内容云的全面潜力。

目录

• 安装
• 入门
• 文档
• 升级
• 集成测试
  • 在本地运行集成测试
    • 创建自定义应用程序
    • 导出配置
    • 运行测试
• 有问题、错误和功能请求吗？
• 版权和许可

安装

pip install box-sdk-gen

这是自动生成的Box SDK版本。支持的Python版本为3.8及以上。

要安装JWT认证所需的额外依赖项，请使用以下命令

pip install "box-sdk-gen[jwt]"

入门

要开始使用SDK，请从Box开发者控制台中您的应用程序配置页面获取开发者令牌。您可以使用此令牌进行针对您自己的Box账户的测试调用。

SDK提供了一个BoxDeveloperTokenAuth类，允许您使用开发者令牌进行认证。使用BoxDeveloperTokenAuth实例初始化BoxClient对象。使用BoxClient对象，您可以访问管理器，允许您在Box账户上执行某些操作。

以下示例演示了如何使用开发者令牌进行认证并打印根文件夹中所有项的名称。

from box_sdk_gen import BoxClient, BoxDeveloperTokenAuth

def main(token: str):
    auth: BoxDeveloperTokenAuth = BoxDeveloperTokenAuth(token=token)
    client: BoxClient = BoxClient(auth=auth)
    for item in client.folders.get_folder_items('0').entries:
        print(item.name)

if __name__ == '__main__':
    main('INSERT YOUR DEVELOPER TOKEN HERE')

文档

浏览文档或查看API参考以获取更多信息。

升级

从我们的旧版SDK升级到新一代SDK是一个简单的过程。请参阅我们的迁移指南和变更日志以获取更多信息。

集成测试

在本地运行集成测试

创建自定义应用程序

要在本地运行集成测试，您需要在Box开发者控制台中创建一个自定义应用程序，并选择服务器认证（使用JWT）作为认证方法。创建后，您可以编辑应用程序的属性

• 在App访问级别部分选择App + 企业访问。您可以启用所有应用程序作用域。
• 在高级功能部分启用使用as-user头进行API调用和生成用户访问令牌。

现在选择授权，提交应用程序以供账户管理员审查。

导出配置

1. 选择配置选项卡，在底部应用设置部分下载您的应用程序配置设置（作为JSON）。
2. 将配置文件编码为Base64，例如使用以下命令：base64 -i path_to_json_file
3. 设置环境变量：JWT_CONFIG_BASE_64，其中包含Base64编码的JWT配置文件
4. 设置环境变量：BOX_FILE_REQUEST_ID，其中包含用户账户中已创建的文件请求的ID，BOX_EXTERNAL_USER_EMAIL，其中包含不属于任何企业的免费外部用户的电子邮件。
5. 设置环境变量：WORKFLOW_FOLDER_ID，其中包含触发工作流的文件的Relay工作流程的ID。该工作流程应具有手动启动，以便可以从API启动它。
6. 设置环境变量：APP_ITEM_ASSOCIATION_FILE_ID为关联应用程序项的文件的ID，以及APP_ITEM_ASSOCIATION_FOLDER_ID为关联应用程序项的文件夹的ID。

运行测试

要在本地运行集成测试

1. pip install -r requirements-test.txt
2. pytest

有问题、错误和功能请求吗？

需要直接联系我们吗？请浏览问题票据！如果这还不行，请提交一个新的问题，我们会尽快回复。如果您对Box API有任何一般性问题，可以在Box开发者论坛发帖。

版权和许可

版权所有 © 2023 Box, Inc. 保留所有权利。

根据Apache许可证2.0版（以下简称“许可证”）；除非符合许可证的要求或在书面同意下，否则不得使用此文件。您可以在以下地址获取许可证副本：

https://apache.ac.cn/licenses/LICENSE-2.0

除非适用法律要求或书面同意，否则在许可证下分发的软件按“现状”基础分发，不提供任何形式的明示或暗示保证。有关许可证的具体语言规定，请参阅许可证。