Reorganizing API documentation to support new navbar (refs #1651).

[arvados.git] / doc / api / crunch-scripts.textile

diff --git a/doc/api/crunch-scripts.textile b/doc/api/crunch-scripts.textile
index f41d236d99eec3c862cfe0fdcf3c0214920d30f2..10f0c653f6db0cdd9aa10426ba192a18a675f2b5 100644 (file)
--- a/doc/api/crunch-scripts.textile
+++ b/doc/api/crunch-scripts.textile
@@ -1,6 +1,7 @@
 ---
 layout: default
 navsection: api
+navmenu: Concepts
 title: Crunch scripts
 navorder: 5
 ---
@@ -21,9 +22,25 @@ table(table table-bordered table-condensed).
 |Environment variable|Description|
 |@JOB_UUID@|UUID of the current "Job":Jobs.html|
 |@TASK_UUID@|UUID of the current "JobTask":JobTasks.html|
-|@TASK_QSEQUENCE@|Number of tasks added to this job before this one (in other words, 0-based queue entry order)|
-|@TASK_SEQUENCE@|Task execution sequence specified when task was created — generally not unique to this task|
 |@ARVADOS_API_HOST@|Hostname and port number of API server|
 |@ARVADOS_API_TOKEN@|Authentication token to use with API calls made by the current task|
 
 The crunch script typically uses the Python SDK (or another suitable client library / SDK) to connect to the Arvados service and retrieve the rest of the details about the current job and task.
+
+The Python SDK has some shortcuts for common operations.
+
+In general, a crunch script can access information about the current job and task like this:
+
+<pre>
+import arvados
+import os
+
+job = arvados.api().jobs().get(uuid=os.environ['JOB_UUID']).execute()
+$sys.stderr.write("script_parameters['foo'] == %s"
+                  % job['script_parameters']['foo'])
+
+task = arvados.api().job_tasks().get(uuid=os.environ['TASK_UUID']).execute()
+$sys.stderr.write("current task sequence number is %d"
+                  % task['sequence'])
+</pre>
+