From baf29fbc3be8444ec6accca789445e54e579f4a0 Mon Sep 17 00:00:00 2001
From: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com>
Date: Mon, 19 Jun 2023 13:17:14 +0200
Subject: [PATCH] feat: adding grantami-recordlists
---
.github/workflows/create-milestone.yml | 41 +++++++++++++-------------
README.rst | 2 ++
doc/source/api.rst | 8 ++++-
doc/source/examples.rst | 6 ++++
doc/source/index.rst | 8 +++++
doc/source/user_guide.rst | 6 ++++
pyproject.toml | 1 +
7 files changed, 51 insertions(+), 21 deletions(-)
diff --git a/.github/workflows/create-milestone.yml b/.github/workflows/create-milestone.yml
index 61194680..77c92f6e 100644
--- a/.github/workflows/create-milestone.yml
+++ b/.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
diff --git a/README.rst b/README.rst
index cbffc94b..4629253c 100644
--- a/README.rst
+++ b/README.rst
@@ -55,6 +55,7 @@ The ``pyansys`` metapackage ensures compatibility between these PyAnsys packages
- `PySystemCoupling `_: Pythonic interface to communicate with Ansys System Coupling.
- `PyTwin `_: Pythonic interface to communicate with consumption workflows for Ansys digital twins.
- `Granta MI BoM Analytics `_: Pythonic interface to Ansys Granta MI BoM Analytics services.
+- `Granta MI RecordLists `_: Pythonic interface to Ansys Granta MI Lists API.
- `Shared Components `_: 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
diff --git a/doc/source/api.rst b/doc/source/api.rst
index dffb3a6f..e4e6aac7 100644
--- a/doc/source/api.rst
+++ b/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/stable/index.html
+ :link: https://bomanalytics.grantami.docs.pyansys.com/version/stable/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
diff --git a/doc/source/examples.rst b/doc/source/examples.rst
index a2288cd4..259f1cab 100644
--- a/doc/source/examples.rst
+++ b/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
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 699b6c75..609705a4 100644
--- a/doc/source/index.rst
+++ b/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/
diff --git a/doc/source/user_guide.rst b/doc/source/user_guide.rst
index 1ec945d2..9cb77a4d 100644
--- a/doc/source/user_guide.rst
+++ b/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
diff --git a/pyproject.toml b/pyproject.toml
index 0bd97a63..fe470a40 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -35,6 +35,7 @@ dependencies = [
"pyaedt==0.6.80",
"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",