X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/715869b9a22e22ac68a7dbefa96f27150017f75d..ba2c87d3cad4f66afa26c0033fc70ce69ba10301:/doc/sdk/python/sdk-python.html.textile.liquid?ds=sidebyside
diff --git a/doc/sdk/python/sdk-python.html.textile.liquid b/doc/sdk/python/sdk-python.html.textile.liquid
index 22a21670bf..09eaa8e552 100644
--- a/doc/sdk/python/sdk-python.html.textile.liquid
+++ b/doc/sdk/python/sdk-python.html.textile.liquid
@@ -2,94 +2,98 @@
layout: default
navsection: sdk
navmenu: Python
-title: "Python SDK"
-
+title: "Installation"
...
+{% comment %}
+Copyright (C) The Arvados Authors. All rights reserved.
-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.
+SPDX-License-Identifier: CC-BY-SA-3.0
+{% endcomment %}
-The library also includes some conveniences for use in Crunch scripts; see "Crunch utility libraries":crunch-utility-libraries.html for details.
+The Python SDK provides access from Python to the Arvados API and Keep, along with a number of command line tools for using and administering Arvados and Keep.
-h3. Installation
+h2. 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 install from PyPI or a distribution package.
-
-$
-git clone https://github.com/curoverse/arvados.git
-$ cd arvados/sdk/python
-$ sudo python setup.py install
-$
-python
-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
->>> arvados.api('v1')
-<apiclient.discovery.Resource object at 0x233bb50>
-
-current_user = arvados.api('v1').users().current().execute()
-
-my_uuid = current_user['uuid']
-
-some_user = arvados.api('v1').users().get(uuid=my_uuid).execute()
-
+$ apt-get install git build-essential python3-dev libcurl4-openssl-dev libssl-dev +-Create an object: +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):
test_link = arvados.api('v1').links().create(
- body={'link_class':'test','name':'test'}).execute()
-
+~$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> +
arvados.api('v1').links().update(
- uuid=test_link['uuid'],
- body={'properties':{'foo':'bar'}}).execute()
-
+~$source /usr/share/python3/dist/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. +>>>import arvados
+>>>arvados.api('v1')
+<apiclient.discovery.Resource object at 0x233bb50> +
+repos = arvados.api('v1').repositories().list().execute() -len(repos['items'])
-2 -repos['items'][0]['uuid']
-u'qr1hi-s0uqq-kg8cawglrf74bmw' -
~$/usr/share/python3/dist/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. +>>>import arvados
+>>>arvados.api('v1')
+<apiclient.discovery.Resource object at 0x233bb50> +