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.
12 If you are logged in to an Arvados VM, the Python SDK should be installed.
14 To use the Python SDK elsewhere, you can install from a distribution package, PyPI, or source.
16 {% include 'notebox_begin' %}
17 The Python SDK requires Python 2.7.
18 {% include 'notebox_end' %}
20 h4. Option 1: Install from distribution packages
22 First, "add the appropriate package repository for your distribution":{{ site.baseurl }}/install/install-manual-prerequisites.html#repos.
24 {% assign rh_version = "6" %}
25 {% include 'note_python_sc' %}
27 On CentOS 6 and RHEL 6:
30 <pre><code>~$ <span class="userinput">sudo yum install python27-python-arvados-python-client</code>
34 On other Red Hat-based systems:
37 <pre><code>~$ <span class="userinput">sudo yum install python-arvados-python-client</code>
41 On Debian-based systems:
44 <pre><code>~$ <span class="userinput">sudo apt-get install python-arvados-python-client</code>
48 h4. Option 2: Install with pip
50 Run @pip-2.7 install arvados-python-client@ in an appropriate installation environment, such as a virtualenv.
52 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 h4. Option 3: Install from source
56 Install the @python-setuptools@ package from your distribution. Then run the following:
59 <pre><code>~$ <span class="userinput">git clone https://github.com/curoverse/arvados.git</span>
60 ~$ <span class="userinput">cd arvados/sdk/python</span>
61 ~/arvados/sdk/python$ <span class="userinput">python2.7 setup.py install</span>
65 You may optionally run the final installation command in a virtualenv, or with the @--user@ option.
69 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:
72 <pre>~$ <code class="userinput">python2.7</code>
73 Python 2.7.4 (default, Sep 26 2013, 03:20:26)
75 Type "help", "copyright", "credits" or "license" for more information.
76 >>> <code class="userinput">import arvados</code>
77 >>> <code class="userinput">arvados.api('v1')</code>
78 <apiclient.discovery.Resource object at 0x233bb50>
84 Get the User object for the current user:
87 <pre><code class="userinput">current_user = arvados.api('v1').users().current().execute()
91 Get the UUID of an object that was retrieved using the SDK:
94 <pre><code class="userinput">my_uuid = current_user['uuid']
98 Retrieve an object by ID:
101 <pre><code class="userinput">some_user = arvados.api('v1').users().get(uuid=my_uuid).execute()
108 <pre><code class="userinput">test_link = arvados.api('v1').links().create(
109 body={'link_class':'test','name':'test'}).execute()
116 <pre><code class="userinput">arvados.api('v1').links().update(
117 uuid=test_link['uuid'],
118 body={'properties':{'foo':'bar'}}).execute()
122 Get a list of objects:
125 <pre><code class="userinput">repos = arvados.api('v1').repositories().list().execute()
126 len(repos['items'])</code>
128 <code class="userinput">repos['items'][0]['uuid']</code>
129 u'qr1hi-s0uqq-kg8cawglrf74bmw'
135 The general form of an API call is:
138 <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 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@.
145 <pre><code class="userinput">arvados.api('v1').links().create(
146 uuid=test_link['uuid'],
147 body={'properties':{'foo':'bar'}}).execute()
151 One way to make API calls slightly less verbose is:
154 <pre><code class="userinput">arv = arvados.api('v1')
155 j = arv.jobs().list().execute()
159 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.