X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/8f0d6aa24427d8d79fd61923921f94dec977dac0..499240fcfa25c10bc22277b7d382dcbc31436cbe:/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 56f0328042..4639306922 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. +{% include 'notebox_begin_warning' %} 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. 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,45 +32,12 @@ 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): - -
~$-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. ->>>import arvados
->>>arvados.api('v1')
-<apiclient.discovery.Resource object at 0x233bb50> -
~$source /usr/share/python3/dist/python3-arvados-python-client/bin/activate
(python-arvados-python-client) ~$python
@@ -81,7 +50,7 @@ Type "help", "copyright", "credits" or "license" for more information.
~$ /usr/share/python3/dist/python3-arvados-python-client/bin/python
@@ -94,34 +63,35 @@ Type "help", "copyright", "credits" or "license" for more information.
arvados.api(api_version).plural_resource_type().api_method(parameter=value, ...).execute()
-
-+$ apt-get install git build-essential python3-dev libcurl4-openssl-dev libssl-dev +-Many API methods accept a parameter whose name is the same as the resource type. For example, @links.create@ accepts a parameter called @link@. This parameter should be given as @body@. +Run @python3 -m pip install arvados-python-client@ in an appropriate installation environment, such as a @virtualenv@. -
arvados.api('v1').links().create(
- uuid=test_link['uuid'],
- body={'properties':{'foo':'bar'}}).execute()
-
-arv = arvados.api('v1')
-j = arv.jobs().list().execute()
-
+~$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. +>>>import arvados
+>>>arvados.api('v1')
+<apiclient.discovery.Resource object at 0x233bb50> +