add status docs to readmes

pepkit · Jun 24, 2021 · 1da644f · 1da644f
1 parent 241b487
commit 1da644f
Showing 4 changed files with 148 additions and 383 deletions.
diff --git a/README.md b/README.md
@@ -30,7 +30,9 @@ export PIPESTAT_RESULTS_FILE=results_file.yaml
 export PIPESTAT_NAMESPACE=my_namespace
 ```
 
-## Report a result
+## Pipeline results reporting and retrieval
+
+### Report a result
 
 From command line:
 
@@ -47,7 +49,7 @@ psm = pipestat.PipestatManager()
 psm.report(values={"result_name": 1.1})
 ```
 
-## Retrieve a result
+### Retrieve a result
 
 From command line:
 
@@ -63,3 +65,39 @@ import pipestat
 psm = pipestat.PipestatManager()
 psm.retrieve(result_identifier="result_name")
 ```
+
+## Pipeline status management
+
+## Set status
+
+From command line:
+
+```console
+pipestat status set running
+```
+
+From Python:
+
+```python
+import pipestat
+
+psm = pipestat.PipestatManager()
+psm.set_status(status_identifier="running")
+```
+
+## Get status
+
+From command line:
+
+```console
+pipestat status get
+```
+
+From Python:
+
+```python
+import pipestat
+
+psm = pipestat.PipestatManager()
+psm.get_status()
+```
diff --git a/docs/README.md b/docs/README.md
@@ -30,7 +30,9 @@ export PIPESTAT_RESULTS_FILE=results_file.yaml
 export PIPESTAT_NAMESPACE=my_namespace
 ```
 
-## Report a result
+## Pipeline results reporting and retrieval
+
+### Report a result
 
 From command line:
 
@@ -47,7 +49,7 @@ psm = pipestat.PipestatManager()
 psm.report(values={"result_name": 1.1})
 ```
 
-## Retrieve a result
+### Retrieve a result
 
 From command line:
 
@@ -63,3 +65,39 @@ import pipestat
 psm = pipestat.PipestatManager()
 psm.retrieve(result_identifier="result_name")
 ```
+
+## Pipeline status management
+
+## Set status
+
+From command line:
+
+```console
+pipestat status set running
+```
+
+From Python:
+
+```python
+import pipestat
+
+psm = pipestat.PipestatManager()
+psm.set_status(status_identifier="running")
+```
+
+## Get status
+
+From command line:
+
+```console
+pipestat status get
+```
+
+From Python:
+
+```python
+import pipestat
+
+psm = pipestat.PipestatManager()
+psm.get_status()
+```