doc/sdk/python/sdk-python.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: sdk
   4 navmenu: Python
   5 title: "Python SDK"
   6
   7 ...
   8
   9 The Python SDK provides a generic set of wrappers so you can make API calls easily. It performs some validation before connecting to the API server: for example, it refuses to do an API call if a required parameter is missing.
  10
  11 The library also includes some conveniences for use in Crunch scripts; see "Crunch utility libraries":crunch-utility-libraries.html for details.
  12
  13 h3. Installation
  14
  15 If you are logged in to an Arvados VM, the Python SDK should be installed.
  16
  17 To use the Python SDK elsewhere, you can either install the Python SDK via PyPI or build and install the package using the arvados source tree.
  18
  19 {% include 'notebox_begin' %}
  20 The Python SDK requires Python 2.7
  21 {% include 'notebox_end' %}
  22
  23 h4. Option 1: install with PyPI
  24
  25 <notextile>
  26 <pre>
  27 $ <code class="userinput">sudo apt-get install python-pip python-dev libattr1-dev libfuse-dev pkg-config python-yaml</code>
  28 $ <code class="userinput">sudo pip install arvados-python-client</code>
  29 </pre>
  30 </notextile>
  31
  32 _If your version of @pip@ is 1.4 or newer, the @pip install@ command might give an error: "Could not find a version that satisfies the requirement arvados-python-client". If this happens, fix it by adding a @--pre@ flag:_
  33
  34 <notextile>
  35 <pre>
  36 $ <code class="userinput">sudo pip install --pre arvados-python-client</code>
  37 </pre>
  38 </notextile>
  39
  40 h4. Option 2: install from distribution packages (Debian/Ubuntu only)
  41
  42 First add @http://apt.arvados.org@ to your list of apt repositories:
  43
  44 <notextile>
  45 <pre>
  46 $ <code class="userinput">echo "deb http://apt.arvados.org/ wheezy main" | sudo tee /etc/apt/sources.list.d/apt.arvados.org.list</code>
  47 </pre>
  48 </notextile>
  49
  50 Then install the package:
  51
  52 <notextile>
  53 <pre>
  54 $ <code class="userinput">sudo apt-get update</code>
  55 $ <code class="userinput">sudo apt-get install python-arvados-python-client</code>
  56 </pre>
  57 </notextile>
  58
  59 h4. Option 3: build and install from source
  60
  61 <notextile>
  62 <pre>
  63 ~$ <code class="userinput">sudo apt-get install python-dev libattr1-dev libfuse-dev pkg-config</code>
  64 ~$ <code class="userinput">git clone https://github.com/curoverse/arvados.git</code>
  65 ~$ <code class="userinput">cd arvados/sdk/python</code>
  66 ~/arvados/sdk/python$ <code class="userinput">sudo python setup.py install</code>
  67 </pre>
  68 </notextile>
  69
  70 h4. Test installation
  71
  72 If the SDK is installed and your @ARVADOS_API_HOST@ and @ARVADOS_API_TOKEN@ environment variables are set up correctly (see "api-tokens":{{site.baseurl}}/user/reference/api-tokens.html for details), @import arvados@ should produce no errors:
  73
  74 <notextile>
  75 <pre>$ <code class="userinput">python</code>
  76 Python 2.7.4 (default, Sep 26 2013, 03:20:26)
  77 [GCC 4.7.3] on linux2
  78 Type "help", "copyright", "credits" or "license" for more information.
  79 >>> <code class="userinput">import arvados</code>
  80 >>> <code class="userinput">arvados.api('v1')</code>
  81 &lt;apiclient.discovery.Resource object at 0x233bb50&gt;
  82 </pre>
  83 </notextile>
  84
  85 h3. Examples
  86
  87 Get the User object for the current user:
  88
  89 <notextile>
  90 <pre><code class="userinput">current_user = arvados.api('v1').users().current().execute()
  91 </code></pre>
  92 </notextile>
  93
  94 Get the UUID of an object that was retrieved using the SDK:
  95
  96 <notextile>
  97 <pre><code class="userinput">my_uuid = current_user['uuid']
  98 </code></pre>
  99 </notextile>
 100
 101 Retrieve an object by ID:
 102
 103 <notextile>
 104 <pre><code class="userinput">some_user = arvados.api('v1').users().get(uuid=my_uuid).execute()
 105 </code></pre>
 106 </notextile>
 107
 108 Create an object:
 109
 110 <notextile>
 111 <pre><code class="userinput">test_link = arvados.api('v1').links().create(
 112     body={'link_class':'test','name':'test'}).execute()
 113 </code></pre>
 114 </notextile>
 115
 116 Update an object:
 117
 118 <notextile>
 119 <pre><code class="userinput">arvados.api('v1').links().update(
 120     uuid=test_link['uuid'],
 121     body={'properties':{'foo':'bar'}}).execute()
 122 </code></pre>
 123 </notextile>
 124
 125 Get a list of objects:
 126
 127 <notextile>
 128 <pre><code class="userinput">repos = arvados.api('v1').repositories().list().execute()
 129 len(repos['items'])</code>
 130 2
 131 <code class="userinput">repos['items'][0]['uuid']</code>
 132 u'qr1hi-s0uqq-kg8cawglrf74bmw'
 133 </code></pre>
 134 </notextile>
 135
 136 h3. Notes
 137
 138 The general form of an API call is:
 139
 140 <notextile>
 141 <pre><code class="userinput">arvados.api(<i>api_version</i>).<i>plural_resource_type</i>().<i>api_method</i>(<i>parameter</i>=<i>value</i>, ...).execute()
 142 </code></pre>
 143 </notextile>
 144
 145 Many API methods accept a parameter whose name is the same as the resource type. For example, @links.create@ accepts a parameter called @link@. This parameter should be given as @body@.
 146
 147 <notextile>
 148 <pre><code class="userinput">arvados.api('v1').links().create(
 149     uuid=test_link['uuid'],
 150     body={'properties':{'foo':'bar'}}).execute()
 151 </code></pre>
 152 </notextile>
 153
 154 One way to make API calls slightly less verbose is:
 155
 156 <notextile>
 157 <pre><code class="userinput">arv = arvados.api('v1')
 158 j = arv.jobs().list().execute()
 159 </code></pre>
 160 </notextile>
 161
 162 The SDK retrieves the list of API methods from the server at run time. Therefore, the set of available methods is determined by the server version rather than the SDK version.
 163