feat: adding grantami-recordlists (#284)

Author: RobPasMue

.github/workflows/create-milestone.yml

@@ -18,26 +18,27 @@ jobs:
       matrix:
         pyansys-projects:
           [
-            "pyansys/pymapdl",
-            "pyansys/pymapdl-reader",
-            "pyansys/pydpf-core",
-            "pyansys/pydpf-post",
-            "pyansys/pydpf-composites",
-            "pyansys/pyfluent",
-            "pyansys/pyfluent-parametric",
-            "pyansys/pyfluent-visualization",
-            "pyansys/pyaedt",
-            "pyansys/pypim",
-            "pyansys/grantami-bomanalytics",
-            "pyansys/openapi-common",
-            "pyansys/pyseascape",
-            "pyansys/pyprimemesh",
-            "pyansys/pytwin",
-            "pyansys/pysystem-coupling",
-            "pyansys/pymotorcad",
-            "pyansys/pyansys-math",
-            "pyansys/pyoptislang",
-            "pyansys/pymechanical",
+            "ansys/pymapdl",
+            "ansys/pymapdl-reader",
+            "ansys/pydpf-core",
+            "ansys/pydpf-post",
+            "ansys/pydpf-composites",
+            "ansys/pyfluent",
+            "ansys/pyfluent-parametric",
+            "ansys/pyfluent-visualization",
+            "ansys/pyaedt",
+            "ansys/pypim",
+            "ansys/grantami-bomanalytics",
+            "ansys/grantami-recordlist",
+            "ansys/openapi-common",
+            "ansys/pyseascape",
+            "ansys/pyprimemesh",
+            "ansys/pytwin",
+            "ansys/pysystem-coupling",
+            "ansys/pymotorcad",
+            "ansys/pyansys-math",
+            "ansys/pyoptislang",
+            "ansys/pymechanical",
           ]
     steps:
       - uses: actions/checkout@v3

README.rst

@@ -55,6 +55,7 @@ The ``pyansys`` metapackage ensures compatibility between these PyAnsys packages
 - `PySystemCoupling <https://systemcoupling.docs.pyansys.com/>`_: Pythonic interface to communicate with Ansys System Coupling.
 - `PyTwin <https://twin.docs.pyansys.com/>`_: Pythonic interface to communicate with consumption workflows for Ansys digital twins.
 - `Granta MI BoM Analytics <https://bomanalytics.grantami.docs.pyansys.com/>`_: Pythonic interface to Ansys Granta MI BoM Analytics services.
+- `Granta MI RecordLists <https://recordlists.grantami.docs.pyansys.com/>`_: Pythonic interface to Ansys Granta MI Lists API.
 - `Shared Components <https://shared.docs.pyansys.com/>`_: Shared Ansys software components to enable package interoperability and minimize maintenance.
 
 Much effort is underway to continue expanding and developing packages in the
@@ -80,6 +81,7 @@ By default, the PyAnsys metapackage installs these core modules:
 - `PySystemCoupling`_
 - `PyTwin`_
 - `Granta MI BoM Analytics`_
+- `Granta MI RecordLists`_
 - `Shared Components`_
 
 Additionally, the ``pyansys`` metapackage contains certain extra targets that

doc/source/api.rst

@@ -130,7 +130,13 @@ PyAnsys packages API reference
 
     .. grid-item-card:: Granta MI BoM Analytics
       :img-top: _static/thumbnails/intro.png
-      :link: https://bomanalytics.grantami.docs.pyansys.com/version/1.1/index.html
+      :link: https://bomanalytics.grantami.docs.pyansys.com/version/1.1/api/index.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
+    .. grid-item-card:: Granta MI RecordLists
+      :img-top: _static/thumbnails/intro.png
+      :link: https://recordlists.grantami.docs.pyansys.com/version/stable/api/index.html
       :text-align: center
       :class-title: pyansys-card-title
 

doc/source/examples.rst

@@ -123,6 +123,12 @@ PyAnsys packages examples
       :text-align: center
       :class-title: pyansys-card-title
 
+    .. grid-item-card:: Granta MI RecordLists
+      :img-top: _static/thumbnails/intro.png
+      :link: https://recordlists.grantami.docs.pyansys.com/version/stable/examples/index.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
     .. grid-item-card:: Shared Components - OpenAPI Common
       :img-top: _static/thumbnails/intro.png
       :link: https://openapi.docs.pyansys.com/index.html#brief-example

doc/source/index.rst

@@ -168,6 +168,14 @@ it is now a collection of many Python packages for using Ansys products through
 
       Pythonic interface to Ansys Granta MI BoM Analytics services
 
+    .. grid-item-card:: Granta MI RecordLists
+      :img-top: _static/thumbnails/intro.png
+      :link: https://recordlists.grantami.docs.pyansys.com/version/stable/
+      :text-align: center
+      :class-title: pyansys-card-title
+
+      Pythonic interface to Ansys Granta MI Lists API
+
     .. grid-item-card:: Shared Components
       :img-top: _static/thumbnails/intro.png
       :link: https://shared.docs.pyansys.com/

doc/source/user_guide.rst

@@ -126,6 +126,12 @@ PyAnsys packages user guides
       :text-align: center
       :class-title: pyansys-card-title
 
+    .. grid-item-card:: Granta MI RecordLists
+      :img-top: _static/thumbnails/intro.png
+      :link: https://recordlists.grantami.docs.pyansys.com/version/stable/getting_started/index.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
     .. grid-item-card:: Shared Components - OpenAPI Common
       :img-top: _static/thumbnails/intro.png
       :link: https://openapi.docs.pyansys.com/index.html

pyproject.toml

@@ -35,6 +35,7 @@ dependencies = [
     "pyaedt==0.6.76",
     "ansys-platform-instancemanagement==1.1.1",
     "ansys-grantami-bomanalytics==1.1.3",
+    "ansys-grantami-recordlists==1.0.0",
     "ansys-openapi-common==1.2.1",
     "ansys-seascape==0.2.0",
     "ansys-meshing-prime==0.3.2",