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 access from Python to the Arvados API and Keep.  It also includes a number of command line tools for using and administering Arvados and Keep, and some conveniences for use in Crunch scripts; see "Crunch utility libraries":crunch-utility-libraries.html for details.
  10
  11 h3. Installation
  12
  13 If you are logged in to an Arvados VM, the Python SDK should be installed.
  14
  15 To use the Python SDK elsewhere, you can install from a distribution package, PyPI, or source.
  16
  17 {% include 'notebox_begin' %}
  18 The Python SDK requires Python 2.7.
  19 {% include 'notebox_end' %}
  20
  21 h4. Option 1: Install from distribution packages
  22
  23 First, "add the appropriate package repository for your distribution":{{ site.baseurl }}/install/install-manual-prerequisites.html#repos.
  24
  25 {% assign rh_version = "6" %}
  26 {% include 'note_python_sc' %}
  27
  28 On CentOS 6 and RHEL 6:
  29
  30 <notextile>
  31 <pre><code>~$ <span class="userinput">sudo yum install python27-python-arvados-python-client</code>
  32 </code></pre>
  33 </notextile>
  34
  35 On other Red Hat-based systems:
  36
  37 <notextile>
  38 <pre><code>~$ <span class="userinput">sudo yum install python-arvados-python-client</code>
  39 </code></pre>
  40 </notextile>
  41
  42 On Debian-based systems:
  43
  44 <notextile>
  45 <pre><code>~$ <span class="userinput">sudo apt-get install python-arvados-python-client</code>
  46 </code></pre>
  47 </notextile>
  48
  49 h4. Option 2: Install with pip
  50
  51 Run @pip-2.7 install arvados-python-client@ in an appropriate installation environment, such as a virtualenv.
  52
  53 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, try @pip-2.7 install --pre arvados-python-client@.
  54
  55 h4. Option 3: Install from source
  56
  57 Install the @python-setuptools@ package from your distribution.  Then run the following:
  58
  59 <notextile>
  60 <pre><code>~$ <span class="userinput">git clone https://github.com/curoverse/arvados.git</span>
  61 ~$ <span class="userinput">cd ~/arvados/sdk/python</span>
  62 ~$ <span class="userinput">python2.7 setup.py install</span>
  63 ~$ <span class="userinput">cd ~/arvados/sdk/cwl</span>
  64 ~$ <span class="userinput">python2.7 setup.py install</span>
  65 </code></pre>
  66 </notextile>
  67
  68 You may optionally run the final installation command in a virtualenv, or with the @--user@ option.
  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">python2.7</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.