The abstract client class

.github/workflows/ci.yml

@@ -57,11 +57,11 @@ jobs:
     strategy:
       matrix:
         python:
-          - "3.8"
           - "3.9"
           - "3.10"
           - "3.11"
-          - "3.12"  # newest Python that is stable
+          - "3.12"
+          - "3.13"  # newest Python that is stable          
         platform:
         - ubuntu-latest
         # - macos-latest
@@ -79,8 +79,7 @@ jobs:
       - name: Run tests
         run: >-
           pipx run --python '${{ steps.setup-python.outputs.python-path }}'
-          tox --installpkg '${{ needs.prepare.outputs.wheel-distribution }}'
-          -- -rFEx --durations 10 --color yes  # pytest args
+          tox --develop
       # - name: Generate coverage report
       #   run: pipx run coverage lcov -o coverage.lcov
       # - name: Upload partial coverage report
@@ -96,11 +95,11 @@ jobs:
     strategy:
       matrix:
         python:
-          - "3.8"
           - "3.9"
           - "3.10"
           - "3.11"
-          - "3.12"  # newest Python that is stable
+          - "3.12"
+          - "3.13"  # newest Python that is stable
         platform:
         - ubuntu-latest
         # - macos-latest
@@ -118,18 +117,18 @@ jobs:
       - name: Run tests
         run: >-
           pipx run --python '${{ steps.setup-python.outputs.python-path }}'
-          tox -e lint --installpkg '${{ needs.prepare.outputs.wheel-distribution }}'
+          tox -e lint --develop
 
   typecheck:
     needs: prepare
     strategy:
       matrix:
         python:
-          - "3.8"
           - "3.9"
           - "3.10"
           - "3.11"
-          - "3.12"  # newest Python that is stable
+          - "3.12"
+          - "3.13"  # newest Python that is stable          
         platform:
         - ubuntu-latest
         # - macos-latest
@@ -147,7 +146,7 @@ jobs:
       - name: Run tests
         run: >-
           pipx run --python '${{ steps.setup-python.outputs.python-path }}'
-          tox -e typecheck --installpkg '${{ needs.prepare.outputs.wheel-distribution }}'
+          tox -e typecheck --develop
 
   finalize:
     needs: [test, lint, typecheck]

.gitignore

@@ -13,4 +13,3 @@ venv
 dist/
 build/
 %LOCALAPPDATA%
-s2-python/src/s2python/specification/s2-pairing/s2-over-ip-pairing.yaml

dev-requirements.txt

@@ -238,6 +238,16 @@ wheel==0.45.1
     # via pip-tools
 zipp==3.20.2
     # via importlib-metadata
+jwskate==0.11.1
+binapy==0.8.0
+    # via jwskate
+cffi==1.17.1
+    # via jwskate
+cryptography==44.0.2
+    # via jwskate
+pycparser==2.22
+    # via jwskate
+types-requests==2.32.0.20250328
 
 # The following packages are considered to be unsafe in a requirements file:
 # pip

pyproject.toml

@@ -12,26 +12,28 @@ version = "0.5.0"
 readme = "README.rst"
 license = "Apache-2.0"
 license-files = ["LICENSE"]
-requires-python = ">=3.8, < 3.13"
+requires-python = ">=3.9, < 3.14"
 dependencies = [
     "pydantic>=2.8.2",
     "pytz",
     "click",
 ]
 classifiers = [
     "Development Status :: 4 - Beta",
-    "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",    
 ]
 [project.urls]
     "Source code" = "https://github.com/flexiblepower/s2-ws-json-python"
 
 [project.optional-dependencies]
 ws = [
     "websockets~=13.1",
+    "jwskate~=0.11",
+    "requests~=2.32.3",
 ]
 fastapi = [
     "fastapi",

specification/s2-over-ip-pairing.yaml

@@ -0,0 +1,136 @@
+openapi: 3.0.3
+info:
+  version: "0.1"
+  title: s2-over-ip pairing and connection initiation
+  description: "Description of the pairing process over IP for S2"
+paths:
+  /requestPairing:
+    post:
+      description: Initiate pairing
+      requestBody:
+        description: TODO
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PairingRequest'
+      responses:
+        '200':
+          description: TODO
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PairingResponse'
+  /requestConnection:
+    post:
+      description: TODO
+      requestBody:
+        description: TODO
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/ConnectionRequest'
+      responses:
+        '200':
+          description: TODO
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ConnectionDetails'      
+components:
+  schemas:
+    PairingInfo:
+      type: object
+      properties:
+        pairingUri:
+          type: string
+          format: uri
+        token:
+          $ref: "#/components/schemas/PairingToken"
+        validUntil:
+          type: string
+          format: date-time
+    PairingRequest:
+      type: object
+      properties:
+        token:
+          $ref: "#/components/schemas/PairingToken"
+        publicKey:
+          type: string
+          format: byte
+        s2ClientNodeId:
+          type: string
+          format: uuid
+        s2ClientNodeDescription:
+          $ref: "#/components/schemas/S2NodeDescription"
+        supportedProtocols:
+          type: array
+          items:
+            $ref: "#/components/schemas/Protocols"
+    PairingResponse:
+      type: object
+      properties:
+        s2ServerNodeId:
+          type: string
+          format: uuid
+        serverNodeDescription:
+          $ref: "#/components/schemas/S2NodeDescription"
+        requestConnectionUri:
+          type: string
+          format: uri
+    ConnectionRequest:
+      type: object
+      properties:
+        s2ClientNodeId:
+          type: string
+          format: uuid
+        supportedProtocols:
+          type: array
+          items:
+            $ref: "#/components/schemas/Protocols"
+    ConnectionDetails:
+      type: object
+      properties:
+        selectedProtocol:
+          $ref: "#/components/schemas/Protocols"  
+        challenge:
+          type: string
+          format: byte
+        connectionUri:
+          type: string
+          format: uri
+    S2NodeDescription:
+      type: object
+      description: TODO nog even over nadenken
+      properties:
+        brand:
+          type: string
+        logoUri:
+          type: string
+          format: uri
+        type:
+          type: string
+        modelName:
+          type: string
+        userDefinedName:
+          type: string
+        role:
+          $ref: "#/components/schemas/S2Role"
+        deployment:
+          $ref: "#/components/schemas/Deployment"
+    Protocols:
+      type: string
+      enum:
+        - WebSocketSecure
+    S2Role:
+      type: string
+      enum:
+        - CEM
+        - RM
+    Deployment:
+      type: string
+      enum:
+        - WAN
+        - LAN
+    PairingToken:
+      type: string
+      pattern: "^[0-9a-zA-Z]{32}$"

src/s2python/__init__.py

@@ -1,3 +1,4 @@
+import sys  # pragma: no cover
 from importlib.metadata import PackageNotFoundError, version  # pragma: no cover
 
 try:
@@ -8,3 +9,6 @@
     __version__ = "unknown"
 finally:
     del version, PackageNotFoundError
+
+    from s2python.communication.s2_connection import S2Connection, AssetDetails   # pragma: no cover
+    sys.modules['s2python.s2_connection'] = sys.modules['s2python.communication.s2_connection'] # pragma: no cover