[ARVADOS] updated: 1.3.0-2077-g19545d256
Git user
git at public.arvados.org
Thu Jan 16 17:35:08 UTC 2020
Summary of changes:
.../install-shell-server.html.textile.liquid | 1 +
doc/sdk/cli/install.html.textile.liquid | 10 ++++-
doc/sdk/python/arvados-fuse.html.textile.liquid | 51 ++++++++--------------
doc/sdk/python/sdk-python.html.textile.liquid | 12 ++++-
doc/sdk/ruby/index.html.textile.liquid | 21 ++++-----
5 files changed, 45 insertions(+), 50 deletions(-)
via 19545d256d58a1ea71d127f2eb25443dcbd3db64 (commit)
from 5e8d75bc3b942b7f0dc2c0129a8e8a0e10d598e5 (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
commit 19545d256d58a1ea71d127f2eb25443dcbd3db64
Author: Peter Amstutz <peter.amstutz at curii.com>
Date: Thu Jan 16 12:34:28 2020 -0500
Doc updates for install Ruby and Python SDKs and utilities
closes #16000
closes #16001
Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <peter.amstutz at curii.com>
diff --git a/doc/install/install-shell-server.html.textile.liquid b/doc/install/install-shell-server.html.textile.liquid
index 00aae6c3c..f57d0690c 100644
--- a/doc/install/install-shell-server.html.textile.liquid
+++ b/doc/install/install-shell-server.html.textile.liquid
@@ -30,6 +30,7 @@ h2(#dependencies). Install Dependecies and SDKs
# "Install Ruby and Bundler":ruby.html
# "Install the Python SDK":{{site.baseurl}}/sdk/python/sdk-python.html
+# "Install the FUSE driver":{{site.baseurl}}/sdk/python/arvados-fuse.html
# "Install the CLI":{{site.baseurl}}/sdk/cli/install.html
# "Install the R SDK":{{site.baseurl}}/sdk/R/index.html (optional)
# "Install Docker":install-docker.html (optional)
diff --git a/doc/sdk/cli/install.html.textile.liquid b/doc/sdk/cli/install.html.textile.liquid
index c43c095aa..3c60bdfe3 100644
--- a/doc/sdk/cli/install.html.textile.liquid
+++ b/doc/sdk/cli/install.html.textile.liquid
@@ -14,13 +14,19 @@ Arvados CLI tools are written in Ruby and Python. To use the @arv@ command, you
h2. Prerequisites
-# "Install Ruby and Bundler":../../install/ruby.html
+# "Install Ruby":../../install/ruby.html
# "Install the Python SDK":../python/sdk-python.html
+The SDK uses @curl@ which depends on the @libcurl@ C library. To build the module you may have to install additional packages. On Debian 9 this is:
+
+<pre>
+$ apt-get install build-essential libcurl4-openssl-dev
+</pre>
+
h2. Install from RubyGems
<notextile>
<pre>
-~$ <code class="userinput">sudo -i gem install arvados-cli</code>
+# <code class="userinput">gem install arvados-cli</code>
</pre>
</notextile>
diff --git a/doc/sdk/python/arvados-fuse.html.textile.liquid b/doc/sdk/python/arvados-fuse.html.textile.liquid
index 80e793baa..0ac2d0c7e 100644
--- a/doc/sdk/python/arvados-fuse.html.textile.liquid
+++ b/doc/sdk/python/arvados-fuse.html.textile.liquid
@@ -12,52 +12,37 @@ SPDX-License-Identifier: CC-BY-SA-3.0
The Arvados FUSE driver is a Python utility that allows you to see the Keep service as a normal filesystem, so that data can be accessed using standard tools. This driver requires the Python SDK installed in order to access Arvados services.
-h3. Installation
+h2. Installation
-If you are logged in to an Arvados VM, the @arv-mount@ utility should already be installed.
+If you are logged in to a managed Arvados VM, the @arv-mount@ utility should already be installed.
-To use the FUSE driver elsewhere, you can install from a distribution package, PyPI, or source.
+To use the FUSE driver elsewhere, you can install from a distribution package, or PyPI.
-{% include 'notebox_begin' %}
-The Arvados FUSE driver requires Python 2.7
-{% include 'notebox_end' %}
+h2. Option 1: Install from distribution packages
-h4. Option 1: Install from distribution packages
+First, "add the appropriate package repository for your distribution":{{ site.baseurl }}/install/packages.html
-First, "add the appropriate package repository for your distribution":{{ site.baseurl }}/install/install-manual-prerequisites.html#repos.
+{% assign arvados_component = 'python-arvados-fuse' %}
-{% assign rh_version = "6" %}
-{% include 'note_python_sc' %}
+{% include 'install_packages' %}
-On Red Hat-based systems:
+h2. Option 2: Install with pip
-<notextile>
-<pre><code>~$ <span class="userinput">echo 'exclude=python2-llfuse' | sudo tee -a /etc/yum.conf</span>
-~$ <span class="userinput">sudo yum install python-arvados-fuse</code>
-</code></pre>
-</notextile>
-
-On Debian-based systems:
-
-<notextile>
-<pre><code>~$ <span class="userinput">sudo apt-get install python-arvados-fuse</code>
-</code></pre>
-</notextile>
+Run @pip install arvados_fuse@ in an appropriate installation environment, such as a virtualenv.
-h4. Option 2: Install with pip
+Note:
-Run @pip install arvados_fuse@ in an appropriate installation environment, such as a virtualenv.
+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 9 this is:
-h4. Option 3: Install from source
+<pre>
+$ apt-get install git build-essential python-dev libcurl4-openssl-dev libssl1.0-dev python-llfuse
+</pre>
-Install the @python-setuptools@ package from your distribution. Then run the following:
+For Python 3 this is:
-<notextile>
-<pre><code>~$ <span class="userinput">git clone https://github.com/arvados/arvados.git</span>
-~$ <span class="userinput">cd arvados/services/fuse</span>
-~/arvados/services/fuse$ <span class="userinput">python setup.py install</span>
-</code></pre>
-</notextile>
+<pre>
+$ apt-get install git build-essential python3-dev libcurl4-openssl-dev libssl1.0-dev python3-llfuse
+</pre>
h3. Usage
diff --git a/doc/sdk/python/sdk-python.html.textile.liquid b/doc/sdk/python/sdk-python.html.textile.liquid
index b1aca316a..fa7c36c24 100644
--- a/doc/sdk/python/sdk-python.html.textile.liquid
+++ b/doc/sdk/python/sdk-python.html.textile.liquid
@@ -32,11 +32,19 @@ First, configure the "Arvados package repositories":../../install/packages.html
h2. Option 2: Install with pip
-This installation method is recommended to use the SDK in your own Python programs. It can coexist with the system-wide installation method from a distribution package (option 2, below).
+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 at .
-The SDK uses @pycurl@ which depends on the @libcurl@ C library. To build the module you may have to install additional packages. On Debian 9 this is:
+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 9 this is:
+
+<pre>
+$ apt-get install git build-essential python-dev libcurl4-openssl-dev libssl1.0-dev
+</pre>
+
+For Python 3 this is
<pre>
$ apt-get install git build-essential python3-dev libcurl4-openssl-dev libssl1.0-dev
diff --git a/doc/sdk/ruby/index.html.textile.liquid b/doc/sdk/ruby/index.html.textile.liquid
index 531469ea1..6f06722d2 100644
--- a/doc/sdk/ruby/index.html.textile.liquid
+++ b/doc/sdk/ruby/index.html.textile.liquid
@@ -12,36 +12,31 @@ SPDX-License-Identifier: CC-BY-SA-3.0
The Ruby SDK provides a generic set of wrappers so you can make API calls easily.
-h3. Installation
+h2. Installation
If you are logged in to an Arvados VM, the Ruby SDK should be installed.
To use it elsewhere, you can either install the @arvados@ gem via RubyGems or build and install the package using the arvados source tree.
-h4. Prerequisites: Ruby >= 2.0.0
+h3. Prerequisites
-You can use "RVM":http://rvm.io/rvm/install to install and manage Ruby versions.
+# "Install Ruby":../../install/ruby.html
-h4. Option 1: install with RubyGems
+The SDK uses @curl@ which depends on the @libcurl@ C library. To build the module you may have to install additional packages. On Debian 9 this is:
-<notextile>
<pre>
-$ <code class="userinput">sudo -i gem install arvados</code>
+$ apt-get install build-essential libcurl4-openssl-dev
</pre>
-</notextile>
-h4. Option 2: build and install from source
+h3. Install with RubyGems
<notextile>
<pre>
-$ <code class="userinput">git clone https://github.com/arvados/arvados.git</code>
-$ <code class="userinput">cd arvados/sdk/ruby</code>
-$ <code class="userinput">gem build arvados.gemspec</code>
-$ <code class="userinput">sudo -i gem install arvados-*.gem</code>
+# <code class="userinput">gem install arvados</code>
</pre>
</notextile>
-h4. Test installation
+h3. Test installation
If the SDK is installed, @ruby -r arvados -e 'puts "OK!"'@ should produce no errors.
-----------------------------------------------------------------------
hooks/post-receive
--
More information about the arvados-commits
mailing list