feat: Migrate launcher tool (#29)

* feat: Migrate launcher

* feat: Migrate launcher

* fix: Pre-commit

* fix: Doc fixes

* fix: Doc issues

* fix: Doc dependencies

* fix: Dependencies

* fix: Deps

* fix: supress warnings

* fix: Deps

* fix: Dependencies

* fix: Modules

* fix: Test approach

* fix: rework CI

* fix: Rework CI

* fix: Click version

* fix: Test

Author: AlejandroFernandezLuces

.github/workflows/cicd.yml

@@ -49,10 +49,23 @@ jobs:
         ON_UBUNTU: true
 
       steps:
-        - name: Run tests
-          uses: ansys/actions/tests-pytest@v10
+        - name: Checkout repository
+          uses: actions/checkout@v3
+        - name: Set up Python
+          uses: actions/setup-python@v4
           with:
             python-version: ${{ env.MAIN_PYTHON_VERSION }}
+            cache: 'pip'
+
+        - name: Install dependencies
+          run: |
+            python -m pip install --upgrade pip
+            pip install -e .[tests]
+            pip install tests/launcher/pkg_with_entrypoint
+
+        - name: Run tests
+          run: |
+            pytest
 
     doc-build:
       name: Build documentation

.github/workflows/run_mapdl_tests.yml

@@ -34,7 +34,10 @@ jobs:
           with:
             python-version: ${{ env.MAIN_PYTHON_VERSION }}
         - name: Install library, with test extra
-          run: python -m pip install .[tests]
+          run: |
+            python -m pip install .[tests]
+            python -m pip install tests/launcher/pkg_with_entrypoint
+
 
         - name: Unit testing
           run: |

doc/source/conf.py

@@ -76,6 +76,7 @@
     "sphinx_copybutton",
     "sphinx_design",
     "ansys_sphinx_theme.extension.autoapi",
+    "sphinx_click",  # Required by local-product-launcher
 ]
 
 # numpydoc configuration
@@ -113,3 +114,4 @@
 typehints_defaults = "comma"
 # additional logos for the latex coverpage
 latex_additional_files = [watermark, ansys_logo_white, ansys_logo_white_cropped]
+suppress_warnings = ["autoapi.python_import_resolution", "ref.python"]

doc/source/user_guide/index.rst

@@ -45,6 +45,13 @@ your own code.
 
         Learn how to use the report tool.
 
+    .. grid-item-card:: Ansys local launcher tool
+        :padding: 2 2 2 2
+        :link: launcher/index
+        :link-type: doc
+
+        Learn how to use the launcher tool.
+
 .. toctree::
     :hidden:
     :maxdepth: 3
@@ -53,4 +60,5 @@ your own code.
     ansys_downloader
     ansys_exceptions
     versioning
-    report
+    report
+    launcher/index

doc/source/user_guide/launcher/cli.rst

@@ -0,0 +1,13 @@
+.. _ref_cli:
+
+Command-line interface
+======================
+
+You use the ``ansys-launcher`` command-line interface to edit the default
+launch configuration.
+
+Configuration options for products are defined by each product plugin.
+
+.. click:: ansys.tools.common.launcher._cli:cli
+    :prog: ansys-launcher
+    :nested: full

doc/source/user_guide/launcher/index.rst

@@ -0,0 +1,18 @@
+User guide
+----------
+
+This section provides an overview of the Local Product Launcher and how to use it.
+
+- The :ref:`rationale` page provides a high-level overview of the problem that the
+  Local Product Launcher solves.
+- The :ref:`ref_cli` page describes the command-line interface.
+- The :ref:`plugin_creation` page describes how to create a launcher plugin to extend
+  the Local Product Launcher for use with another Ansys product.
+
+.. toctree::
+    :maxdepth: 2
+    :caption: Contents
+
+    rationale
+    cli
+    plugin_creation