python-api/examples/basic_sg_instance.html at gh-pages · RandomInsano/python-api · GitHub

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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292


<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">

  <meta name="viewport" content="width=device-width, initial-scale=1.0">

  <title>Create a Shotgun API instance &mdash; python-api v3.0.32.dev_sphinx documentation</title>


    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />


    <link rel="top" title="python-api v3.0.32.dev_sphinx documentation" href="../index.html"/>
        <link rel="up" title="Examples" href="../tutorials.html"/>
        <link rel="next" title="Create A Shot" href="basic_create_shot.html"/>
        <link rel="prev" title="Examples" href="../tutorials.html"/>


  <script src="../_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

  <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='http://developer.shotgunsoftware.com'>

        <img style='width: 191px;
                height: 60px;
                margin: 2px;
                border-radius: 0px;
                padding: 0px;'
            src='../_static/logo_sg@2x.png'/>

    </a>


            <a href="../index.html" 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" />
    <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="main navigation">


                <ul class="current">
<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="../filter_syntax.html">Filter Syntax</a></li>
<li class="toctree-l1"><a class="reference internal" href="../data_types.html">Data Types</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../tutorials.html">Examples</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">Create a Shotgun API instance</a></li>
<li class="toctree-l2"><a class="reference internal" href="basic_create_shot.html">Create A Shot</a></li>
<li class="toctree-l2"><a class="reference internal" href="basic_find_shot.html">Find a Shot</a></li>
<li class="toctree-l2"><a class="reference internal" href="basic_update_shot.html">Update A Shot</a></li>
<li class="toctree-l2"><a class="reference internal" href="basic_delete_shot.html">Delete A Shot</a></li>
<li class="toctree-l2"><a class="reference internal" href="basic_create_shot_task_template.html">Create a Shot with a Task Template</a></li>
<li class="toctree-l2"><a class="reference internal" href="basic_create_version_link_shot.html">Create a Version Linked to a Shot</a></li>
<li class="toctree-l2"><a class="reference internal" href="basic_upload_thumbnail_version.html">Upload a Thumbnail for a Version</a></li>
<li class="toctree-l2"><a class="reference internal" href="../tutorials.html#advanced">Advanced</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../usage_tips.html">API Usage Tips</a></li>
<li class="toctree-l1"><a class="reference internal" href="../attachments.html">Working With Files</a></li>
<li class="toctree-l1"><a class="reference internal" href="../local_files.html">Working With Local Files</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tasks.html">Working With Tasks</a></li>
<li class="toctree-l1"><a class="reference internal" href="../smart_cut_fields.html">Smart Cut Fields</a></li>
<li class="toctree-l1"><a class="reference internal" href="../event_types.html">Event Types</a></li>
<li class="toctree-l1"><a class="reference internal" href="../packaging.html">Packaging an application with py2app (or py2exe)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../server_changelog.html">Shotgun Server API Changelog</a></li>
</ul>


    <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.0.32.dev_sphinx.<br>

    For more information, please visit
    <a class=custom_post_menu href='https://support.shotgunsoftware.com/home'>Shotgun Support</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>

        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">


      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
        <a href="../index.html">python-api</a>
      </nav>


      <div class="wy-nav-content">
        <div class="rst-content">


<div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
    <li><a href="../index.html">Docs</a> &raquo;</li>

          <li><a href="../tutorials.html">Examples</a> &raquo;</li>

    <li>Create a Shotgun API instance</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">

  <div class="section" id="create-a-shotgun-api-instance">
<span id="example-sg-instance"></span><h1>Create a Shotgun API instance<a class="headerlink" href="#create-a-shotgun-api-instance" title="Permalink to this headline">¶</a></h1>
<p>This example shows you how to establish your initial connection to Shotgun using script-based
authentication. <code class="docutils literal"><span class="pre">sg</span></code> represents your Shotgun API instance. Be sure you&#8217;ve read
<a class="reference internal" href="../authentication.html#setting-up-shotgun"><span class="std std-ref">Setting Up Shotgun for API Access</span></a>.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">pprint</span> <span class="c1"># Useful for debugging</span>

<span class="kn">import</span> <span class="nn">shotgun_api3</span>

<span class="n">SERVER_PATH</span> <span class="o">=</span> <span class="s2">&quot;https://your_site.shotgunstudio.com&quot;</span>
<span class="n">SCRIPT_NAME</span> <span class="o">=</span> <span class="s1">&#39;my_script&#39;</span>
<span class="n">SCRIPT_KEY</span> <span class="o">=</span> <span class="s1">&#39;27b65d7063f46b82e670fe807bd2b6f3fd1676c1&#39;</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="n">SERVER_PATH</span><span class="p">,</span> <span class="n">SCRIPT_NAME</span><span class="p">,</span> <span class="n">SCRIPT_KEY</span><span class="p">)</span>

<span class="c1"># Just for demo purposes, this will print out property and method names available on the</span>
<span class="c1"># sg connection object</span>
<span class="n">pprint</span><span class="o">.</span><span class="n">pprint</span><span class="p">([</span><span class="n">symbol</span> <span class="k">for</span> <span class="n">symbol</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="nb">dir</span><span class="p">(</span><span class="n">sg</span><span class="p">))</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">symbol</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;_&#39;</span><span class="p">)])</span>
</pre></div>
</div>
<p>For further information on what you can do with this Shotgun object you can read the
<a class="reference internal" href="../reference.html#apireference"><span class="std std-ref">API reference</span></a>.</p>
</div>


           </div>
          </div>
          <footer>

    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

        <a href="basic_create_shot.html" class="btn btn-neutral float-right" title="Create A Shot" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>


        <a href="../tutorials.html" class="btn btn-neutral" title="Examples" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>

    </div>


  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2016, Autodesk.

    </p>
  </div>

</footer>

        </div>
      </div>

    </section>

  </div>


    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'../',
            VERSION:'v3.0.32.dev_sphinx',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true
        };
    </script>
      <script type="text/javascript" src="../_static/jquery.js"></script>
      <script type="text/javascript" src="../_static/underscore.js"></script>
      <script type="text/javascript" src="../_static/doctools.js"></script>


    <script type="text/javascript" src="../_static/js/theme.js"></script>


  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>


<script>
  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
  })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
  ga('create', 'UA-2114792-1', 'auto');
  ga('send', 'pageview');
</script>


</body>
</html>