[Python SDK] Improve network configurability and add observable type (#749)

* Major refactor to support any combination of network interfaces for WirelessGoPro
* Add observable / observer base type and use for asynchronous push notification operations
* Maintain database of COHN credentials
* Remove Python 3.10 and add 3.13 support

Author: tcamise-gpsw

.github/workflows/github-pages.yml

@@ -121,16 +121,16 @@ jobs:
               shell: bash
               run: sudo apt-get update && sudo apt install -y graphviz
 
-            - name: Set up Python 3.12.8
+            - name: Set up Python 3.13.3
               uses: actions/setup-python@v5
               with:
-                  python-version: 3.12.8
+                  python-version: 3.13.3
 
             - name: Restore cached pip environment
               uses: actions/cache@v4
               with:
                   path: ${{ matrix.path }}
-                  key: ${{ runner.os }}-3.12.8-pip-${{ hashFiles('demos/python/sdk_wireless_camera_control/poetry.lock') }}
+                  key: ${{ runner.os }}-3.13.3-pip-${{ hashFiles('demos/python/sdk_wireless_camera_control/poetry.lock') }}
                   restore-keys: |
                       ${{ runner.os }}-pip-
 

.github/workflows/publish_python_sdk.yml

@@ -14,10 +14,10 @@ jobs:
             - name: Checkout repository
               uses: actions/checkout@v4
 
-            - name: Set up Python 3.12.8
+            - name: Set up Python 3.13.3
               uses: actions/setup-python@v5
               with:
-                  python-version: 3.12.8
+                  python-version: 3.13.3
 
             - name: Install poetry
               uses: abatilo/actions-poetry@v4

.github/workflows/python_sdk_test.yml

@@ -21,7 +21,7 @@ jobs:
         strategy:
             matrix:
                 os: [windows-latest, macos-latest, ubuntu-latest]
-                python-version: ['3.10', '3.11', '3.12']
+                python-version: ['3.11', '3.12', '3.13']
                 include:
                     - os: ubuntu-latest
                       path: ~/.cache/pip
@@ -65,9 +65,9 @@ jobs:
 
             # Only test docs with latest Python on ubuntu since we need graphviz
             - name: Full linting only on ubuntu with latest python
-              if: matrix.os == 'ubuntu-latest' &&  matrix.python-version == '3.12'
+              if: matrix.os == 'ubuntu-latest' &&  matrix.python-version == '3.13'
               working-directory: ./demos/python/sdk_wireless_camera_control/
-              run: nox -p 3.12 -s format lint docstrings docs
+              run: nox -p 3.13 -s format lint docstrings docs
 
             - name: Archive test report on failure
               uses: actions/upload-artifact@v4

demos/python/sdk_wireless_camera_control/.gitignore

@@ -1,6 +1,8 @@
+**/*db.json
 **/*.crt
 **/*.jpg
 **/*.mp4
+**/*.gpmf
 **/temp
 
 # Docs output

demos/python/sdk_wireless_camera_control/.python-version

@@ -1 +1 @@
-3.12.8
+3.13.3

demos/python/sdk_wireless_camera_control/README.md

@@ -42,7 +42,7 @@ Complete documentation can be  found on [Open GoPro](https://gopro.github.io/Ope
 
 ## Installation
 
-> Note! This package requires Python >= 3.10 and < 3.13 and only supports GoPros that
+> Note! This package requires Python >= 3.11 and < 3.14 and only supports GoPros that
 > [implement the OGP API](https://gopro.github.io/OpenGoPro/ble/#supported-cameras)
 
 The minimal install to use the Open GoPro library and the CLI demos is:

demos/python/sdk_wireless_camera_control/TODO.md

@@ -1,32 +1,10 @@
-
-# TODO
-
-## General
-
--   [ ] Generate BLE and HTTP API from specs (OpenAPI, protobuf, etc.)
--   [ ] Better handle kwargs that match base dict args in command as_dict methods
--   [ ] More test coverage
--   [ ] Clean up artifacts after testing. Or use temp directory.
--   [ ] Make scalable for multiple simultaneous cameras
--   [ ] Allow encoding = False for Set Livestream Mode. Requires tracking livestream state to not pend on encoding started after sending Set Shutter On
--   [ ] Add textual TUI
-
-## Documentation
-
--   [ ] Figure out autodoc type alias in `conf.py`
--   [ ] Make graphviz requirement optional for local builds
-
-## BLE
-
--   [ ] Add services view to GattDB
--   [ ] Make bleak wrapper write with / without response configurable
--   [ ] Add option to read values during service discovery
-
-## WiFi
-
--   [ ] Investigate MacOS delay after connecting WiFi
--   [ ] More Linux testing
--   [ ] Use descriptors for main driver access to OS-driver implementation
--   [ ] Move to program language (C?) instead of EN-US
-
-
+# TODO
+
+## Rearchitecture
+
+- One GoPro object; not wired and wireless
+- Connections can be added / removed at any time; not just configured at instantiation
+- all constants, protos, settings, etc. should come from one import
+- create per-endpoint, etc operations that mux between BLE and HTTP
+  - same for settings. HTTP should be able to get an individual setting.
+- Inject database interface to remove TinyDB dependency

demos/python/sdk_wireless_camera_control/docs/api.rst

@@ -73,17 +73,24 @@ These should not be imported directly and instead should be accessed using the r
 .. autoclass:: open_gopro.api.http_settings.HttpSettings
    :show-inheritance:
 
+Abstracted Features
+-------------------
+
+.. automodule:: open_gopro.features.cohn_feature
+
+.. automodule:: open_gopro.features.access_point_feature
+
 Base Types
 ----------
 
-.. automodule:: open_gopro.types
+.. automodule:: open_gopro.domain.types
 
 GoPro Enum
 ^^^^^^^^^^
 
-.. autoclass:: open_gopro.enum.GoProEnum
+.. autoclass:: open_gopro.domain.enum.GoProEnum
 
-.. autoclass:: open_gopro.enum.GoProIntEnum
+.. autoclass:: open_gopro.domain.enum.GoProIntEnum
 
 BLE Setting
 ^^^^^^^^^^^
@@ -121,25 +128,38 @@ Message Bases
 These are the base types that are used to implement version-specific API's. These are published for reference
 but the end user should never need to use these directly.
 
-.. autoclass:: open_gopro.communicator_interface.Message
+.. autoclass:: open_gopro.domain.communicator_interface.Message
    :show-inheritance:
 
-.. autoclass:: open_gopro.communicator_interface.HttpMessage
+.. autoclass:: open_gopro.domain.communicator_interface.HttpMessage
    :show-inheritance:
 
-.. autoclass:: open_gopro.communicator_interface.BleMessage
+.. autoclass:: open_gopro.domain.communicator_interface.BleMessage
    :show-inheritance:
 
-.. autoclass:: open_gopro.communicator_interface.Messages
+.. autoclass:: open_gopro.domain.communicator_interface.Messages
    :show-inheritance:
 
-.. autoclass:: open_gopro.communicator_interface.BleMessages
+.. autoclass:: open_gopro.domain.communicator_interface.BleMessages
    :show-inheritance:
 
-.. autoclass:: open_gopro.communicator_interface.HttpMessages
+.. autoclass:: open_gopro.domain.communicator_interface.HttpMessages
    :show-inheritance:
 
-.. autoclass:: open_gopro.communicator_interface.MessageRules
+.. autoclass:: open_gopro.domain.communicator_interface.MessageRules
+
+Observables
+^^^^^^^^^^^
+
+.. automodule:: open_gopro.domain.observable
+   :show-inheritance:
+
+.. autoclass:: open_gopro.domain.gopro_observable.GoproObserverDistinctInitial
+   :show-inheritance:
+
+.. autoclass:: open_gopro.domain.gopro_observable.GoProObservable
+   :show-inheritance:
+   :inherited-members:
 
 Responses
 =========
@@ -190,6 +210,8 @@ These are the various models that are returned in responses, used in commands, e
 
 .. autopydantic_model:: open_gopro.models.general.SupportedOption
 
+.. autopydantic_model:: open_gopro.models.general.CohnInfo
+
 .. autoclass:: open_gopro.models.general.ScheduledCapture
 
 Constants
@@ -201,60 +223,60 @@ These can be imported as:
 
    from open_gopro import constants
 
-.. automodule:: open_gopro.constants
+.. automodule:: open_gopro.models.constants
    :undoc-members:
    :exclude-members: CmdType, GoProEnumMeta, GoProFlagEnum, ProducerType, ResponseType, enum_factory
 
-.. automodule:: open_gopro.constants.constants
+.. automodule:: open_gopro.models.constants.constants
    :undoc-members:
 
-.. automodule:: open_gopro.constants.settings
+.. automodule:: open_gopro.models.constants.settings
    :undoc-members:
 
-.. automodule:: open_gopro.constants.statuses
+.. automodule:: open_gopro.models.constants.statuses
    :undoc-members:
 
 Exceptions
 ==========
 
-.. automodule:: open_gopro.exceptions
+.. automodule:: open_gopro.domain.exceptions
    :undoc-members:
 
 Common Interface
 ================
 
-.. automodule:: open_gopro.parser_interface
+.. automodule:: open_gopro.domain.parser_interface
 
 .. autoclass:: open_gopro.gopro_base.GoProBase
 
-.. autoclass:: open_gopro.communicator_interface.GoProBle
+.. autoclass:: open_gopro.domain.communicator_interface.GoProBle
 
-.. autoclass:: open_gopro.communicator_interface.GoProHttp
+.. autoclass:: open_gopro.domain.communicator_interface.GoProHttp
 
-.. autoclass:: open_gopro.communicator_interface.GoProWifi
+.. autoclass:: open_gopro.domain.communicator_interface.GoProWifi
 
-.. autoclass:: open_gopro.communicator_interface.GoProWiredInterface
+.. autoclass:: open_gopro.domain.communicator_interface.GoProWiredInterface
 
-.. autoclass:: open_gopro.communicator_interface.GoProWirelessInterface
+.. autoclass:: open_gopro.domain.communicator_interface.GoProWirelessInterface
 
-.. autoclass:: open_gopro.communicator_interface.BaseGoProCommunicator
+.. autoclass:: open_gopro.domain.communicator_interface.BaseGoProCommunicator
 
 
 BLE Interface
 =============
 
-.. automodule:: open_gopro.ble.controller
+.. automodule:: open_gopro.network.ble.controller
 
-.. automodule:: open_gopro.ble.client
+.. automodule:: open_gopro.network.ble.client
 
 BLEServices
 -----------
 
-.. automodule:: open_gopro.ble.services
+.. automodule:: open_gopro.network.ble.services
 
 WiFi Interface
 ==============
 
-.. automodule:: open_gopro.wifi.controller
+.. automodule:: open_gopro.network.wifi.controller
 
-.. automodule:: open_gopro.wifi.client
+.. automodule:: open_gopro.network.wifi.client

demos/python/sdk_wireless_camera_control/docs/changelog.rst

@@ -9,6 +9,14 @@ All notable changes to this project will be documented in this file.
 The format is based on `Keep a Changelog <https://keepachangelog.com/en/1.0.0/>`_,
 and this project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`_.
 
+0.20.0 (May-12-2025)
+--------------------
+* NOTE! This is a major update and includes breaking API changes
+* Major refactor to support any combination of network interfaces for WirelessGoPro
+* Add observable / observer base type and use for asynchronous push notification operations
+* Maintain database of COHN credentials
+* Remove Python 3.10 and add 3.13 support
+
 0.19.8 (April-30-2025)
 ----------------------
 * Default ainput printer arg to None to support non-terminal applications without access to stdout