X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/eae48c31bb338689ec67fbc6a14a2e0b1fb5e3b6..fec7796668a4f4a73bb52e16e13e4504f76649f5:/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 e9b560a965..c8b2b67b11 100644
--- a/doc/sdk/python/sdk-python.html.textile.liquid
+++ b/doc/sdk/python/sdk-python.html.textile.liquid
@@ -4,34 +4,43 @@ navsection: sdk
navmenu: Python
title: "Installation"
...
+{% comment %}
+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.
-h3. Installation
+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 a distribution package, PyPI, or source.
+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' %}
+The Python SDK supports Python 2.7 and 3.4+
-h4. Option 1: Install from distribution packages
+h3. Option 1: 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 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).
-{% assign rh_version = "6" %}
-{% include 'note_python_sc' %}
+Run @pip install arvados-python-client@ in an appropriate installation environment, such as a @virtualenv@.
-On CentOS 6 and RHEL 6:
+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:
-
-~$ sudo yum install python27-python-arvados-python-client
-
+$ apt-get install git build-essential python3-dev libcurl4-openssl-dev libssl1.0-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. Option 2: Install from a distribution package -On other Red Hat-based systems: +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
@@ -45,31 +54,41 @@ On Debian-based systems:
~$ git clone https://github.com/curoverse/arvados.git
-~$ cd arvados/sdk/python
-~/arvados/sdk/python$ python2.7 setup.py install
-
+~$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
+(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> +
~$python2.7
+~$/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 Type "help", "copyright", "credits" or "license" for more information.