X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/08123387faf00b0af64ea01f7196d8c5ca3fae1e..ad92a003eb3c4efdd3f880b5301033b755d6d247:/doc/sdk/python/sdk-python.html.textile.liquid?ds=sidebyside
diff --git a/doc/sdk/python/sdk-python.html.textile.liquid b/doc/sdk/python/sdk-python.html.textile.liquid
index be824399a4..e132305f0f 100644
--- a/doc/sdk/python/sdk-python.html.textile.liquid
+++ b/doc/sdk/python/sdk-python.html.textile.liquid
@@ -10,7 +10,7 @@ Copyright (C) The Arvados Authors. All rights reserved.
SPDX-License-Identifier: CC-BY-SA-3.0
{% endcomment %}
-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.
+The Python SDK provides access from Python to the Arvados API and Keep, along with a number of command line tools for using and administering Arvados and Keep.
h2. Installation
@@ -18,39 +18,35 @@ If you are logged in to an Arvados VM, the Python SDK should be installed.
To use the Python SDK elsewhere, you can install from PyPI or a distribution package.
-{% include 'notebox_begin' %}
-The Python SDK requires Python 2.7.
-{% include 'notebox_end' %}
+As of Arvados 2.1, the Python SDK requires Python 3.5+. The last version to support Python 2.7 is Arvados 2.0.4.
-h3. Option 1: Install with pip
+h2. Option 1: Install from a distribution package
-This installation method is recommended to make the SDK available for use in your own Python programs. It can coexist with the system-wide installation method from a distribution package (option 2, below).
+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.
-Run @pip-2.7 install arvados-python-client@ in an appropriate installation environment, such as a virtualenv.
+First, configure the "Arvados package repositories":../../install/packages.html
-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@.
+{% assign arvados_component = 'python3-arvados-python-client' %}
-h3. Option 2: Install from a distribution package
+{% include 'install_packages' %}
-This installation method is recommended to make the CLI tools available system-wide. It can coexist with the installation method described in option 1, above.
+h2. Option 2: Install with pip
-First, "add the appropriate package repository for your distribution":{{ site.baseurl }}/install/install-manual-prerequisites.html#repos.
+This installation method is recommended to use the SDK in your own Python programs. If installed into a @virtualenv@, it can coexist with the system-wide installation method from a distribution package.
-On Red Hat-based systems:
+Run @pip install arvados-python-client@ in an appropriate installation environment, such as a @virtualenv@.
-
-~$ sudo yum install python-arvados-python-client
-
-~$ sudo apt-get install python-arvados-python-client
-
+$ apt-get install git build-essential python3-dev libcurl4-openssl-dev libssl-dev ++ +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@. -h3. Test installation +h2. Test installation 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. @@ -58,8 +54,8 @@ If you installed with pip (option 1, above):
~$python
-Python 2.7.4 (default, Sep 26 2013, 03:20:26) -[GCC 4.7.3] on linux2 +Python 3.7.3 (default, Jul 25 2020, 13:03:44) +[GCC 8.3.0] on linux Type "help", "copyright", "credits" or "license" for more information. >>>import arvados
>>>arvados.api('v1')
@@ -72,8 +68,8 @@ If you installed from a distribution package (option 2): the package includes a ~$source /usr/share/python2.7/dist/python-arvados-python-client/bin/activate
(python-arvados-python-client) ~$python
-Python 2.7.4 (default, Sep 26 2013, 03:20:26) -[GCC 4.7.3] on linux2 +Python 3.7.3 (default, Jul 25 2020, 13:03:44) +[GCC 8.3.0] on linux Type "help", "copyright", "credits" or "license" for more information. >>>import arvados
>>>arvados.api('v1')
@@ -85,8 +81,8 @@ Or alternatively, by using the Python executable from the virtualenv directly:-h3. Examples - -Get the User object for the current user: - - ~$/usr/share/python2.7/dist/python-arvados-python-client/bin/python
-Python 2.7.4 (default, Sep 26 2013, 03:20:26) -[GCC 4.7.3] on linux2 +Python 3.7.3 (default, Jul 25 2020, 13:03:44) +[GCC 8.3.0] on linux Type "help", "copyright", "credits" or "license" for more information. >>>import arvados
>>>arvados.api('v1')
@@ -94,56 +90,9 @@ Type "help", "copyright", "credits" or "license" for more information.- - -Get the UUID of an object that was retrieved using the SDK: - --current_user = arvados.api('v1').users().current().execute() -
- - -Retrieve an object by ID: +h2. Usage --my_uuid = current_user['uuid'] -
- - -Create an object: - --some_user = arvados.api('v1').users().get(uuid=my_uuid).execute() -
- - -Update an object: - --test_link = arvados.api('v1').links().create( - body={'link_class':'test','name':'test'}).execute() -
- - -Get a list of objects: - --arvados.api('v1').links().update( - uuid=test_link['uuid'], - body={'properties':{'foo':'bar'}}).execute() -
- +Check out the "examples":example.html and "cookbook":cookbook.html h3. Notes-repos = arvados.api('v1').repositories().list().execute() -len(repos['items'])
-2 -repos['items'][0]['uuid']
-u'qr1hi-s0uqq-kg8cawglrf74bmw' -