X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/84b30d024ee757e32af7e05d00bf4324513c388c..499240fcfa25c10bc22277b7d382dcbc31436cbe:/doc/sdk/python/sdk-python.html.textile.liquid
diff --git a/doc/sdk/python/sdk-python.html.textile.liquid b/doc/sdk/python/sdk-python.html.textile.liquid
index be824399a4..4639306922 100644
--- a/doc/sdk/python/sdk-python.html.textile.liquid
+++ b/doc/sdk/python/sdk-python.html.textile.liquid
@@ -10,70 +10,39 @@ 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
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.
+To use the Python SDK elsewhere, you can install it "from an Arvados distribution package":#package-install or "from PyPI using pip":#pip-install.
-{% include 'notebox_begin' %}
-The Python SDK requires Python 2.7.
+{% include 'notebox_begin_warning' %}
+As of Arvados 2.2, the Python SDK requires Python 3.6+. The last version to support Python 2.7 is Arvados 2.0.4.
{% include 'notebox_end' %}
-h3. Option 1: Install with pip
+h2(#package-install). 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 pip installation method described 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.
-
-First, "add the appropriate package repository for your distribution":{{ site.baseurl }}/install/install-manual-prerequisites.html#repos.
-
-On Red Hat-based systems:
-
-
-~$ sudo yum install python-arvados-python-client
-
-~$ sudo apt-get install python-arvados-python-client
-~$
-python
-Python 2.7.4 (default, Sep 26 2013, 03:20:26)
-[GCC 4.7.3] on linux2
-Type "help", "copyright", "credits" or "license" for more information.
->>> import arvados
->>> arvados.api('v1')
-<apiclient.discovery.Resource object at 0x233bb50>
-~$
source /usr/share/python2.7/dist/python-arvados-python-client/bin/activate
+~$
source /usr/share/python3/dist/python3-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')
@@ -81,12 +50,12 @@ Type "help", "copyright", "credits" or "license" for more information.
~$
/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
+~$
/usr/share/python3/dist/python3-arvados-python-client/bin/python
+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,81 +63,35 @@ Type "help", "copyright", "credits" or "license" for more information.
-current_user = arvados.api('v1').users().current().execute()
-
-my_uuid = current_user['uuid']
-
-some_user = arvados.api('v1').users().get(uuid=my_uuid).execute()
-
-test_link = arvados.api('v1').links().create(
- body={'link_class':'test','name':'test'}).execute()
-
-arvados.api('v1').links().update(
- uuid=test_link['uuid'],
- body={'properties':{'foo':'bar'}}).execute()
-
-repos = arvados.api('v1').repositories().list().execute()
-len(repos['items'])
-2
-repos['items'][0]['uuid']
-u'qr1hi-s0uqq-kg8cawglrf74bmw'
-
-arvados.api(api_version).plural_resource_type().api_method(parameter=value, ...).execute()
-
+$ apt-get install git build-essential python3-dev libcurl4-openssl-dev libssl-dev +-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@. +Run @python3 -m pip install arvados-python-client@ in an appropriate installation environment, such as a @virtualenv@. -
arvados.api('v1').links().create(
- uuid=test_link['uuid'],
- body={'properties':{'foo':'bar'}}).execute()
-
-arv = arvados.api('v1')
-j = arv.jobs().list().execute()
-
+~$python3
+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')
+<apiclient.discovery.Resource object at 0x233bb50> +