FEAT: New extension version manager (#5702)

Co-authored-by: ring630 <@gmail.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Samuelopez-ansys <[email protected]>
ansys · Feb 7, 2025 · 01b93eb · 01b93eb
1 parent 66716fc
commit 01b93eb
Show file tree

Hide file tree

Showing 7 changed files with 584 additions and 0 deletions.
diff --git a/doc/source/User_guide/extensions.rst b/doc/source/User_guide/extensions.rst
@@ -55,6 +55,13 @@ They are small automated workflows with a simple GUI.
 
             Lear how to convert projects from 2022R2 to newer versions.
 
+   .. grid-item-card:: Version manager
+            :link: pyaedt_extensions_doc/project/version_manager
+            :link-type: doc
+            :margin: 2 2 0 0
+
+            Manage pyaedt and pyedb versions.
+
 
 HFSS 3D Layout extensions
 ~~~~~~~~~~~~~~~~~~~~~~~~~

diff --git a/doc/source/User_guide/pyaedt_extensions_doc/project/version_manager.rst b/doc/source/User_guide/pyaedt_extensions_doc/project/version_manager.rst
@@ -0,0 +1,22 @@
+The extension allows users to update PyAEDT and PyEDB through GUI
+-----------------------------------------------------------------
+
+.. image:: ../../../_static/extensions/version_manager.png
+  :width: 800
+  :alt: Version manager
+
+----------
+Features
+----------
+
+- Show Python virtual environment path
+- Show Python version
+- Show the current PyAEDT and PyEDB versions
+- Show the latest PyAEDT and PyEDB release available on PyPI
+- Update PyAEDT and PyEDB to the latest version on PyPI
+- Install PyAEDT and PyEDB with a branch available on Github
+    - By default the main development branch is used
+    - Other existing branch names can be provided
+- Update PyAEDT and PyEDB from wheelhouse
+  - Check compatibility
+- Reset and update PyAEDT buttons in AEDT
diff --git a/doc/source/_static/extensions/version_manager.png b/doc/source/_static/extensions/version_manager.png
diff --git a/doc/styles/config/vocabularies/ANSYS/accept.txt b/doc/styles/config/vocabularies/ANSYS/accept.txt
@@ -33,6 +33,7 @@ FEBI
 FE-BI
 file_path
 getters
+Github
 globals
 [Gg]RPC
 HDM

diff --git a/src/ansys/aedt/core/workflows/project/images/large/version_manager.png b/src/ansys/aedt/core/workflows/project/images/large/version_manager.png
diff --git a/src/ansys/aedt/core/workflows/project/toolkits_catalog.toml b/src/ansys/aedt/core/workflows/project/toolkits_catalog.toml
@@ -25,3 +25,10 @@ script = "advanced_fields_calculator.py"
 icon = "images/large/fields.png"
 template = "run_pyaedt_toolkit_script"
 pip = ""
+
+[VersionManager]
+name = "Version Manager"
+script = "version_manager.py"
+icon = "images/large/version_manager.png"
+template = "run_pyaedt_toolkit_script"
+pip = ""
-Original file line number
+Diff line change
@@ Expand Up / @@ -33,6 +33,7 @@ FEBI @@
     FE-BI
     file_path
     getters
+    Github
     globals
     [Gg]RPC
     HDM
@@ Expand Down @@