Shotgun Python API 使用指南

1. 项目介绍

Shotgun Python API 是一个开源项目，由 Shotgun Software 公司开发，它为开发者提供了一种通过 Python 代码与 Shotgun 软件进行交互的方式。Shotgun 是一款专为影视、游戏和设计行业打造的项目管理工具，通过这个 API，用户可以自动化执行重复性任务，如批量更新任务状态、上传文件、查询数据等。

2. 项目快速启动

首先，确保您的环境中已经安装了 Python。以下是快速启动 Shotgun Python API 的步骤：

安装

1. 克隆项目到本地：

   git clone https://github.com/shotgunsoftware/python-api.git
   

2. 进入项目目录，安装所需的库：

   cd python-api
   pip install -r requirements.txt
   

配置

1. 创建一个配置文件 config.py，在其中填写您的 Shotgun 服务器地址和认证信息：

   # config.py
   
   ShotgunServer = 'https://your_shotgun_server.com'
   ShotgunScriptName = 'your_script_name'
   ShotgunApiKey = 'your_api_key'
   

2. 在您的 Python 脚本中，导入 API 并初始化：

   # main.py
   
   import Shotgun
   import config
   
   shotgun = Shotgun(config.ShotgunServer, config.ShotgunScriptName, config.ShotgunApiKey)
   

3. 应用案例和最佳实践

以下是一些使用 Shotgun Python API 的常见应用案例：

查询项目数据

查询所有项目：

import json

# 查询所有项目
projects = shotgun.find('Project')
print(json.dumps(projects, indent=4, ensure_ascii=False))

上传文件

上传一个文件到 Shotgun：

# 上传文件
file_path = '/path/to/your/file.ext'
upload_data = shotgun.upload('Project', 123, file_path, 'description')
print(upload_data)

更新任务状态

更新一个任务的状态：

# 更新任务状态
task = shotgun.find_one('Task', [['id', 'is', 456]])
task['status']['name'] = 'cmpt'
shotgun.update('Task', task['id'], task)

4. 典型生态项目

Shotgun Python API 的生态系统中有许多典型的项目，这些项目可以帮助用户更好地集成和使用 Shotgun：

• shotgun-eventyhacker：一个事件监听器，允许用户监听 Shotgun 中的事件并触发自定义脚本。
• shotgun-review：用于在 Shotgun 中创建和管理审查流程的插件。
• shotgun-logger：一个用于记录 Shotgun API 操作日志的插件。

通过使用这些生态项目，开发者可以进一步扩展 Shotgun Python API 的功能，实现更复杂的自动化流程。