fix: 🐛 fix boolean argparse argument for preconfig example

Author: zachcamara-hpe

docs/source/examples/generate_preconfig.rst

@@ -3,12 +3,19 @@
 
 .. important::
 
-    The following example is more complex code than the other examples,
+    The following example is more complex code than the general examples,
     generating data and interacting with Orchestrator. Using and
     modifying these examples requires a greater understanding of python
     functions, handling variables, and additional tools such as Jinja.
 
 
+.. note::
+
+    The code referenced in this document and all published examples
+    with pyedgeconnect are available from the GitHub repository within the
+    `examples <https://https://github.com/SPOpenSource/edgeconnect-python/tree/main/examples>`_
+    folder
+
 Generate EdgeConnect Preconfig
 ------------------------------
 
@@ -154,17 +161,19 @@ Additional availble runtime arguments are as follows:
 - ``-o`` or ``--orch``
     - Type: String
     - Desc: Specify the Orchestrator IP or FQDN
-    - Example values: ``10.100.1.90`` or ``orchestrator.<company>.com``
+    - Example values: ``192.0.2.100`` or ``orchestrator.<company>.com``
     - Default value: ``None``
 - ``-u`` or ``--upload``
     - Type: Boolean
-    - Desc: Upload the rendered YAML preconfig to Orchestrator
-    - Accepted values: ``True`` or ``False``
+    - Desc: Upload the rendered YAML preconfig to Orchestrator.
+      Including the ``-u`` will translate to ``True``, no option will
+      default to ``False``
     - Default value: ``False``
 - ``-aa`` or ``--autoapply``
     - Type: Boolean
-    - Desc: Auto-apply the YAML preconfig on Orchestrator to a discovered appliance
-    - Accepted values: ``True`` or ``False``
+    - Desc: Auto-apply the YAML preconfig on Orchestrator to a
+      discovered appliance. Including the ``-aa`` will translate to
+      ``True``, no option will default to ``False``
     - Default value: ``False``
 - ``-j`` or ``--jinja``
     - Type: String
@@ -209,7 +218,8 @@ Orchestrator API calls
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The two API calls to Orchestrator (outside of authentication) are
-``validate_preconfig`` and ``create_preconfig``.
+:func:`pyedgeconnect.Orchestrator.validate_preconfig` and
+:func:`pyedgeconnect.Orchestrator.create_preconfig`.
 
 The ``validate_preconfig`` function sends the preconfig YAML text to
 Orchestrator and will either return a success (HTTP 200 OK) or if

examples/generate_preconfig/preconfig.py

@@ -20,15 +20,13 @@
     "-u",
     "--upload",
     help="Upload created valid preconfigs to Orchestrator",
-    type=bool,
-    default=False,
+    action=argparse.BooleanOptionalAction,
 )
 parser.add_argument(
     "-aa",
     "--autoapply",
     help="Mark preconfigs for auto-approve",
-    type=bool,
-    default=False,
+    action=argparse.BooleanOptionalAction,
 )
 parser.add_argument(
     "-j",
@@ -171,14 +169,15 @@
             auto_apply=auto_apply,
         )
 
-        # If the validate function passes on Orchestrator write
-        # preconfig to local file and check if uploading to Orchestrator
-        if validate.status_code == 200:
+        # Write local YAML file to see resulting YAML file locally
+        # whether validate passes or fails
+        yaml_filename = f'{row["hostname"]}_preconfig.yml'
+        with open(output_directory + yaml_filename, "w") as preconfig_file:
+            write_data = preconfig_file.write(yaml_preconfig)
 
-            # Write local YAML file
-            yaml_filename = "{}_preconfig.yml".format(row["hostname"])
-            with open(output_directory + yaml_filename, "w") as preconfig_file:
-                write_data = preconfig_file.write(yaml_preconfig)
+        # If the validate function passes on Orchestrator, move on
+        # to check if uploading to Orchestrator option selected
+        if validate.status_code == 200:
 
             # If upload option was chosen, upload preconfig to
             # Orchestrator with selected auto-apply settings
@@ -191,26 +190,24 @@
                 # against a discovered appliance
                 # Additionally a comment is added with the current
                 # date
+                comment_timestamp = datetime.date.today().strftime("%d %B %Y")
                 orch.create_preconfig(
                     preconfig_name=row["hostname"],
                     yaml_preconfig=yaml_preconfig,
                     auto_apply=auto_apply,
                     tag=row["hostname"],
-                    comment="Created/Uploaded @ {}".format(
-                        datetime.date.today().strftime("%d %B %Y")
-                    ),
+                    comment=f"Created/Uploaded @ {comment_timestamp}",
                 )
-                print("Posted EC Preconfig {}".format(row["hostname"]))
+                print(f'Posted EC Preconfig {row["hostname"]}')
             else:
                 pass
         else:
             print(
-                "Preconfig for {} failed validation | error: {}".format(
-                    row["hostname"], validate.text
-                )
+                f'Preconfig for {row["hostname"]}'
+                f" failed validation | error: {validate.text}"
             )
             # Write local YAML file of failed config for reference
-            yaml_filename = "{}_preconfig-FAILED.yml".format(row["hostname"])
+            yaml_filename = f'{row["hostname"]}_preconfig-FAILED.yml'
             with open(output_directory + yaml_filename, "w") as preconfig_file:
                 write_data = preconfig_file.write(yaml_preconfig)