Add ni-grpc-extensions package

.github/workflows/CI.yml

@@ -14,6 +14,9 @@ jobs:
     strategy:
       matrix:
         include:
+          - package-name: ni-grpc-extensions
+            proto-subpath: ''
+            output-format: ''
           - package-name: ni.grpcdevice.v1.proto
             proto-basepath: ../../proto
             proto-subpath: .

.github/workflows/check_package.yml

@@ -29,6 +29,7 @@ on:
 
 jobs:
   check_codegen:
+    if: ${{ inputs.proto-subpath != '' }}
     name: Check codegen for ${{ inputs.package-name }}
     uses: ./.github/workflows/check_codegen.yml
     with:
@@ -41,12 +42,10 @@ jobs:
   check_analyzers:
     name: Check analyzers for ${{ inputs.package-name }}
     uses: ./.github/workflows/check_analyzers.yml
-    needs: [check_codegen]
     with:
       package-name: ${{ inputs.package-name }}
   check_docs:
     name: Check docs for ${{ inputs.package-name }}
     uses: ./.github/workflows/check_docs.yml
-    needs: [check_analyzers]
     with:
       package-name: ${{ inputs.package-name }}

.github/workflows/publish.yml

@@ -30,6 +30,7 @@ on:
             - ni.measurementlink.sessionmanagement.v1.proto
             - ni.panels.v1.proto
             - ni.protobuf.types
+            - ni-grpc-extensions
 
 env:
   environment: ${{ github.event_name == 'release' && 'pypi' || inputs.environment }}

packages/ni-grpc-extensions/.readthedocs.yaml

@@ -0,0 +1,16 @@
+# .readthedocs.yml
+
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.11"
+  jobs:
+    post_create_environment:
+      - pip install poetry==1.8.2
+    post_install:
+      - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry -C packages/ni-grpc-extensions install --only main,docs
+
+sphinx:
+  configuration: packages/ni-grpc-extensions/docs/conf.py

packages/ni-grpc-extensions/README.md

@@ -0,0 +1,20 @@
+# Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [About](#about)
+  - [Operating System Support](#operating-system-support)
+  - [Python Version Support](#python-version-support)
+
+# About
+
+`ni-grpc-extensions` is a Python package that provides channel pool handling for gRPC communication.
+
+NI created and supports this package.
+
+## Operating System Support
+
+``ni-grpc-extensions` supports Windows and Linux operating systems.
+
+## Python Version Support
+
+``ni-grpc-extensions` supports CPython 3.9+.

packages/ni-grpc-extensions/docs/conf.py

@@ -0,0 +1,92 @@
+"""Sphinx Configuration File."""
+
+import datetime
+import pathlib
+
+import autoapi.extension
+import toml
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "autoapi.extension",
+    "m2r2",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+]
+
+root_path = pathlib.Path(__file__).parent.parent
+pyproj_file = root_path / "pyproject.toml"
+proj_config = toml.loads(pyproj_file.read_text())
+
+
+project = proj_config["tool"]["poetry"]["name"]
+company = "National Instruments"
+copyright = f"2025-%Y, {company}"
+if datetime.datetime.now().year == 2025:
+    copyright = f"%Y, {company}"
+
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+version = proj_config["tool"]["poetry"]["version"]
+release = ".".join(version.split(".")[:2])
+description = proj_config["tool"]["poetry"]["description"]
+
+
+htmlhelp_basename = f"{project}doc"
+
+
+# tell autoapi to doc the public options
+autoapi_options = list(autoapi.extension._DEFAULT_OPTIONS)
+autoapi_options.remove("private-members")  # note: remove this to include "_" members in docs
+autoapi_dirs = [
+    root_path / "src" / "ni_grpc_extensions",
+]
+autoapi_python_use_implicit_namespaces = True
+autoapi_template_dir = "templates/autoapi"
+autoapi_python_class_content = "both"
+autoapi_type = "python"
+autodoc_typehints = "description"
+autoapi_file_patterns = ["*.pyi", "*.py"]
+autoapi_ignore = [
+    '**/__init__.py',
+]
+
+
+def setup(sphinx):
+    """Sphinx setup callback."""
+    pass
+
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "__init__.py"]
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+    "grpc": ("https://grpc.github.io/grpc/python/", None),
+}
+
+
+# -- Options for HTML output ----------------------------------------------
+
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+#
+html_theme = "sphinx_rtd_theme"
+html_theme_options = {
+    "navigation_depth": -1,
+}
+
+templates_path = ["templates"]
+
+# Napoleon settings
+napoleon_numpy_docstring = False

packages/ni-grpc-extensions/docs/index.rst

@@ -0,0 +1,22 @@
+##################
+NI gRPC Extensions
+##################
+
+.. include:: intro.inc
+
+Table of Contents
+=================
+
+.. toctree::
+   :maxdepth: 4
+
+   autoapi/index
+   autoapi/ni_grpc_extensions/channelpool/index
+   autoapi/ni_grpc_extensions/loggers/index
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

packages/ni-grpc-extensions/docs/intro.inc

@@ -0,0 +1,25 @@
+Introduction
+============
+
+About
+-----
+
+The ``ni-grpc-extensions`` Python package provides channel pool handling for gRPC communication.
+
+NI created and supports this package.
+
+Operating System Support
+------------------------
+
+``ni-grpc-extensions`` supports Windows and Linux operating systems.
+
+Python Version Support
+----------------------
+
+``ni-grpc-extensions`` supports CPython 3.9+.
+
+Installation
+------------
+
+You can directly install the ``ni-grpc-extensions`` package using ``pip`` or by listing it as a dependency in
+your project's ``pyproject.toml`` file.