feat: add protoc helper (#363)

* feat: add protoc helper

* fix: missing entry

* fix: only under Python 3.10

* feat: skip from metapackage

Author: RobPasMue

.github/workflows/create-milestone.yml

@@ -49,6 +49,7 @@ jobs:
             "ansys/pyfluent-visualization",
             # TOOLS
             "ansys/ansys-tools-path",
+            "ansys/ansys-tools-protoc-helper",
             "ansys/pyansys-tools-report",
             "ansys/pyansys-tools-versioning",
             "ansys/pyansys-units",

README.rst

@@ -66,6 +66,7 @@ The ``pyansys`` metapackage ensures compatibility between these PyAnsys packages
 Other tools delivered as part of the metapackage are:
 
 - `Ansys Tools Path <https://path.tools.docs.pyansys.com/>`_: Library to locate Ansys products in a local machine.
+- `Ansys Tools Protobuf Compilation Helper <https://ansys.github.io/ansys-tools-protoc-helper/>`_: Utility library to compile ``.proto`` files to Python source when building the package wheel.
 - `PyAnsys Tools Report <https://report.tools.docs.pyansys.com/>`_:  Tool for reporting your Python environment's package versions and hardware resources in a standardized way.
 - `PyAnsys Tools Versioning <https://versioning.tools.docs.pyansys.com/>`_: Tool for backwards and forwards server support.
 - `PyAnsys Units <https://units.docs.pyansys.com/>`_: Pythonic interface for units, unit systems, and unit conversions.
@@ -106,7 +107,7 @@ can be installed upon request:
 
 - **mapdl-all**: This target installs the core packages and `PyMAPDL Reader`_.
 - **fluent-all**: This target installs the core packages, `PyFluent - Parametric`_, and `PyFluent - Visualization`_.
-- **tools**: This target installs the core packages, `Ansys Tools Path`_, `PyAnsys Tools Versioning`_, `PyAnsys Tools Report`_, and `PyAnsys Units`_.
+- **tools**: This target installs the core packages, `Ansys Tools Path`_, `Ansys Tools Protobuf Compilation Helper`_, `PyAnsys Tools Versioning`_, `PyAnsys Tools Report`_, and `PyAnsys Units`_.
 - **all**: This target installs all extra ``pyansys`` packages.
 
 Package installation

doc/source/tools/libraries/index.rst

@@ -12,6 +12,15 @@ Tooling libraries
 
       Library to locate Ansys products in a local machine
 
+    .. grid-item-card:: Ansys Tools Protobuf Compilation Helper
+      :img-top: ../../_static/thumbnails/intro.png
+      :link: https://ansys.github.io/ansys-tools-protoc-helper/
+      :text-align: center
+      :class-title: pyansys-card-title
+      :margin: 2 2 0 0
+
+      Utility library to compile ``.proto`` files to Python source when building the package wheel
+
     .. grid-item-card:: PyAnsys Tools Report
       :img-top: ../../_static/thumbnails/intro.png
       :link: https://report.tools.docs.pyansys.com/version/stable

pyproject.toml

@@ -75,6 +75,7 @@ all =  [
     # TOOLS
     "ansys-units==0.1.0",
     "ansys-tools-path==0.3.1",
+    # "ansys-tools-protoc-helper==0.4.0; python_version<='3.10'",
     "pyansys-tools-report==0.6.0",
     "pyansys-tools-versioning==0.4.0",
 ]

tools/links.py

@@ -53,6 +53,7 @@
     # TOOLS
     "ansys-units": "https://units.docs.pyansys.com/version/stable",
     "ansys-tools-path": "https://path.tools.docs.pyansys.com/version/stable",
+    "ansys-tools-protoc-helper": None,
     "pyansys-tools-report": "https://report.tools.docs.pyansys.com/version/stable",  # noqa: E501
     "pyansys-tools-versioning": "https://versioning.tools.docs.pyansys.com/version/stable",  # noqa: E501
 }