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