X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/5f41a89121dea9d536ea33391ae2827432db947b..f79d1cdf7696a3bbcc374df5ce4d1761a28a5ea5:/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 bf66194068..4a6ba029fe 100644 --- a/doc/sdk/python/sdk-python.html.textile.liquid +++ b/doc/sdk/python/sdk-python.html.textile.liquid @@ -16,13 +16,15 @@ 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. -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_begin_warning' %} +As of Arvados 3.0, the Python SDK requires Python 3.8+. +{% include 'notebox_end' %} -h2. 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 @@ -30,30 +32,11 @@ First, configure the "Arvados package repositories":../../install/packages.html {% include 'install_packages' %} -h2. Option 2: Install 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. - -Run @pip install arvados-python-client@ in an appropriate installation environment, such as a @virtualenv@. - -Note: - -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 this is: - -
-$ apt-get install git build-essential python3-dev libcurl4-openssl-dev libssl-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@. - -h2. 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. - -If you installed with pip (option 1, above): +The package includes a virtualenv, which means the correct Python environment needs to be loaded before the Arvados SDK can be imported. You can test the installation by doing that, then 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
+~$source /usr/lib/python3-arvados-python-client/bin/activate
+(python-arvados-python-client) ~$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. @@ -63,15 +46,10 @@ Type "help", "copyright", "credits" or "license" for more information.
~$source /usr/share/python3/dist/python3-arvados-python-client/bin/activate
-(python-arvados-python-client) ~$python
+~$/usr/lib/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. @@ -81,10 +59,29 @@ Type "help", "copyright", "credits" or "license" for more information.
~$/usr/share/python3/dist/python3-arvados-python-client/bin/python
++# apt install git build-essential python3-dev libcurl4-openssl-dev libssl-dev +
~$ 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.
@@ -94,6 +91,4 @@ Type "help", "copyright", "credits" or "license" for more information.