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