WORK IN PROGRESS: test linting

.github/workflows/code-qa.yaml

@@ -0,0 +1,23 @@
+name: Code-QA
+
+on: push
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.8.18
+          architecture: x64
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Install deps
+        run: |
+            pip install mypy==1.8.0 pylint==3.2.5 ruff==0.1.14 pylint-protobuf==0.22.0 remotivelabs-broker>=0.1.8 pytest
+      - name: Run lint
+        run: |
+          cd python
+          make
+          cd -

.gitignore

@@ -1,2 +1,3 @@
 .idea
-*.iml
+*.iml
+.venv

.python-version

@@ -0,0 +1 @@
+3.8

python/.gitignore

@@ -1,2 +1,4 @@
 .pyc
-__pycache__
+.venv
+__pycache__
+.*

python/Makefile

@@ -0,0 +1,38 @@
+MAKEFLAGS += -j4 -O
+.DEFAULT_GOAL := lint
+
+.PHONY: lint
+lint: pylint mypy ruff-format ruff
+
+.PHONY: pylint
+pylint:
+	pylint .
+	@echo ""
+
+.PHONY: mypy
+mypy:
+	mypy . --config-file pyproject.toml
+	@echo ""
+
+.PHONY: ruff-format
+ruff-format:
+	ruff format --check --diff
+	@echo ""
+
+.PHONY: ruff
+ruff:
+	ruff check
+	@echo ""
+
+.PHONY: lint-fix
+fix: ruff-fix ruff-format-fix
+
+.PHONY: ruff-fix
+ruff-fix:
+	ruff check --fix
+	@echo ""
+
+.PHONY: ruff-format-fix
+ruff-format-fix:
+	ruff format
+	@echo ""

python/cloud-demo/README.md

@@ -17,7 +17,7 @@ Python 3 is required
 
 ```
 pip3 install -r requirements.txt 
-python3 cloud-demo.py \
+python3 cloud_demo.py \
   --url <url_from_cloud> \
   --api-key <api_key_from_cloud> \
   --signals Speed,SteeringWheel_Position,Accelerator_PedalPosition

python/cloud-demo/cloud_demo.py

@@ -0,0 +1,78 @@
+import signal as signals
+import sys
+import threading
+from argparse import Namespace
+from typing import Any
+
+from lib import arguments
+from lib.broker import Broker
+
+# Simple program designed to be used with our cloud demo.
+# It is expected that you have followed the steps at
+# https://demo.remotivelabs.com and started a broker + uploaded
+# a recording.
+
+# Once you complete the stages in our cloud-demo you will get all
+# information required to run this program. It will look something like:
+
+# python3 cloud_demo.py \
+#      --url <broker_url> \
+#      --api-key <api_key> \
+#      --signals VehicleSpeed,ChassisAcceleratorPedalposition
+
+expected_available_signals = [
+    "VehicleSpeed",
+    "ChassisSteeringwheelAngle",
+    "ChassisAcceleratorPedalposition",
+    "VehicleCurrentlocationLongitude",
+    "VehicleCurrentlocationLatitude",
+]
+
+
+def print_signals(frame: Any) -> None:
+    for s in frame:
+        print(s)
+
+
+def main(argv: Namespace) -> None:
+    print(f"Connecting to {argv.url}")
+
+    broker = Broker(argv.url, argv.api_key, argv.access_token)
+
+    print("Listing available signals")
+    available_signals = broker.list_signal_names()
+    for signal in available_signals:
+        print(f" - {signal}")
+
+    # Sanity check so we are running against the expected recording
+    if available_signals != expected_available_signals:
+        print(
+            "It does not look like you have started the demo recording in cloud. \n"
+            "Make sure you play turning-torso-drivecycle.zip on this broker from "
+            "https://demo.remotivelabs.com/p/demo/brokers"
+        )
+        sys.exit(0)
+
+    # Start subscribe to selected signals
+    subscription = broker.subscribe(signals=argv.signals, on_frame=print_signals, changed_values_only=True)
+
+    # play demo recording
+    broker.play(namespace="custom_can", path="turning-torso-drivecycle.zip")
+
+    # Wait 20 seconds and then shutdown.
+    # Remove the lines below to just have it running
+    sleep(seconds=20)
+
+    print("Cancelling subscription (20 secs or ctr-c, you can change this to just keep it running)")
+    subscription.cancel()
+
+
+def sleep(seconds: float) -> None:
+    lock = threading.Event()
+    signals.signal(signals.SIGINT, lambda signum, frame: lock.set())
+    lock.wait(timeout=seconds)
+
+
+if __name__ == "__main__":
+    args = arguments.parse()
+    main(args)

python/cloud-demo/lib/arguments.py

@@ -1,7 +1,9 @@
+from __future__ import annotations
+
 import argparse
 
 
-def parse(argv):
+def parse() -> argparse.Namespace:
     parser = argparse.ArgumentParser(description="Provide address to RemotiveBroker")
 
     parser.add_argument(
@@ -18,7 +20,7 @@ def parse(argv):
         type=str,
         help="API key is required when accessing brokers running in the cloud",
         required=False,
-        default=None
+        default=None,
     )
 
     parser.add_argument(
@@ -36,7 +38,7 @@ def parse(argv):
         required=False,
         help="Comma separated list of signal names to subscribe on",
         default="Speed",
-        type=lambda s: [item for item in s.split(',')]
+        type=lambda s: list(s.split(",")),
     )
 
     args = parser.parse_args()