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</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: build and install from source
  41
  42 <notextile>
  43 <pre>
  44 $ <code class="userinput">sudo apt-get install python-dev libattr1-dev libfuse-dev pkg-config</code>
  45 $ <code class="userinput">git clone https://github.com/curoverse/arvados.git</code>
  46 $ <code class="userinput">cd arvados/sdk/python</code>
  47 $ <code class="userinput">./build.sh</code>
  48 $ <code class="userinput">sudo python setup.py install</code>
  49 </pre>
  50 </notextile>
  51
  52 h4. Test installation
  53
  54 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:
  55
  56 <notextile>
  57 <pre>$ <code class="userinput">python</code>
  58 Python 2.7.4 (default, Sep 26 2013, 03:20:26)
  59 [GCC 4.7.3] on linux2
  60 Type "help", "copyright", "credits" or "license" for more information.
  61 >>> <code class="userinput">import arvados</code>
  62 >>> <code class="userinput">arvados.api('v1')</code>
  63 &lt;apiclient.discovery.Resource object at 0x233bb50&gt;
  64 </pre>
  65 </notextile>
  66
  67 h3. Examples
  68
  69 Get the User object for the current user:
  70
  71 <notextile>
  72 <pre><code class="userinput">current_user = arvados.api('v1').users().current().execute()
  73 </code></pre>
  74 </notextile>
  75
  76 Get the UUID of an object that was retrieved using the SDK:
  77
  78 <notextile>
  79 <pre><code class="userinput">my_uuid = current_user['uuid']
  80 </code></pre>
  81 </notextile>
  82
  83 Retrieve an object by ID:
  84
  85 <notextile>
  86 <pre><code class="userinput">some_user = arvados.api('v1').users().get(uuid=my_uuid).execute()
  87 </code></pre>
  88 </notextile>
  89
  90 Create an object:
  91
  92 <notextile>
  93 <pre><code class="userinput">test_link = arvados.api('v1').links().create(
  94     body={'link_class':'test','name':'test'}).execute()
  95 </code></pre>
  96 </notextile>
  97
  98 Update an object:
  99
 100 <notextile>
 101 <pre><code class="userinput">arvados.api('v1').links().update(
 102     uuid=test_link['uuid'],
 103     body={'properties':{'foo':'bar'}}).execute()
 104 </code></pre>
 105 </notextile>
 106
 107 Get a list of objects:
 108
 109 <notextile>
 110 <pre><code class="userinput">repos = arvados.api('v1').repositories().list().execute()
 111 len(repos['items'])</code>
 112 2
 113 <code class="userinput">repos['items'][0]['uuid']</code>
 114 u'qr1hi-s0uqq-kg8cawglrf74bmw'
 115 </code></pre>
 116 </notextile>
 117
 118 h3. Notes
 119
 120 The general form of an API call is:
 121
 122 <notextile>
 123 <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()
 124 </code></pre>
 125 </notextile>
 126
 127 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@.
 128
 129 <notextile>
 130 <pre><code class="userinput">arvados.api('v1').links().create(
 131     uuid=test_link['uuid'],
 132     body={'properties':{'foo':'bar'}}).execute()
 133 </code></pre>
 134 </notextile>
 135
 136 One way to make API calls slightly less verbose is:
 137
 138 <notextile>
 139 <pre><code class="userinput">arv = arvados.api('v1')
 140 j = arv.jobs().list().execute()
 141 </code></pre>
 142 </notextile>
 143
 144 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.
 145