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

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