11 The Python SDK provides a generic set of wrappers so you can make API calls easily. It performs some validation before connecting to the API server: for example, it refuses to do an API call if a required parameter is missing.
13 The library also includes some conveniences for use in Crunch scripts; see "Crunch utility libraries":crunch-utility-libraries.html for details.
17 If you are logged in to an Arvados VM, the Python SDK should be installed.
19 To use the Python SDK elsewhere, you can either install the Python SDK via PyPI or build and install the package using the arvados source tree.
21 h4. Option 1: install with PyPI
25 $ <code class="userinput">sudo apt-get install python-dev libattr1-dev libfuse-dev pkg-config</code>
26 $ <code class="userinput">sudo pip install arvados-python-client</code>
30 h4. Option 2: build and install from source
34 $ <code class="userinput">sudo apt-get install python-dev libattr1-dev libfuse-dev pkg-config</code>
35 $ <code class="userinput">git clone https://github.com/curoverse/arvados.git</code>
36 $ <code class="userinput">cd arvados/sdk/python</code>
37 $ <code class="userinput">./build.sh</code>
38 $ <code class="userinput">sudo python setup.py install</code>
44 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:
47 <pre>$ <code class="userinput">python</code>
48 Python 2.7.4 (default, Sep 26 2013, 03:20:26)
50 Type "help", "copyright", "credits" or "license" for more information.
51 >>> <code class="userinput">import arvados</code>
52 >>> <code class="userinput">arvados.api('v1')</code>
53 <apiclient.discovery.Resource object at 0x233bb50>
59 Get the User object for the current user:
62 <pre><code class="userinput">current_user = arvados.api('v1').users().current().execute()
66 Get the UUID of an object that was retrieved using the SDK:
69 <pre><code class="userinput">my_uuid = current_user['uuid']
73 Retrieve an object by ID:
76 <pre><code class="userinput">some_user = arvados.api('v1').users().get(uuid=my_uuid).execute()
83 <pre><code class="userinput">test_link = arvados.api('v1').links().create(
84 body={'link_class':'test','name':'test'}).execute()
91 <pre><code class="userinput">arvados.api('v1').links().update(
92 uuid=test_link['uuid'],
93 body={'properties':{'foo':'bar'}}).execute()
97 Get a list of objects:
100 <pre><code class="userinput">repos = arvados.api('v1').repositories().list().execute()
101 len(repos['items'])</code>
103 <code class="userinput">repos['items'][0]['uuid']</code>
104 u'qr1hi-s0uqq-kg8cawglrf74bmw'
110 The general form of an API call is:
113 <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()
117 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@.
120 <pre><code class="userinput">arvados.api('v1').links().create(
121 uuid=test_link['uuid'],
122 body={'properties':{'foo':'bar'}}).execute()
126 One way to make API calls slightly less verbose is:
129 <pre><code class="userinput">arv = arvados.api('v1')
130 j = arv.jobs().list().execute()
134 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.