Merge pull request #250 from sandialabs/249-add-output-from-the-example-in-the-readme

docs: Include output from first example in README

Author: jmgate

README.md

@@ -72,6 +72,57 @@ if __name__ == "__main__":
     my_script.main(sys.argv[1:])
 ```
 
+Executing the script then yields
+```
+>>> my_staged_script.py --stage hello goodbye
+[07:34:19] ╭─────────────────────────────────────────────╮ staged_script.py:937
+           │ Greeting the user                           │
+           ╰─────────────────────────────────────────────╯
+           Executing:  echo 'Hello World'                  staged_script.py:827
+Hello World
+           `hello` stage duration:  0:00:00.020772         staged_script.py:476
+           ╭─────────────────────────────────────────────╮ staged_script.py:937
+           │ Bidding farewell                            │
+           ╰─────────────────────────────────────────────╯
+           Executing:  echo 'Goodbye World'                staged_script.py:827
+Goodbye World
+           `goodbye` stage duration:  0:00:00.012504       staged_script.py:476
+───────────────── ex_0_the_basics.py Script Execution Summary ─────────────────
+                                                           staged_script.py:920
+           ➤ Ran the following:
+
+               ex_0_the_basics.py \
+                   --stage hello goodbye \
+                   --hello-retry-attempts 0 \
+                   --hello-retry-delay 0 \
+                   --hello-retry-timeout 60 \
+                   --goodbye-retry-attempts 0 \
+                   --goodbye-retry-delay 0 \
+                   --goodbye-retry-timeout 60
+
+           ➤ Commands executed:
+
+               echo 'Hello World'
+               echo 'Goodbye World'
+
+           ➤ Timing results:
+
+               ┏━━━━━━━━━┳━━━━━━━━━━━━━━━━┓
+               ┃ Stage   ┃ Duration       ┃
+               ┡━━━━━━━━━╇━━━━━━━━━━━━━━━━┩
+               │ hello   │ 0:00:00.020772 │
+               │ goodbye │ 0:00:00.012504 │
+               ├─────────┼────────────────┤
+               │ Total   │ 0:00:00.035295 │
+               └─────────┴────────────────┘
+
+           ➤ Script result:
+
+               Success
+
+─────────────── End ex_0_the_basics.py Script Execution Summary ───────────────
+```
+
 For more detailed usage and API information, please see
 [our documentation][docs].
 

doc/source/index.rst

@@ -102,6 +102,58 @@ Once the package is installed, you can simply
    :lines: 10-
    :caption: ``example/ex_0_the_basics.py``
 
+Executing the script then yields
+
+.. code-block:: text
+
+   >>> ./ex_0_the_basics.py --stage hello goodbye
+   [07:34:19] ╭─────────────────────────────────────────────╮ staged_script.py:937
+              │ Greeting the user                           │
+              ╰─────────────────────────────────────────────╯
+              Executing:  echo 'Hello World'                  staged_script.py:827
+   Hello World
+              `hello` stage duration:  0:00:00.020772         staged_script.py:476
+              ╭─────────────────────────────────────────────╮ staged_script.py:937
+              │ Bidding farewell                            │
+              ╰─────────────────────────────────────────────╯
+              Executing:  echo 'Goodbye World'                staged_script.py:827
+   Goodbye World
+              `goodbye` stage duration:  0:00:00.012504       staged_script.py:476
+   ───────────────── ex_0_the_basics.py Script Execution Summary ─────────────────
+                                                              staged_script.py:920
+              ➤ Ran the following:
+
+                  ex_0_the_basics.py \
+                      --stage hello goodbye \
+                      --hello-retry-attempts 0 \
+                      --hello-retry-delay 0 \
+                      --hello-retry-timeout 60 \
+                      --goodbye-retry-attempts 0 \
+                      --goodbye-retry-delay 0 \
+                      --goodbye-retry-timeout 60
+
+              ➤ Commands executed:
+
+                  echo 'Hello World'
+                  echo 'Goodbye World'
+
+              ➤ Timing results:
+
+                  ┏━━━━━━━━━┳━━━━━━━━━━━━━━━━┓
+                  ┃ Stage   ┃ Duration       ┃
+                  ┡━━━━━━━━━╇━━━━━━━━━━━━━━━━┩
+                  │ hello   │ 0:00:00.020772 │
+                  │ goodbye │ 0:00:00.012504 │
+                  ├─────────┼────────────────┤
+                  │ Total   │ 0:00:00.035295 │
+                  └─────────┴────────────────┘
+
+              ➤ Script result:
+
+                  Success
+
+   ─────────────── End ex_0_the_basics.py Script Execution Summary ───────────────
+
 For more detailed usage information, see the :doc:`examples` page.  For
 implementation details, see the :doc:`reference` documentation.