-
Notifications
You must be signed in to change notification settings - Fork 203
Expand file tree
/
Copy pathindex.html
More file actions
265 lines (229 loc) · 16.9 KB
/
Copy pathindex.html
File metadata and controls
265 lines (229 loc) · 16.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Flow Production Tracking Python API library — python-api v3.10.3 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/graphviz.css" type="text/css" />
<link rel="shortcut icon" href="_static/favicon.ico"/>
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Installation" href="installation.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href='https://help.autodesk.com/view/SGDEV/ENU/'>
<img style='width: 191px;
height: 60px;
margin: 2px;
border-radius: 0px;
padding: 0px;'
src='_static/logo_sg@2x.png'/>
</a>
<a href="#" class="icon icon-home">
python-api
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="authentication.html">Authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference.html">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cookbook.html">API Cookbook</a></li>
<li class="toctree-l1"><a class="reference internal" href="advanced.html">Advanced Topics</a></li>
</ul>
<a href='genindex.html'>Alphabetic Index</a>
<div style='margin-top: 50px;
margin-left: 10px;
margin-right: 10px;
padding: 10px;
color: #b3b3b3;
font-size: 70%;
border-radius: 3px;
background-color: #444;
line-height: 18px;
'>
<style>
a.custom_post_menu { display: inline;
padding: 0px;
text-decoration: underline; }
</style>
<b>python-api</b> v3.10.3.<br>
For more information, please visit
<a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The Flow Production Tracking developer portal.</a>.
The code associated with this documentation can be found
<a class=custom_post_menu href='https://github.com/shotgunsoftware/python-api'>here</a>.
</div>
<style>
p.privacy_links { margin: 4px 0px;}
</style>
<p class="privacy_links"><a data-opt-in-preferences href="javascript:;">Privacy settings</a></p>
<p class="privacy_links"><a data-wat-linkname="manage-ccpa-settings-footer-link" href="javascript:;">Do not sell my personal information</a></p>
<p class="privacy_links"><a href="https://www.autodesk.com/company/legal-notices-trademarks/privacy-statement">Privacy/Cookies</a></p>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">python-api</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="#" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Flow Production Tracking Python API library</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="flow-production-tracking-python-api-library">
<h1>Flow Production Tracking Python API library<a class="headerlink" href="#flow-production-tracking-python-api-library" title="Permalink to this heading"></a></h1>
<p>Release v3.10.3. (<a class="reference internal" href="installation.html#installation"><span class="std std-ref">Installation</span></a>)</p>
<img alt="https://img.shields.io/badge/shotgun-api-blue.svg" src="https://img.shields.io/badge/shotgun-api-blue.svg" /><p>Flow Production Tracking (FPTR) provides a simple Python-based API for accessing FPTR and integrating with other tools.
The Flow Production Tracking API3, also known as “Python API”, allows users to integrate their tools with Flow Production Tracking very easily. Using this simple
but powerful python module, you can quickly get your scripts integrated with Flow Production Tracking’s CRUD-based
API.</p>
<p>Because the needs of every studio can prove to be very different, we don’t include a lot of
“automation” or “smarts” in our API. We have kept it pretty low-level and leave most of those
decisions to you. The API is powerful enough you can write your own “smarts” in a wrapper on top
of the of the FPTR API3.</p>
<section id="overview-video-of-setting-up-your-environment-with-the-python-api">
<span id="pythonoverviewvideo"></span><h2>Overview Video of Setting Up Your Environment with the Python API<a class="headerlink" href="#overview-video-of-setting-up-your-environment-with-the-python-api" title="Permalink to this heading"></a></h2>
<iframe width="560" height="315" src="https://www.youtube.com/embed/RYEBQDJiXAs" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe><p>In addition to basic metadata, the API contains methods for managing media including thumbnails,
filmstrip thumbnails, images, uploaded, and both locally and remotely linked media like
Quicktimes, etc.</p>
<p><strong>Example</strong>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sg</span> <span class="o">=</span> <span class="n">shotgun_api3</span><span class="o">.</span><span class="n">Shotgun</span><span class="p">(</span><span class="s2">"https://my-site.shotgrid.autodesk.com"</span><span class="p">,</span>
<span class="n">login</span><span class="o">=</span><span class="s2">"rhendriks"</span><span class="p">,</span>
<span class="n">password</span><span class="o">=</span><span class="s2">"c0mPre$Hi0n"</span><span class="p">)</span>
<span class="n">sg</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s2">"Shot"</span><span class="p">,</span> <span class="n">filters</span><span class="o">=</span><span class="p">[[</span><span class="s2">"sg_status_list"</span><span class="p">,</span> <span class="s2">"is"</span><span class="p">,</span> <span class="s2">"ip"</span><span class="p">]],</span> <span class="n">fields</span><span class="o">=</span><span class="p">[</span><span class="s2">"code"</span><span class="p">,</span> <span class="s2">"sg_status_list"</span><span class="p">])</span>
</pre></div>
</div>
<p><strong>Output</strong>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[{</span><span class="s1">'code'</span><span class="p">:</span> <span class="s1">'bunny_020_0170'</span><span class="p">,</span>
<span class="s1">'id'</span><span class="p">:</span> <span class="mi">896</span><span class="p">,</span>
<span class="s1">'sg_sequence'</span><span class="p">:</span> <span class="p">{</span><span class="s1">'id'</span><span class="p">:</span> <span class="mi">5</span><span class="p">,</span> <span class="s1">'name'</span><span class="p">:</span> <span class="s1">'bunny_020'</span><span class="p">,</span> <span class="s1">'type'</span><span class="p">:</span> <span class="s1">'Sequence'</span><span class="p">},</span>
<span class="s1">'sg_status_list'</span><span class="p">:</span> <span class="s1">'ip'</span><span class="p">,</span>
<span class="s1">'type'</span><span class="p">:</span> <span class="s1">'Shot'</span><span class="p">},</span>
<span class="p">{</span><span class="s1">'code'</span><span class="p">:</span> <span class="s1">'bunny_020_0200'</span><span class="p">,</span>
<span class="s1">'id'</span><span class="p">:</span> <span class="mi">899</span><span class="p">,</span>
<span class="s1">'sg_sequence'</span><span class="p">:</span> <span class="p">{</span><span class="s1">'id'</span><span class="p">:</span> <span class="mi">5</span><span class="p">,</span> <span class="s1">'name'</span><span class="p">:</span> <span class="s1">'bunny_020'</span><span class="p">,</span> <span class="s1">'type'</span><span class="p">:</span> <span class="s1">'Sequence'</span><span class="p">},</span>
<span class="s1">'sg_status_list'</span><span class="p">:</span> <span class="s1">'ip'</span><span class="p">,</span>
<span class="s1">'type'</span><span class="p">:</span> <span class="s1">'Shot'</span><span class="p">},</span>
<span class="p">{</span><span class="s1">'code'</span><span class="p">:</span> <span class="s1">'bunny_030_0080'</span><span class="p">,</span>
<span class="s1">'id'</span><span class="p">:</span> <span class="mi">907</span><span class="p">,</span>
<span class="s1">'sg_sequence'</span><span class="p">:</span> <span class="p">{</span><span class="s1">'id'</span><span class="p">:</span> <span class="mi">6</span><span class="p">,</span> <span class="s1">'name'</span><span class="p">:</span> <span class="s1">'bunny_030'</span><span class="p">,</span> <span class="s1">'type'</span><span class="p">:</span> <span class="s1">'Sequence'</span><span class="p">},</span>
<span class="s1">'sg_status_list'</span><span class="p">:</span> <span class="s1">'ip'</span><span class="p">,</span>
<span class="s1">'type'</span><span class="p">:</span> <span class="s1">'Shot'</span><span class="p">}]</span>
</pre></div>
</div>
<section id="user-guide">
<h3>User Guide<a class="headerlink" href="#user-guide" title="Permalink to this heading"></a></h3>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation.html#minimum-requirements">Minimum Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#installing-into-pythonpath">Installing into <code class="docutils literal notranslate"><span class="pre">PYTHONPATH</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#installing-with-pip">Installing with <code class="docutils literal notranslate"><span class="pre">pip</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#installing-with-setup-py">Installing with <code class="docutils literal notranslate"><span class="pre">setup.py</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="authentication.html">Authentication</a><ul>
<li class="toctree-l2"><a class="reference internal" href="authentication.html#user-based-authentication">User-based Authentication</a></li>
<li class="toctree-l2"><a class="reference internal" href="authentication.html#script-based-authentication">Script-based Authentication</a></li>
<li class="toctree-l2"><a class="reference internal" href="authentication.html#permissions">Permissions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="reference.html">API Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="reference.html#shotgun-module-attributes"><code class="docutils literal notranslate"><span class="pre">shotgun</span></code> Module Attributes</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#shotgun">Shotgun()</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#shotgun-methods">Shotgun Methods</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#exceptions">Exceptions</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#filter-syntax">Filter Syntax</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#data-types">Data Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#interpreting-image-field-strings">Interpreting Image Field Strings</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#event-types">Event Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#environment-variables">Environment Variables</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#localization">Localization</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cookbook.html">API Cookbook</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cookbook/usage_tips.html">API Usage Tips</a></li>
<li class="toctree-l2"><a class="reference internal" href="cookbook/tutorials.html">Examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="cookbook/attachments.html">Details About Working With Files</a></li>
<li class="toctree-l2"><a class="reference internal" href="cookbook/tasks.html">Working With Tasks</a></li>
<li class="toctree-l2"><a class="reference internal" href="cookbook/smart_cut_fields.html">Smart Cut Fields</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="advanced.html">Advanced Topics</a><ul>
<li class="toctree-l2"><a class="reference internal" href="advanced/packaging.html">Packaging an application with py2app (or py2exe)</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced/iron_python.html">IronPython</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html">Flow Production Tracking Python API Changelog</a></li>
</ul>
</li>
</ul>
</div>
</section>
</section>
<section id="indices-and-tables">
<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this heading"></a></h2>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="installation.html" class="btn btn-neutral float-right" title="Installation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2026, Autodesk.</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
<script type="text/javascript">
window.wafCCPAForceShow = true;
(function(a,b,c,d){
a='https://tags.tiqcdn.com/utag/autodesk/micro-basic/prod/utag.js';
b=document;c='script';d=b.createElement(c);d.src=a;d.type='text/java'+c;d.async=true;
a=b.getElementsByTagName(c)[0];a.parentNode.insertBefore(d,a);
})();
</script>
</body>
</html>