support downloading project archive; suppress console window (#145)

Co-authored-by: pyansys-ci-bot <[email protected]>

Author: franknli

doc/changelog.d/145.documentation.md

@@ -0,0 +1 @@
+support downloading project archive; suppress console window

doc/source/user-guide.rst

@@ -160,6 +160,12 @@ directly to the Workbench server. You should specify the path relative to the
 
     client.upload_file_from_example_repo("pymechanical-integration/agdb/two_pipes.agdb")
 
+There is a convenience function to save the current Workbench project on the server, archive
+the project, and then download the project archive to the client.
+.. code-block:: python
+
+    wb.download_project_archive(archive_name="my_project_archive")
+
 All methods for uploading and downloading files display a progress bar by default. You can
 turn off the progress bar with an optional argument:
 

src/ansys/workbench/core/public_api.py

@@ -108,7 +108,7 @@ class LaunchWorkbench(ClientWrapper):
     def __init__(
         self,
         show_gui=True,
-        version="242",
+        version=None,
         client_workdir=None,
         server_workdir=None,
         host=None,
@@ -118,6 +118,8 @@ def __init__(
         self._wmi_connection = None
         self._process_id = -1
 
+        if not version:
+            version = "242"
         if (
             len(version) != 3
             or not version.isdigit()
@@ -163,7 +165,7 @@ def __launch_server(self, show_gui, host, version, server_workdir, username, pas
                 # use forward slash only to avoid escaping as command line argument
                 server_workdir = server_workdir.replace("\\", "/")
                 workdir_arg = ",WorkingDirectory='" + server_workdir + "'"
-            ui_or_not = " -I" if show_gui else " --start-and-wait"
+            ui_or_not = " -I" if show_gui else " --start-and-wait -nowindow"
             command = (
                 executable
                 + ui_or_not

src/ansys/workbench/core/workbench_client.py

@@ -381,6 +381,28 @@ def download_file(self, file_name, show_progress=True, target_dir=None):
             pbar.close()
         return file_name
 
+    def download_project_archive(self, archive_name, show_progress=True):
+        """Create and download the project archive.
+
+        Parameters
+        ----------
+        archive_name : str
+            Name of the project archive to use, without the file extension.
+        show_progress : bool, default: True
+            Whether to show a progress bar during the download.
+        """
+        if not re.match(r"^\w+$", archive_name):
+            logging.error("archive name should contain only alphanumeric characters")
+            return
+        script = f"""import os
+wd = GetServerWorkingDirectory()
+if os.path.basename(GetProjectFile()).StartsWith("wbnew."):
+    Save(FilePath=os.path.join(wd, "{archive_name}.wbpj"), Overwrite=True)
+Archive(FilePath=os.path.join(wd, "{archive_name}.wbpz"))
+"""
+        self.run_script_string(script)
+        self.download_file(archive_name + ".wbpz", show_progress=show_progress)
+
     def __python_logging(self, log_level, msg):
         """Log a message with the given log level.