X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/a7f378b2267ddc1b44a8661d6723264fe959d98e..d6b2ead0824fe6810917e5281b4feb969528eb46:/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 9a5b54083e..75769d7e2a 100644 --- a/doc/sdk/python/sdk-python.html.textile.liquid +++ b/doc/sdk/python/sdk-python.html.textile.liquid @@ -14,36 +14,58 @@ h3. Installation If you are logged in to an Arvados VM, the Python SDK should be installed. -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. +To use the Python SDK elsewhere, you can install from a distribution package, PyPI, or source. -h4. Option 1: install with PyPI +{% include 'notebox_begin' %} +The Python SDK requires Python 2.7. +{% include 'notebox_end' %} + +h4. Option 1: Install from distribution packages + +First, "add the appropriate package repository for your distribution":{{ site.baseurl }}/install/install-manual-prerequisites.html#repos. + +On Debian-based systems: -
-$ sudo apt-get install python-dev libattr1-dev libfuse-dev pkg-config
-$ sudo pip install arvados-python-client
-
+
~$ sudo apt-get install python-arvados-python-client
+
-h4. Option 2: build and install from source +On Red Hat-based systems: -
-$ 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
-
+
~$ sudo yum install python27-python-arvados-python-client
+
+{% include 'note_python27_sc' %} + +h4. Option 2: Install with pip + +Run @pip-2.7 install arvados-python-client@ in an appropriate installation environment, such as a virtualenv. + +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@. + +h4. Option 3: Install from source + +Install the @python-setuptools@ package from your distribution. Then run the following: + + +
~$ git clone https://github.com/curoverse/arvados.git
+~$ cd arvados/sdk/python
+~$ python2.7 setup.py install
+
+
+ +You may optionally run the final installation command in a virtualenv, or with the @--user@ option. + 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
-Python 2.7.4 (default, Sep 26 2013, 03:20:26) 
+
~$ python2.7
+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
@@ -130,4 +152,3 @@ j = arv.jobs().list().execute()
 
 
 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.
-