X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/6fa46a69150cf4284988a65794b974c1cea6a46b..66088cabf30c5291ad8894e7009d9c9af466c158:/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 0ce95e3188..fd1ff36c5e 100644 --- a/doc/sdk/python/sdk-python.html.textile.liquid +++ b/doc/sdk/python/sdk-python.html.textile.liquid @@ -22,9 +22,9 @@ To use the Python SDK elsewhere, you can install it "from an Arvados distributio 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' %} -h2(#package-install). Option 1: Install from a distribution package +h2(#package-install). Install from a distribution package -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. +This installation method is recommended to make the CLI tools available system-wide. It can coexist with the pip installation method described below. First, configure the "Arvados package repositories":../../install/packages.html @@ -65,26 +65,27 @@ Type "help", "copyright", "credits" or "license" for more information. After you have successfully tested your installation, proceed to the the "API client overview":api-client.html and "cookbook":cookbook.html to learn how to use the SDK. -h2(#pip-install). Option 2: Install with pip +h2(#pip-install). Install from PyPI with pip 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. -The SDK uses @pycurl@ which depends on the @libcurl@ C library. To build the module you may have to first install additional packages. On Debian 10 you can do this by running: +Note the Python SDK uses @pycurl@ which depends on the @libcurl@ C library. To build the module you may have to first install additional packages. On Debian-based distributions you can install them by running: -
-$ apt-get install git build-essential python3-dev libcurl4-openssl-dev libssl-dev
-
+ +
# apt install git build-essential python3-dev libcurl4-openssl-dev libssl-dev
+
+
-Run @pip install arvados-python-client@ in an appropriate installation environment, such as a @virtualenv@. +Run @python3 -m pip install arvados-python-client@ in an appropriate installation environment, such as a @virtualenv@. {% include 'notebox_begin_warning' %} -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@. +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 @python3 -m pip install --pre arvados-python-client@. {% include 'notebox_end' %} You can test the installation by creating a client object. Ensure your "@ARVADOS_API_HOST@ and @ARVADOS_API_TOKEN@ credentials are set up correctly":{{site.baseurl}}/user/reference/api-tokens.html. Then you should be able to run the following without any errors: -
~$ python
+
~$ 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.