X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/715869b9a22e22ac68a7dbefa96f27150017f75d..6fb5d2bd10901a1e0ced4ea8849419145d47a0b5:/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 22a21670bf..09af1a3238 100644
--- a/doc/sdk/python/sdk-python.html.textile.liquid
+++ b/doc/sdk/python/sdk-python.html.textile.liquid
@@ -6,8 +6,6 @@ title: "Python SDK"
...
-h1. Python SDK
-
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.
The library also includes some conveniences for use in Crunch scripts; see "Crunch utility libraries":crunch-utility-libraries.html for details.
@@ -16,17 +14,40 @@ h3. Installation
If you are logged in to an Arvados VM, the Python SDK should be installed.
-To use the Python SDK elsewhere, build and install the package using the arvados source tree.
+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.
+
+h4. Option 1: install with PyPI
+
+
+
+$ sudo apt-get install python-pip python-dev libattr1-dev libfuse-dev pkg-config
+$ sudo pip install arvados-python-client
+
+
+
+_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, fix it by adding a @--pre@ flag:_
+$ sudo pip install --pre arvados-python-client
+
+
+
+h4. Option 2: build and install from source
+
+
+
+$ sudo apt-get install python-dev libattr1-dev libfuse-dev pkg-config
$ git clone https://github.com/curoverse/arvados.git
$ cd arvados/sdk/python
+$ ./build.sh
$ sudo python setup.py install
-If the SDK is installed and your @ARVADOS_API_HOST@ and @ARVADOS_API_TOKEN@ environment variables are set up correctly (see "api-tokens":{{site.basedoc}}/user/reference/api-tokens.html for details), @import arvados@ should produce no errors:
+h4. 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:
$ python