mypy, ty for types, ruff for docs

.github/workflows/ci-pipeline.yml

@@ -11,9 +11,15 @@ on:
 
 jobs:
   codestyle:
-    name: ruff codestyle check/linting
+    name: codestyle check/linting (${{ matrix.tool }})
     runs-on: ubuntu-latest
 
+    continue-on-error: true
+    strategy:
+      fail-fast: false
+      matrix:
+        tool: [ruff, ty]
+
     steps:
       - name: checkout code
         uses: actions/checkout@v4
@@ -24,14 +30,25 @@ jobs:
           python-version: 3.11
 
       - name: install ruff
-        run: pip install ruff
+        if: matrix.tool == 'ruff'
+        run: pip install ruff==0.14.2
 
       - name: run ruff linter src directory
+        if: matrix.tool == 'ruff'
         run: ruff check hololinked
 
       - name: run ruff linter tests directory
+        if: matrix.tool == 'ruff'
         run: ruff check tests/*.py tests/things/*.py tests/helper-scripts/*.py
 
+      - name: install ty
+        if: matrix.tool == 'ty'
+        run: pip install ty==0.0.24
+
+      - name: run ty type checker
+        if: matrix.tool == 'ty'
+        run: ty check hololinked
+
   scan:
     name: security scan (${{ matrix.tool }})
     runs-on: ubuntu-latest

hololinked/__init__.py

@@ -1,3 +1,5 @@
+"""beginner friendly data acquisition and IoT in python."""
+
 __version__ = "0.3.12"
 
 from .config import global_config  # noqa

hololinked/client/__init__.py

@@ -1,3 +1,5 @@
+"""expose client objects per protocol using the Thing Description."""
+
 from ..config import global_config  # noqa: F401
 from .factory import ClientFactory as ClientFactory
 from .proxy import ObjectProxy as ObjectProxy