feat(vtk): add tool for displaying rendering capabilities

Author: jourdain

docs/api/source/index.rst

@@ -42,5 +42,6 @@ Welcome to Trame's documentation!
    tools.app
    tools.widgets
    tools.serve
+   tools.vtk
 
 .. include:: ../../../README.rst

docs/api/source/tools.vtk.rst

@@ -0,0 +1,17 @@
+VTK rendering backend information
+====================================
+
+This utility function/app depends on VTK and will report the rendering capabilities available.
+
+This aim to be used for debugging cloud deployments either by running a command line within the deployment environment or as a standalone trame application. 
+
+.. code-block:: bash
+
+    # print report to stdout
+    python -m trame.tools.vtk --stdout
+
+    # start trame app
+    python -m trame.tools.vtk
+
+
+You can find its configuration as standalone application `here <https://github.com/Kitware/trame/tree/master/examples/deploy/docker/RenderingInfo>`_ 

examples/deploy/docker/RenderingInfo/Dockerfile

@@ -0,0 +1,5 @@
+FROM kitware/trame:py3.10-glvnd
+
+COPY --chown=trame-user:trame-user . /deploy
+
+RUN /opt/trame/entrypoint.sh build

examples/deploy/docker/RenderingInfo/README.md

@@ -0,0 +1,30 @@
+# Disclaimer
+
+The current example rely trame.tools.vtk to display rendering capabilities of your server.
+
+# Build the image
+
+```bash
+docker build -t trame-vtk-info .
+```
+
+# Run the image on port 8080
+
+```bash
+docker run -it --rm -p 8080:80 trame-vtk-info
+```
+
+# Deploying into CapRover
+
+If that directory was at the root of a git repo you could run the following command line
+
+```bash
+caprover deploy
+```
+
+That app could also be deployed by running the following set of commands
+
+```bash
+tar -cvf trame-vtk-info.tar captain-definition Dockerfile setup
+caprover deploy -t trame-vtk-info.tar
+```

examples/deploy/docker/RenderingInfo/captain-definition

@@ -0,0 +1,4 @@
+{
+  "schemaVersion": 2,
+  "dockerfilePath": "./Dockerfile"
+}

examples/deploy/docker/RenderingInfo/setup/apps.yml

@@ -0,0 +1,12 @@
+trame:
+  cmd:
+    - python
+    - -m
+    - trame.tools.vtk
+    - --host
+    - ${host}
+    - --port
+    - ${port}
+    - --authKey
+    - ${secret}
+    - --server

examples/deploy/docker/RenderingInfo/setup/requirements.txt

@@ -0,0 +1,2 @@
+trame
+vtk

trame/tools/vtk.py

@@ -0,0 +1,41 @@
+import sys
+from trame.app import TrameApp
+from trame.ui.html import DivLayout
+from trame.widgets import html
+
+
+def get_rendering_information():
+    try:
+        import vtk
+
+        renderer = vtk.vtkRenderer()
+        render_window = vtk.vtkRenderWindow()
+        render_window.AddRenderer(renderer)
+        render_window.Render()
+
+        return render_window.ReportCapabilities()
+
+    except ImportError:
+        return "VTK is not available"
+
+
+class VtkRenderingInfo(TrameApp):
+    def __init__(self, server=None):
+        super().__init__(server)
+
+        with DivLayout(self.server) as self.ui:
+            html.Pre("{{ report }}")
+
+        self.state.report = get_rendering_information()
+
+
+def main():
+    app = VtkRenderingInfo()
+    app.server.start()
+
+
+if __name__ == "__main__":
+    if "--stdout" in sys.argv:
+        print(get_rendering_information())
+    else:
+        main()