Upgrade to Kodi 20 (#23)

* refactor: PEP8

* refactor: update manifest and resources

* refactor: move lib inside resources

* refactor: more PEP8

* refactor: start to use dependency injection

* feat: rewrite for kodi 21

* ci: fix workflow

* ci: fix workflow

* build: add pre-commit lint and typecheck

* refactor: lint, use protocols

* refactor: reformat settings

* fix: working settings setters

* fix: wrong ssdp discovery

* fix version and workflow

* build: add check script to pipenv

* feat: add multiple instances handling

closes #18

* feat: add audio capture component

* fix: single instance components

Author: sanzoghenzo

.github/workflows/publish-addon.yml

@@ -0,0 +1,45 @@
+name: Check and publish addon
+
+on: [push]
+
+env:
+  ADDON_NAME: script.service.hyperion-control
+  TARGET_KODI_VER: nexus
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python 3.11
+      uses: actions/setup-python@v2
+      with:
+        python-version: "3.11"
+    - name: Install addon checker
+      run: |
+        pip install -q kodi-addon-checker
+    - name: Check with addon-checker
+      run: |
+        kodi-addon-checker --branch $TARGET_KODI_VER --allow-folder-id-mismatch .
+
+  publish:
+    runs-on: ubuntu-latest
+
+    needs: check
+    if: github.ref_type == 'tag'
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python 3.11
+      uses: actions/setup-python@v2
+      with:
+        python-version: "3.11"
+    - name: Install addon submitter
+      run: |
+        pip install -q git+https://github.com/xbmc/kodi-addon-submitter.git
+    - name: Submit addon
+      run: |
+        submit-addon -r repo-scripts -b $TARGET_KODI_VER -s --pull-request $ADDON_NAME
+      env:
+        GH_USERNAME: ${{ github.actor }}
+        GH_TOKEN: ${{ secrets.GH_TOKEN }}
+        EMAIL: ""

.gitignore

@@ -8,3 +8,5 @@ Desktop.ini
 # python
 *.pyo
 __pycache__
+.idea
+Pipfile.lock

.pre-commit-config.yaml

@@ -0,0 +1,33 @@
+default_language_version:
+  python: python3
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.3.0
+    hooks:
+      - id: check-toml
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: check-added-large-files
+  - repo: https://github.com/executablebooks/mdformat
+    rev: 0.7.16
+    hooks:
+      - id: mdformat
+        exclude: CHANGELOG.md
+        additional_dependencies:
+          - mdformat-black
+          - mdformat-frontmatter
+          - mdformat-admon
+  - repo: https://github.com/psf/black
+    rev: 22.10.0
+    hooks:
+      - id: black
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: 'v0.0.252'
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: 'v1.4.1'
+    hooks:
+    -   id: mypy

Pipfile

@@ -0,0 +1,18 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+
+[dev-packages]
+kodistubs = "*"
+kodi-addon-checker = "*"
+
+[requires]
+python_version = "3.11"
+
+[scripts]
+pre-commit = "pre-commit install"
+lint = "pre-commit run --all"
+check = "kodi-addon-checker --branch nexus --allow-folder-id-mismatch ."

README.md

@@ -8,6 +8,7 @@ Hyperion Control is an addon for Kodi Mediacenter that observes Kodi events (pla
 For example playing a video should enable screen capture, if you pause the video or you are at the Kodi menu the screen capture should be disabled to show a background effect as mood light
 
 ### Features
+
 - Supports various Hyperion components
 - Setup wizard with Hyperion Server detection (zero configuration)
 - Token Authorization (optional)
@@ -16,9 +17,11 @@ For example playing a video should enable screen capture, if you pause the video
 - Execute from settings dialog: Hyperion Server detection
 
 ### Installation
+
 - Download .zip from release page and use "Install from zip file" dialog at the Kodi addons section.
 
 ### Credits
+
 - Dan Krause for the SSDP client
 - Paulchen-Panther for service development
 - brindosch for service development

addon.xml

@@ -1,28 +1,27 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<addon id="script.service.hyperion-control" name="Hyperion Control" version="19.0.2" provider-name="hyperion-project">
+<addon id="script.service.hyperion-control" name="Hyperion Control" version="20.0.0" provider-name="hyperion-project">
   <requires>
-	<import addon="xbmc.addon"  version="17.0.0"/>
-    <import addon="xbmc.python" version="3.0.0"/>
-	<import addon="script.module.simplejson" version="3.3.0"/>
-	<import addon="script.module.httplib2" version="0.8.0"/>
+	<import addon="xbmc.addon"  version="20.0.0"/>
+    <import addon="xbmc.python" version="3.0.1"/>
+    <import addon="script.module.requests" version="2.3.0"/>
   </requires>
-  <extension point="xbmc.service" library="service.py" start="login">
-    <provides>service</provides>
-  </extension>
+  <extension point="xbmc.service" library="service.py"/>
   <extension point="xbmc.addon.metadata">
     <summary lang="en_GB">Control Hyperion Ambilight</summary>
     <summary lang="de_DE">Hyperion Ambilight Steuerung</summary>
     <description lang="en_GB">Enable and disable components (like capture) of Hyperion automatically based on playing/screensaver state of Kodi[CR]-Supports auto detection of Hyperion Servers[CR]-Token authentication</description>
     <description lang="de_DE">Aktiviere und deaktiviere automatisch Hyperion Komponenten basierend auf dem aktuellen Kodi Status[CR]-Unterstützt Hyperion Server suche[CR]-Token Autorisierung</description>
-    <disclaimer lang="en_GB"></disclaimer>
-    <language></language>
+    <language>en de es fr hu pl</language>
     <platform>all</platform>
     <license>MIT</license>
     <forum>https://hyperion-project.org/forum</forum>
-    <website>https://www.hyperion-project.org</website>
-    <email></email>
+    <website>https://hyperion-project.org/forum</website>
     <source>https://github.com/hyperion-project/hyperion.control</source>
     <news>
+      20.0.0
+      - Kodi 20 (Nexus) support
+      - major refactor to adhere to SOLID principles
+
       19.0.2
       - New languages: Español, Français, Polski
 
@@ -39,9 +38,9 @@
       - Fixed issue where kodi api does not properly announce video playing states
     </news>
 	<assets>
-		<icon>resources/media/icon.png</icon>
-		<fanart>resources/media/fanart.png</fanart>
-		<screenshot>resources/media/screenshot-01.png</screenshot>
+		<icon>resources/icon.png</icon>
+		<fanart>resources/fanart.png</fanart>
+		<screenshot>resources/screenshot-01.png</screenshot>
 	</assets>
   </extension>
 </addon>