9369: Update CLI install documentation to include arvados-cwl-runner (& arvados-pytho...
authorPeter Amstutz <peter.amstutz@curoverse.com>
Thu, 14 Jul 2016 17:32:02 +0000 (13:32 -0400)
committerPeter Amstutz <peter.amstutz@curoverse.com>
Thu, 14 Jul 2016 17:32:20 +0000 (13:32 -0400)
doc/sdk/cli/install.html.textile.liquid
doc/sdk/python/sdk-python.html.textile.liquid

index 7ef45aa30dbf090347739731aca0d1514128601a..eff019a7fdaa99403ae67732eb4d2da9f6071d65 100644 (file)
@@ -6,7 +6,7 @@ title: "Installation"
 
 ...
 
-To use the @arv@ command, you can either install the @arvados-cli@ gem via RubyGems or build and install the package from source.
+Arvados CLI tools are written in Ruby and Python.  To use the @arv@ command, you can either install the @arvados-cli@ gem via RubyGems or build and install the package from source.  The @arv@ command also relies on other Arvados tools, you can either install the @arvados-python-client@ and @arvados-cwl-runner@ from PyPi or install the packages from source.
 
 h3. Prerequisites: Ruby, Bundler, and curl libraries
 
@@ -20,11 +20,17 @@ $ <code class="userinput">sudo apt-get install libcurl3 libcurl3-gnutls libcurl4
 </pre>
 </notextile>
 
-h3. Option 1: Install with RubyGems
+h3. Option 1: Install from RubyGems and PyPi
 
 <notextile>
 <pre>
-$ <code class="userinput">sudo -i gem install arvados-cli</code>
+arvados/sdk/cli$ <code class="userinput">sudo -i gem install arvados-cli</code>
+</pre>
+</notextile>
+
+<notextile>
+<pre>
+arvados/sdk/cli$ <code class="userinput">sudo -i pip install arvados-python-client arvados-cwl-runner</code>
 </pre>
 </notextile>
 
@@ -38,3 +44,17 @@ $ <code class="userinput">gem build arvados-cli.gemspec</code>
 $ <code class="userinput">sudo -i gem install arvados-cli-*.gem</code>
 </pre>
 </notextile>
+
+<notextile>
+<pre>
+$ <code class="userinput">cd arvados/sdk/python</code>
+$ <code class="userinput">sudo -i python setup.py install</code>
+</pre>
+</notextile>
+
+<notextile>
+<pre>
+$ <code class="userinput">cd arvados/sdk/cwl</code>
+$ <code class="userinput">sudo -i python setup.py install</code>
+</pre>
+</notextile>
index 72a6933ad389fb4312a35ec18c79c22bbf77eb8d..8380618e2345099a23ca3bac47dc8b2ce8c5e17e 100644 (file)
@@ -28,27 +28,27 @@ First, "add the appropriate package repository for your distribution":{{ site.ba
 On CentOS 6 and RHEL 6:
 
 <notextile>
-<pre><code>~$ <span class="userinput">sudo yum install python27-python-arvados-python-client python27-python-arvados-cwl-runner</code>
+<pre><code>~$ <span class="userinput">sudo yum install python27-python-arvados-python-client</code>
 </code></pre>
 </notextile>
 
 On other Red Hat-based systems:
 
 <notextile>
-<pre><code>~$ <span class="userinput">sudo yum install python-arvados-python-client python-arvados-cwl-runner</code>
+<pre><code>~$ <span class="userinput">sudo yum install python-arvados-python-client</code>
 </code></pre>
 </notextile>
 
 On Debian-based systems:
 
 <notextile>
-<pre><code>~$ <span class="userinput">sudo apt-get install python-arvados-python-client python-arvados-cwl-runner</code>
+<pre><code>~$ <span class="userinput">sudo apt-get install python-arvados-python-client</code>
 </code></pre>
 </notextile>
 
 h4. Option 2: Install with pip
 
-Run @pip-2.7 install arvados-python-client arvados-cwl-runner@ in an appropriate installation environment, such as a virtualenv.
+Run @pip-2.7 install arvados-python-client@ in an appropriate installation environment, such as a virtualenv.
 
 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-2.7 install --pre arvados-python-client@.