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 h2. 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 PyPI or a distribution package.
  20
  21 The Python SDK supports Python 2.7 and 3.4+
  22
  23 h2. Option 1: Install from a distribution package
  24
  25 This installation method is recommended to make the CLI tools available system-wide. It can coexist with the installation method described in option 2, below.
  26
  27 First, configure the "Arvados package repositories":../../install/packages.html
  28
  29 {% assign arvados_component = 'python-arvados-python-client' %}
  30
  31 {% include 'install_packages' %}
  32
  33 h2. Option 2: Install with pip
  34
  35 This installation method is recommended to use the SDK in your own Python programs. It can coexist with the system-wide installation method from a distribution package (option 2, below).
  36
  37 Run @pip install arvados-python-client@ in an appropriate installation environment, such as a @virtualenv@.
  38
  39 The SDK uses @pycurl@ which depends on the @libcurl@ C library.  To build the module you may have to install additional packages.  On Debian 9 this is:
  40
  41 <pre>
  42 $ apt-get install git build-essential python3-dev libcurl4-openssl-dev libssl1.0-dev
  43 </pre>
  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 install --pre arvados-python-client@.
  46
  47 h2. Test installation
  48
  49 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.
  50
  51 If you installed with pip (option 1, above):
  52
  53 <notextile>
  54 <pre>~$ <code class="userinput">python</code>
  55 Python 2.7.4 (default, Sep 26 2013, 03:20:26)
  56 [GCC 4.7.3] on linux2
  57 Type "help", "copyright", "credits" or "license" for more information.
  58 >>> <code class="userinput">import arvados</code>
  59 >>> <code class="userinput">arvados.api('v1')</code>
  60 &lt;apiclient.discovery.Resource object at 0x233bb50&gt;
  61 </pre>
  62 </notextile>
  63
  64 If you installed from a distribution package (option 2): the package includes a virtualenv, which means the correct Python environment needs to be loaded before the Arvados SDK can be imported. This can be done by activating the virtualenv first:
  65
  66 <notextile>
  67 <pre>~$ <code class="userinput">source /usr/share/python2.7/dist/python-arvados-python-client/bin/activate</code>
  68 (python-arvados-python-client) ~$ <code class="userinput">python</code>
  69 Python 2.7.4 (default, Sep 26 2013, 03:20:26)
  70 [GCC 4.7.3] on linux2
  71 Type "help", "copyright", "credits" or "license" for more information.
  72 >>> <code class="userinput">import arvados</code>
  73 >>> <code class="userinput">arvados.api('v1')</code>
  74 &lt;apiclient.discovery.Resource object at 0x233bb50&gt;
  75 </pre>
  76 </notextile>
  77
  78 Or alternatively, by using the Python executable from the virtualenv directly:
  79
  80 <notextile>
  81 <pre>~$ <code class="userinput">/usr/share/python2.7/dist/python-arvados-python-client/bin/python</code>
  82 Python 2.7.4 (default, Sep 26 2013, 03:20:26)
  83 [GCC 4.7.3] on linux2
  84 Type "help", "copyright", "credits" or "license" for more information.
  85 >>> <code class="userinput">import arvados</code>
  86 >>> <code class="userinput">arvados.api('v1')</code>
  87 &lt;apiclient.discovery.Resource object at 0x233bb50&gt;
  88 </pre>
  89 </notextile>
  90
  91 h2. Usage
  92
  93 Check out the "examples":example.html and "cookbook":cookbook.html
  94
  95 h3. Notes
  96
  97 The general form of an API call is:
  98
  99 <notextile>
 100 <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()
 101 </code></pre>
 102 </notextile>
 103
 104 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@.
 105
 106 <notextile>
 107 <pre><code class="userinput">arvados.api('v1').links().create(
 108     uuid=test_link['uuid'],
 109     body={'properties':{'foo':'bar'}}).execute()
 110 </code></pre>
 111 </notextile>
 112
 113 One way to make API calls slightly less verbose is:
 114
 115 <notextile>
 116 <pre><code class="userinput">arv = arvados.api('v1')
 117 j = arv.jobs().list().execute()
 118 </code></pre>
 119 </notextile>
 120
 121 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.