9369: arvados-cwl-runner documentation and examples, add deprecation notices to pipel...
[arvados.git] / doc / sdk / python / sdk-python.html.textile.liquid
index a6a0b565c9cb3bcdf8b5a03a6eb79370ce34ab47..adbb316c3f395dd3f91a21173f4ce0837d3cc32a 100644 (file)
@@ -6,9 +6,7 @@ title: "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.
-
-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.  In also includes a number of command line tools for using and administering Arvados and Keep, and some conveniences for use in Crunch scripts; see "Crunch utility libraries":crunch-utility-libraries.html for details.
 
 h3. Installation
 
@@ -30,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</code>
+<pre><code>~$ <span class="userinput">sudo yum install python27-python-arvados-python-client python27-python-arvados-cwl-runner</code>
 </code></pre>
 </notextile>
 
 On other Red Hat-based systems:
 
 <notextile>
-<pre><code>~$ <span class="userinput">sudo yum install python-arvados-python-client</code>
+<pre><code>~$ <span class="userinput">sudo yum install python-arvados-python-client python-arvados-cwl-runner</code>
 </code></pre>
 </notextile>
 
 On Debian-based systems:
 
 <notextile>
-<pre><code>~$ <span class="userinput">sudo apt-get install python-arvados-python-client</code>
+<pre><code>~$ <span class="userinput">sudo apt-get install python-arvados-python-client python-arvados-cwl-runner</code>
 </code></pre>
 </notextile>
 
 h4. Option 2: Install with pip
 
-Run @pip-2.7 install arvados-python-client@ in an appropriate installation environment, such as a virtualenv.
+Run @pip-2.7 install arvados-python-client arvados-cwl-runner@ 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@.
 
@@ -60,7 +58,9 @@ Install the @python-setuptools@ package from your distribution.  Then run the fo
 
 <notextile>
 <pre><code>~$ <span class="userinput">git clone https://github.com/curoverse/arvados.git</span>
-~$ <span class="userinput">cd arvados/sdk/python</span>
+~$ <span class="userinput">cd ~/arvados/sdk/python</span>
+~$ <span class="userinput">python2.7 setup.py install</span>
+~$ <span class="userinput">cd ~/arvados/sdk/cwl</span>
 ~$ <span class="userinput">python2.7 setup.py install</span>
 </code></pre>
 </notextile>