Flow Production Tracking Python API

Autodesk提供了一种简单的基于Python的API，用于访问Flow Production Tracking并与其他工具集成。这是Autodesk维护的官方API (https://knowledge.autodesk.com/contact-support)

最新版本始终可在 http://github.com/shotgunsoftware/python-api 找到

最低要求

• Python v3.7

文档

有关Python API的教程和详细文档可在 http://developer.shotgridsoftware.com/python-api 找到。

一些有用的直接链接

• 安装
• 教程
• API参考
• 数据类型
• 过滤器语法

变更日志

您可以在文档网站上查看Python API的 完整历史记录。

更新HTTPLib2

API在 shotgun_api3/lib 文件夹中附带了一份 httplib2 的副本。要将副本更新到API的较新版本，您可以在此存储库的根目录中运行 update_httplib2.py 脚本，如下所示

python update_httplib2.py vX.Y.Z

其中 vX.Y.Z 是在 httplib2 的 发布页面 上找到的版本。

测试

提供了集成和单元测试。

• 所有测试都需要
  • nose单元测试工具，
  • nose-exclude nose插件
  • （注意：运行 pip install -r tests/ci_requirements.txt 将安装此包）
• 一个 tests/config 文件（您可以从 tests/example_config 复制一个示例）。
• 测试可以单独运行，例如：nosetests --config="nose.cfg" tests/test_client.py
  • 请确保不要忘记 --config="nose.cfg" 选项。此选项告诉nose使用我们的配置文件。这将排除 /lib 目录中特定于python 2和3的文件，防止nose因这些文件中的不兼容语法而报告编译失败。
• test_client 和 tests_unit 使用模拟服务器交互，不需要存在 Flow Production Tracking 实例（无需修改 tests/config 文件）。
• test_api 和 test_api_long 需要 Flow Production Tracking 实例，并为测试提供脚本密钥。服务器和脚本用户值必须提供在 tests/config 文件中。测试将根据您的配置信息向您的服务器添加测试数据。这些数据将被测试操作修改，不应用于其他目的。
• 要运行所有测试，请使用 shell 脚本 run-tests。

发布流程

打包新版本

1. 更新 HISTORY.rst 文件中的 Changelog
   • 为自上次发布以来发生的任何更改添加项目符号。这可能包括您未进行的更改，因此请查看提交历史记录，以确保我们不会遗漏任何内容。如果您注意到某些操作没有添加到更改日志中，请找到那位工程师并让他们因为未这样做而感到愧疚。这是修改 API 的必要步骤。
   • 尽量与以前更改日志消息的语言保持一致。我们希望保持一致的语气。
   • 确保发布日期与今天相符。我们尽量保持此 TBD，直到我们准备发布，这样就可以轻松发现需要更新。
   • 确保版本号填写完整并正确。我们遵循语义版本控制。
2. 确保对公共方法的所有更改或添加都有文档记录
   • 确保代码中的 doc strings 已更新以与 Sphinx 一起使用，并且格式正确。
   • 示例总是很好的，尤其是如果这是一个新功能或方法。
   • 考虑一个新用户尝试了解如何使用您正在记录的 API 功能。
3. 将 python-api/setup.py 中的 __version__ 值更新为您要打包的版本。这控制了通过 pip 安装时用户将获得的版本。
4. 将 shotgun_api3/shotgun.py 中的 __version__ 值更新为您要发布的版本。这标识了 API 中的当前版本。
5. 使用类似于 packaging for the vx.x.x release 的提交信息将这些更改提交到 master。
6. 根据 master 分支创建一个名为 vx.x.x 的标签以匹配您要发布的版本号。
7. 将 master 和您的标签推送到 Github。
8. 更新 Releases 页面以包含您的新版本。
   • 发布应已从您的标签中自动生成，但如果没有，请创建一个新的。
   • 添加有关此次发布更改的更详细信息。这是一个添加示例和更改原因的好地方！

让全世界知道

在 Pipeline Community channel 上发布消息。

为下一个开发周期做准备

1. 将 shotgun_api3/shotgun.py 中的 __version__ 值更新为带有 .dev 后缀的下一个版本号。例如，v3.0.24.dev
2. 在 HISTORY.rst 文件中添加一个新部分，包含下一个版本号和 TBD 日期

    **v3.0.24 - TBD**
       + TBD

3. 使用类似于 Bump version to v3.0.24.dev 的提交信息将更改提交到 master
4. 将 master 推送到 Github