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

   1 ---
   2 layout: default
   3 navsection: sdk
   4 navmenu: Python
   5 title: "Installation"
   6 ...
   7 {% comment %}
   8 Copyright (C) The Arvados Authors. All rights reserved.
   9
  10 SPDX-License-Identifier: CC-BY-SA-3.0
  11 {% endcomment %}
  12
  13 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.
  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 install from a distribution package, PyPI, or source.
  20
  21 {% include 'notebox_begin' %}
  22 The Python SDK requires Python 2.7.
  23 {% include 'notebox_end' %}
  24
  25 h4. Option 1: Install from distribution packages
  26
  27 First, "add the appropriate package repository for your distribution":{{ site.baseurl }}/install/install-manual-prerequisites.html#repos.
  28
  29 {% assign rh_version = "6" %}
  30 {% include 'note_python_sc' %}
  31
  32 On Red Hat-based systems:
  33
  34 <notextile>
  35 <pre><code>~$ <span class="userinput">sudo yum install python-arvados-python-client</code>
  36 </code></pre>
  37 </notextile>
  38
  39 On Debian-based systems:
  40
  41 <notextile>
  42 <pre><code>~$ <span class="userinput">sudo apt-get install python-arvados-python-client</code>
  43 </code></pre>
  44 </notextile>
  45
  46 h4. Option 2: Install with pip
  47
  48 Run @pip-2.7 install arvados-python-client@ in an appropriate installation environment, such as a virtualenv.
  49
  50 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@.
  51
  52 h4. Option 3: Install from source
  53
  54 Install the @python-setuptools@ package from your distribution.  Then run the following:
  55
  56 <notextile>
  57 <pre><code>~$ <span class="userinput">git clone https://github.com/curoverse/arvados.git</span>
  58 ~$ <span class="userinput">cd arvados/sdk/python</span>
  59 ~/arvados/sdk/python$ <span class="userinput">python2.7 setup.py install</span>
  60 </code></pre>
  61 </notextile>
  62
  63 You may optionally run the final installation command in a virtualenv, or with the @--user@ option.
  64
  65 h4. Test installation
  66
  67 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:
  68
  69 <notextile>
  70 <pre>~$ <code class="userinput">python2.7</code>
  71 Python 2.7.4 (default, Sep 26 2013, 03:20:26)
  72 [GCC 4.7.3] on linux2
  73 Type "help", "copyright", "credits" or "license" for more information.
  74 >>> <code class="userinput">import arvados</code>
  75 >>> <code class="userinput">arvados.api('v1')</code>
  76 &lt;apiclient.discovery.Resource object at 0x233bb50&gt;
  77 </pre>
  78 </notextile>
  79
  80 h3. Examples
  81
  82 Get the User object for the current user:
  83
  84 <notextile>
  85 <pre><code class="userinput">current_user = arvados.api('v1').users().current().execute()
  86 </code></pre>
  87 </notextile>
  88
  89 Get the UUID of an object that was retrieved using the SDK:
  90
  91 <notextile>
  92 <pre><code class="userinput">my_uuid = current_user['uuid']
  93 </code></pre>
  94 </notextile>
  95
  96 Retrieve an object by ID:
  97
  98 <notextile>
  99 <pre><code class="userinput">some_user = arvados.api('v1').users().get(uuid=my_uuid).execute()
 100 </code></pre>
 101 </notextile>
 102
 103 Create an object:
 104
 105 <notextile>
 106 <pre><code class="userinput">test_link = arvados.api('v1').links().create(
 107     body={'link_class':'test','name':'test'}).execute()
 108 </code></pre>
 109 </notextile>
 110
 111 Update an object:
 112
 113 <notextile>
 114 <pre><code class="userinput">arvados.api('v1').links().update(
 115     uuid=test_link['uuid'],
 116     body={'properties':{'foo':'bar'}}).execute()
 117 </code></pre>
 118 </notextile>
 119
 120 Get a list of objects:
 121
 122 <notextile>
 123 <pre><code class="userinput">repos = arvados.api('v1').repositories().list().execute()
 124 len(repos['items'])</code>
 125 2
 126 <code class="userinput">repos['items'][0]['uuid']</code>
 127 u'qr1hi-s0uqq-kg8cawglrf74bmw'
 128 </code></pre>
 129 </notextile>
 130
 131 h3. Notes
 132
 133 The general form of an API call is:
 134
 135 <notextile>
 136 <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()
 137 </code></pre>
 138 </notextile>
 139
 140 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@.
 141
 142 <notextile>
 143 <pre><code class="userinput">arvados.api('v1').links().create(
 144     uuid=test_link['uuid'],
 145     body={'properties':{'foo':'bar'}}).execute()
 146 </code></pre>
 147 </notextile>
 148
 149 One way to make API calls slightly less verbose is:
 150
 151 <notextile>
 152 <pre><code class="userinput">arv = arvados.api('v1')
 153 j = arv.jobs().list().execute()
 154 </code></pre>
 155 </notextile>
 156
 157 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.