Bump version to 2.4.0

[pre-commit.ci] pre-commit autoupdate

.github/ISSUE_TEMPLATE/bug_report.md

@@ -7,12 +7,14 @@ assignees: ''
 
 ---
 
-Before opening an issue make sure that there are no duplicates and that you are on the latest version.
+Before opening an issue make sure that there are no duplicates and that you are
+on the latest version.
 **Describe the bug**
 A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
@@ -25,13 +27,14 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **iSponsorBlockTV server (please complete the following information):**
- - OS: [e.g. Docker on linux Arm64, windows]
- - Python version [e.g. 3.7] (no need to fill if running on docker
+
+- OS: [e.g. Docker on linux Arm64, windows]
+- Python version [e.g. 3.7] (no need to fill if running on docker
 
 **Apple TV (please complete the following information):**
- - Device: [e.g. Apple TV 4]
- - OS: [e.g. tvOS 15.4]
 
+- Device: [e.g. Apple TV 4]
+- OS: [e.g. tvOS 15.4]
 
 **Additional context**
 Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -8,13 +8,15 @@ assignees: ''
 ---
 
 **Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+A clear and concise description of what the problem is. Ex. I'm always
+frustrated when [...]
 
 **Describe the solution you'd like**
 A clear and concise description of what you want to happen.
 
 **Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
+A clear and concise description of any alternative solutions or features you've
+considered.
 
 **Additional context**
 Add any other context or screenshots about the feature request here.

.github/dependabot.yml

@@ -0,0 +1,19 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "docker"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/build_docker_images.yml

@@ -21,6 +21,8 @@ permissions:
 
 jobs:
   build:
+    env:
+        DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
     runs-on: ubuntu-latest
     steps:
       # Get the repository's code
@@ -32,7 +34,9 @@ jobs:
         id: meta
         uses: docker/metadata-action@v5
         with:
-          images: ghcr.io/dmunozv04/isponsorblocktv, dmunozv04/isponsorblocktv
+          images: |
+            ghcr.io/${{ github.repository }}
+            ${{ env.DOCKERHUB_USERNAME && 'dmunozv04/isponsorblocktv' || '' }}
           tags: |
             type=raw,value=develop,priority=900,enable=${{ github.ref == format('refs/heads/{0}', github.event.repository.default_branch) }}
             type=ref,enable=true,priority=600,prefix=pr-,suffix=,event=pr
@@ -64,13 +68,12 @@ jobs:
           password: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Build and push
-        uses: docker/build-push-action@v5
+        uses: docker/build-push-action@v6
         with:
           context: .
           platforms: linux/amd64, linux/arm64, linux/arm/v7
           push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
-          cache-from: type=registry,ref=ghcr.io/dmunozv04/isponsorblocktv:buildcache
-          # Only cache if it's not a pull request
-          cache-to: ${{ github.event_name != 'pull_request' && 'type=registry,ref=ghcr.io/dmunozv04/isponsorblocktv:buildcache,mode=max' || '' }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

.github/workflows/release.yml

@@ -57,7 +57,7 @@ jobs:
 
 
   build-binaries:
-    name: Build binaries for ${{ matrix.job.target }} (${{ matrix.job.os }})
+    name: Build binaries for ${{ matrix.job.release_suffix }} (${{ matrix.job.os }})
     needs:
       - build-sdist-and-wheel
     runs-on: ${{ matrix.job.os }}
@@ -70,20 +70,26 @@ jobs:
           os: ubuntu-latest
           cross: true
           release_suffix: x86_64-linux
+        - target: x86_64-unknown-linux-gnu
+          os: ubuntu-latest
+          cross: true
+          cpu_variant: v1
+          release_suffix: x86_64-linux-v1
         - target: aarch64-unknown-linux-gnu
           os: ubuntu-latest
           cross: true
           release_suffix: aarch64-linux
         # Windows
         - target: x86_64-pc-windows-msvc
-          os: windows-2022
+          os: windows-latest
           release_suffix: x86_64-windows
         # macOS
         - target: aarch64-apple-darwin
-          os: macos-14
+          os: macos-latest
           release_suffix: aarch64-osx
         - target: x86_64-apple-darwin
-          os: macos-12
+          os: macos-latest
+          cross: true
           release_suffix: x86_64-osx
 
     env:
@@ -92,8 +98,9 @@ jobs:
       HATCH_BUILD_LOCATION: dist
       CARGO: cargo
       CARGO_BUILD_TARGET: ${{ matrix.job.target }}
+      PYAPP_DISTRIBUTION_VARIANT_CPU: ${{ matrix.job.cpu_variant }}
       PYAPP_REPO: pyapp # Use local copy of pyapp (needed for cross-compiling)
-      PYAPP_VERSION: v0.23.0
+      PYAPP_VERSION: v0.24.0
 
     steps:
     - name: Checkout

.markdownlintignore

@@ -0,0 +1 @@
+LICENSE.md

.pre-commit-config.yaml

@@ -3,7 +3,7 @@
 # Inspired by textual pre-commit config
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.3.0
+    rev: v5.0.0
     hooks:
       - id: check-ast  # simply checks whether the files parse as valid python
       - id: check-builtin-literals  # requires literal syntax when initializing empty or zero python builtin types
@@ -18,22 +18,14 @@ repos:
       - id: end-of-file-fixer  # ensures that a file is either empty, or ends with one newline
       - id: mixed-line-ending  # replaces or checks mixed line ending
       - id: trailing-whitespace  # checks for trailing whitespace
-  - repo: https://github.com/pycqa/isort
-    rev: 5.12.0
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.10
     hooks:
-      - id: isort
-        name: isort (python)
-        language_version: '3.11'
-        args: ["--profile", "black", "--filter-files"]
-  - repo: https://github.com/psf/black
-    rev: 23.1.0
+      - id: ruff
+        args: [ --fix, --exit-non-zero-on-fix ]
+      - id: ruff-format
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.44.0
     hooks:
-      - id: black
-        language_version: '3.11'
-        args: ["--preview"]
-  - repo: https://github.com/hadialqattan/pycln  # removes unused imports
-    rev: v2.3.0
-    hooks:
-      - id: pycln
-        language_version: "3.11"
-        args: [--all]
+      - id: markdownlint
+        args: ["--fix"]

Dockerfile

@@ -1,5 +1,5 @@
 # syntax=docker/dockerfile:1
-FROM python:3.11-alpine3.19 AS base
+FROM python:3.13-alpine3.21 AS base
 
 FROM base AS compiler
 
@@ -19,9 +19,9 @@ RUN apk add --no-cache gcc musl-dev && \
     pip install -r requirements.txt && \
     pip uninstall -y pip wheel && \
     apk del gcc musl-dev && \
-    python3 -m compileall -b -f /usr/local/lib/python3.11/site-packages && \
-    find /usr/local/lib/python3.11/site-packages -name "*.py" -type f -delete && \
-    find /usr/local/lib/python3.11/ -name "__pycache__" -type d -exec rm -rf {} +
+    python3 -m compileall -b -f /usr/local/lib/python3.13/site-packages && \
+    find /usr/local/lib/python3.13/site-packages -name "*.py" -type f -delete && \
+    find /usr/local/lib/python3.13/ -name "__pycache__" -type d -exec rm -rf {} +
 
 FROM base
 

LICENSE.md

@@ -657,7 +657,7 @@ notice like this when it starts in an interactive mode:
     This is free software, and you are welcome to redistribute it
     under certain conditions; type `show c' for details.
 
-The hypothetical commands `show w' and `show c' should show the appropriate
+The hypothetical commands `show w' and`show c' should show the appropriate
 parts of the General Public License.  Of course, your program's commands
 might be different; for a GUI interface, you would use an "about box".
 

README.md

@@ -1,14 +1,21 @@
 # iSponsorBlockTV
-Skip sponsor segments in YouTube videos playing on a YouTube TV device (see below for compatibility details).
+
+[![ghcr.io Pulls](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fipitio.github.io%2Fbackage%2Fdmunozv04%2FiSponsorBlockTV%2Fisponsorblocktv.json&query=downloads&logo=github&label=ghcr.io%20pulls&style=flat)](https://ghcr.io/dmunozv04/isponsorblocktv)
+[![Docker Pulls](https://img.shields.io/docker/pulls/dmunozv04/isponsorblocktv?logo=docker&style=flat)](https://hub.docker.com/r/dmunozv04/isponsorblocktv/)
+[![GitHub Release](https://img.shields.io/github/v/release/dmunozv04/isponsorblocktv?logo=GitHub&style=flat)](https://github.com/dmunozv04/iSponsorBlockTV/releases/latest)
+[![GitHub Repo stars](https://img.shields.io/github/stars/dmunozv04/isponsorblocktv?style=flat)](https://github.com/dmunozv04/isponsorblocktv)
+
+Skip sponsor segments in YouTube videos playing on a YouTube TV device (see
+below for compatibility details).
 
 This project is written in asynchronous python and should be pretty quick.
 
 ## Installation
+
 Check the [wiki](https://github.com/dmunozv04/iSponsorBlockTV/wiki/Installation)
 
-Warning: docker armv7 builds have been deprecated. Amd64 and arm64 builds are still available.
-
 ## Compatibility
+
 Legend: ✅ = Working, ❌ = Not working, ❔ = Not tested
 
 Open an issue/pull request if you have tested a device that isn't listed here.
@@ -29,24 +36,33 @@ Open an issue/pull request if you have tested a device that isn't listed here.
 | Playstation 4/5    |   ✅    |
 
 ## Usage
-Run iSponsorBlockTV on a computer that has network access.
-Auto discovery will require the computer to be on the same network as the device during setup.
-The device can also be manually added to iSponsorBlockTV with a YouTube TV code. This code can be found in the settings page of your YouTube application.
 
-It connects to the device, watches its activity and skips any sponsor segment using the [SponsorBlock](https://sponsor.ajay.app/) API.
+Run iSponsorBlockTV on a computer that has network access.
+Auto discovery will require the computer to be on the same network as the device
+during setup.
+The device can also be manually added to iSponsorBlockTV with a YouTube TV code.
+This code can be found in the settings page of your YouTube application.
+
+It connects to the device, watches its activity and skips any sponsor segment
+using the [SponsorBlock](https://sponsor.ajay.app/) API.
 It can also skip/mute YouTube ads.
 
 ## Libraries used
-- [pyytlounge](https://github.com/FabioGNR/pyytlounge) Used to interact with the device
+
+- [pyytlounge](https://github.com/FabioGNR/pyytlounge) Used to interact with the
+  device
 - asyncio and [aiohttp](https://github.com/aio-libs/aiohttp)
 - [async-cache](https://github.com/iamsinghrajat/async-cache)
-- [Textual](https://github.com/textualize/textual/) Used for the amazing new graphical configurator
+- [Textual](https://github.com/textualize/textual/) Used for the amazing new
+  graphical configurator
 - [ssdp](https://github.com/codingjoe/ssdp) Used for auto discovery
 
 ## Projects using this project
+
 - [Home Assistant Addon](https://github.com/bertybuttface/addons/tree/main/isponsorblocktv)
 
 ## Contributing
+
 1. Fork it (<https://github.com/dmunozv04/iSponsorBlockTV/fork>)
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
@@ -54,8 +70,13 @@ It can also skip/mute YouTube ads.
 5. Create a new Pull Request
 
 ## Contributors
+
 - [dmunozv04](https://github.com/dmunozv04) - creator and maintainer
-- [HaltCatchFire](https://github.com/HaltCatchFire) - updated dependencies and improved skip logic
-- [Oxixes](https://github.com/oxixes) - added support for channel whitelist and minor improvements
+- [HaltCatchFire](https://github.com/HaltCatchFire) - updated dependencies and
+  improved skip logic
+- [Oxixes](https://github.com/oxixes) - added support for channel whitelist and
+  minor improvements
+
 ## License
+
 [![GNU GPLv3](https://www.gnu.org/graphics/gplv3-127x51.png)](https://www.gnu.org/licenses/gpl-3.0.en.html)

config.json.template

@@ -13,11 +13,11 @@
     "mute_ads": true,
     "skip_ads": true,
     "auto_play": true,
+    "join_name": "iSponsorBlockTV",
     "apikey": "",
     "channel_whitelist": [
         {"id": "",
         "name": ""
         }
-    ],
-    "api_server": "https://sponsor.ajay.app"
+    ]
 }

pyproject.toml

@@ -1,12 +1,12 @@
 [project]
 name = "iSponsorBlockTV"
-version = "2.2.1"
+version = "2.4.0"
 authors = [
     {"name" = "dmunozv04"}
 ]
 description = "SponsorBlock client for all YouTube TV clients"
 readme = "README.md"
-requires-python = ">=3.7"
+requires-python = ">=3.9"
 classifiers = [
     "Programming Language :: Python :: 3",
     "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",

requirements.txt

@@ -1,11 +1,10 @@
-aiohttp==3.9.5
+aiohttp==3.11.13
 appdirs==1.4.4
-argparse==1.4.0
 async-cache==1.1.1
-pyytlounge==2.0.0
-rich==13.7.1
+pyytlounge==2.3.0
+rich==13.9.4
 ssdp==1.3.0
-textual==0.58.0
-textual-slider==0.1.1
-xmltodict==0.13.0
-rich_click==1.8.3
+textual==1.0.0
+textual-slider==0.2.0
+xmltodict==0.14.2
+rich_click==1.8.8

src/iSponsorBlockTV/api_helpers.py

@@ -27,7 +27,6 @@ class ApiHelper:
         self.skip_count_tracking = config.skip_count_tracking
         self.web_session = web_session
         self.num_devices = len(config.devices)
-        self.api_server = config.api_server
 
     # Not used anymore, maybe it can stay here a little longer
     @AsyncLRU(maxsize=10)
@@ -121,7 +120,8 @@ class ApiHelper:
             return (
                 [],
                 True,
-            )  # Return empty list and True to indicate that the cache should last forever
+            )  # Return empty list and True to indicate
+            # that the cache should last forever
         vid_id_hashed = sha256(vid_id.encode("utf-8")).hexdigest()[
             :4
         ]  # Hashes video id and gets the first 4 characters
@@ -131,7 +131,7 @@ class ApiHelper:
             "service": constants.SponsorBlock_service,
         }
         headers = {"Accept": "application/json"}
-        url = self.api_server + "/api/skipSegments/" + vid_id_hashed
+        url = constants.SponsorBlock_api + "skipSegments/" + vid_id_hashed
         async with self.web_session.get(
             url, headers=headers, params=params
         ) as response:
@@ -184,7 +184,7 @@ class ApiHelper:
                     segment_before_start = segments[-1]["start"]
                     segment_before_UUID = segments[-1]["UUID"]
 
-                except Exception:
+                except IndexError:
                     segment_before_end = -10
                 if (
                     segment_dict["start"] - segment_before_end < 1
@@ -193,16 +193,17 @@ class ApiHelper:
                     segment_dict["UUID"].extend(segment_before_UUID)
                     segments.pop()
                 segments.append(segment_dict)
-        except Exception:
+        except BaseException:
             pass
         return segments, ignore_ttl
 
     async def mark_viewed_segments(self, uuids):
-        """Marks the segments as viewed in the SponsorBlock API, if skip_count_tracking is enabled.
+        """Marks the segments as viewed in the SponsorBlock API
+        if skip_count_tracking is enabled.
         Lets the contributor know that someone skipped the segment (thanks)"""
         if self.skip_count_tracking:
             for i in uuids:
-                url = self.api_server + "/api/viewedVideoSponsorTime/"
+                url = constants.SponsorBlock_api + "viewedVideoSponsorTime/"
                 params = {"UUID": i}
                 await self.web_session.post(url, params=params)
 

src/iSponsorBlockTV/conditional_ttl_cache.py

@@ -3,28 +3,29 @@ import datetime
 from cache.key import KEY
 from cache.lru import LRU
 
-"""MIT License
+# MIT License
 
-Copyright (c) 2020 Rajat Singh
+# Copyright (c) 2020 Rajat Singh
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE."""
-"""Modified code from https://github.com/iamsinghrajat/async-cache"""
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+# Modified code from https://github.com/iamsinghrajat/async-cache
 
 
 class AsyncConditionalTTL:

src/iSponsorBlockTV/config_setup.py

@@ -1,202 +1,199 @@
-import asyncio
-
-import aiohttp
-
-from . import api_helpers, ytlounge
-
-# Constants for user input prompts
-ATVS_REMOVAL_PROMPT = (
-    "Do you want to remove the legacy 'atvs' entry (the app won't start"
-    " with it present)? (y/N) "
-)
-PAIRING_CODE_PROMPT = "Enter pairing code (found in Settings - Link with TV code): "
-ADD_MORE_DEVICES_PROMPT = "Paired with {num_devices} Device(s). Add more? (y/N) "
-CHANGE_API_KEY_PROMPT = "API key already specified. Change it? (y/N) "
-ADD_API_KEY_PROMPT = (
-    "API key only needed for the channel whitelist function. Add it? (y/N) "
-)
-ENTER_API_KEY_PROMPT = "Enter your API key: "
-CHANGE_SKIP_CATEGORIES_PROMPT = "Skip categories already specified. Change them? (y/N) "
-ENTER_SKIP_CATEGORIES_PROMPT = (
-    "Enter skip categories (space or comma sepparated) Options: [sponsor,"
-    " selfpromo, exclusive_access, interaction, poi_highlight, intro, outro,"
-    " preview, filler, music_offtopic]:\n"
-)
-WHITELIST_CHANNELS_PROMPT = (
-    "Do you want to whitelist any channels from being ad-blocked? (y/N) "
-)
-SEARCH_CHANNEL_PROMPT = 'Enter a channel name or "/exit" to exit: '
-SELECT_CHANNEL_PROMPT = "Select one option of the above [0-6]: "
-ENTER_CHANNEL_ID_PROMPT = "Enter a channel ID: "
-ENTER_CUSTOM_CHANNEL_NAME_PROMPT = "Enter the channel name: "
-REPORT_SKIPPED_SEGMENTS_PROMPT = (
-    "Do you want to report skipped segments to sponsorblock. Only the segment"
-    " UUID will be sent? (Y/n) "
-)
-MUTE_ADS_PROMPT = "Do you want to mute native YouTube ads automatically? (y/N) "
-SKIP_ADS_PROMPT = "Do you want to skip native YouTube ads automatically? (y/N) "
-AUTOPLAY_PROMPT = "Do you want to enable autoplay? (Y/n) "
-ENTER_API_SERVER_PROMPT = (
-    "Enter the custom API server URL (leave blank to use default): "
-)
-
-
-def get_yn_input(prompt):
-    while choice := input(prompt):
-        if choice.lower() in ["y", "n"]:
-            return choice.lower()
-        print("Invalid input. Please enter 'y' or 'n'.")
-
-
-async def pair_device():
-    try:
-        lounge_controller = ytlounge.YtLoungeApi("iSponsorBlockTV")
-        pairing_code = input(PAIRING_CODE_PROMPT)
-        pairing_code = int(
-            pairing_code.replace("-", "").replace(" ", "")
-        )  # remove dashes and spaces
-        print("Pairing...")
-        paired = await lounge_controller.pair(pairing_code)
-        if not paired:
-            print("Failed to pair device")
-            return
-        device = {
-            "screen_id": lounge_controller.auth.screen_id,
-            "name": lounge_controller.screen_name,
-        }
-        print(f"Paired device: {device['name']}")
-        return device
-    except Exception as e:
-        print(f"Failed to pair device: {e}")
-        return
-
-
-def main(config, debug: bool) -> None:
-    print("Welcome to the iSponsorBlockTV cli setup wizard")
-    loop = asyncio.get_event_loop_policy().get_event_loop()
-    web_session = aiohttp.ClientSession()
-    if debug:
-        loop.set_debug(True)
-    asyncio.set_event_loop(loop)
-    if hasattr(config, "atvs"):
-        print(
-            "The atvs config option is deprecated and has stopped working. Please read"
-            " this for more information on how to upgrade to V2:"
-            " \nhttps://github.com/dmunozv04/iSponsorBlockTV/wiki/Migrate-from-V1-to-V2"
-        )
-        choice = get_yn_input(ATVS_REMOVAL_PROMPT)
-        if choice == "y":
-            del config["atvs"]
-
-    devices = config.devices
-    choice = get_yn_input(ADD_MORE_DEVICES_PROMPT.format(num_devices=len(devices)))
-    while choice == "y":
-        task = loop.create_task(pair_device())
-        loop.run_until_complete(task)
-        device = task.result()
-        if device:
-            devices.append(device)
-        choice = get_yn_input(ADD_MORE_DEVICES_PROMPT.format(num_devices=len(devices)))
-    config.devices = devices
-
-    apikey = config.apikey
-    if apikey:
-        choice = get_yn_input(CHANGE_API_KEY_PROMPT)
-        if choice == "y":
-            apikey = input(ENTER_API_KEY_PROMPT)
-    else:
-        choice = get_yn_input(ADD_API_KEY_PROMPT)
-        if choice == "y":
-            print(
-                "Get youtube apikey here:"
-                " https://developers.google.com/youtube/registering_an_application"
-            )
-            apikey = input(ENTER_API_KEY_PROMPT)
-    config.apikey = apikey
-
-    skip_categories = config.skip_categories
-    if skip_categories:
-        choice = get_yn_input(CHANGE_SKIP_CATEGORIES_PROMPT)
-        if choice == "y":
-            categories = input(ENTER_SKIP_CATEGORIES_PROMPT)
-            skip_categories = categories.replace(",", " ").split(" ")
-            skip_categories = [
-                x for x in skip_categories if x != ""
-            ]  # Remove empty strings
-    else:
-        categories = input(ENTER_SKIP_CATEGORIES_PROMPT)
-        skip_categories = categories.replace(",", " ").split(" ")
-        skip_categories = [
-            x for x in skip_categories if x != ""
-        ]  # Remove empty strings
-    config.skip_categories = skip_categories
-
-    channel_whitelist = config.channel_whitelist
-    choice = get_yn_input(WHITELIST_CHANNELS_PROMPT)
-    if choice == "y":
-        if not apikey:
-            print(
-                "WARNING: You need to specify an API key to use this function,"
-                " otherwise the program will fail to start.\nYou can add one by"
-                " re-running this setup wizard."
-            )
-        api_helper = api_helpers.ApiHelper(config, web_session)
-        while True:
-            channel_info = {}
-            channel = input(SEARCH_CHANNEL_PROMPT)
-            if channel == "/exit":
-                break
-
-            task = loop.create_task(
-                api_helper.search_channels(channel, apikey, web_session)
-            )
-            loop.run_until_complete(task)
-            results = task.result()
-            if len(results) == 0:
-                print("No channels found")
-                continue
-
-            for i, item in enumerate(results):
-                print(f"{i}: {item[1]} - Subs: {item[2]}")
-            print("5: Enter a custom channel ID")
-            print("6: Go back")
-
-            while choice := input(SELECT_CHANNEL_PROMPT):
-                if choice in [str(x) for x in range(7)]:
-                    break
-                print("Invalid choice")
-
-            if choice == "5":
-                channel_info["id"] = input(ENTER_CHANNEL_ID_PROMPT)
-                channel_info["name"] = input(ENTER_CUSTOM_CHANNEL_NAME_PROMPT)
-                channel_whitelist.append(channel_info)
-                continue
-            if choice == "6":
-                continue
-
-            channel_info["id"] = results[int(choice)][0]
-            channel_info["name"] = results[int(choice)][1]
-            channel_whitelist.append(channel_info)
-        # Close web session asynchronously
-
-    config.channel_whitelist = channel_whitelist
-
-    choice = get_yn_input(REPORT_SKIPPED_SEGMENTS_PROMPT)
-    config.skip_count_tracking = choice != "n"
-
-    choice = get_yn_input(MUTE_ADS_PROMPT)
-    config.mute_ads = choice == "y"
-
-    choice = get_yn_input(SKIP_ADS_PROMPT)
-    config.skip_ads = choice == "y"
-
-    choice = get_yn_input(AUTOPLAY_PROMPT)
-    config.auto_play = choice != "n"
-
-    api_server = input(ENTER_API_SERVER_PROMPT)
-    if api_server:
-        config.api_server = api_server
-
-    print("Config finished")
-    config.save()
-    loop.run_until_complete(web_session.close())
+import asyncio
+
+import aiohttp
+
+from . import api_helpers, ytlounge
+
+# Constants for user input prompts
+ATVS_REMOVAL_PROMPT = (
+    "Do you want to remove the legacy 'atvs' entry (the app won't start"
+    " with it present)? (y/N) "
+)
+PAIRING_CODE_PROMPT = "Enter pairing code (found in Settings - Link with TV code): "
+ADD_MORE_DEVICES_PROMPT = "Paired with {num_devices} Device(s). Add more? (y/N) "
+CHANGE_API_KEY_PROMPT = "API key already specified. Change it? (y/N) "
+ADD_API_KEY_PROMPT = (
+    "API key only needed for the channel whitelist function. Add it? (y/N) "
+)
+ENTER_API_KEY_PROMPT = "Enter your API key: "
+CHANGE_SKIP_CATEGORIES_PROMPT = "Skip categories already specified. Change them? (y/N) "
+ENTER_SKIP_CATEGORIES_PROMPT = (
+    "Enter skip categories (space or comma sepparated) Options: [sponsor,"
+    " selfpromo, exclusive_access, interaction, poi_highlight, intro, outro,"
+    " preview, filler, music_offtopic]:\n"
+)
+WHITELIST_CHANNELS_PROMPT = (
+    "Do you want to whitelist any channels from being ad-blocked? (y/N) "
+)
+SEARCH_CHANNEL_PROMPT = 'Enter a channel name or "/exit" to exit: '
+SELECT_CHANNEL_PROMPT = "Select one option of the above [0-6]: "
+ENTER_CHANNEL_ID_PROMPT = "Enter a channel ID: "
+ENTER_CUSTOM_CHANNEL_NAME_PROMPT = "Enter the channel name: "
+REPORT_SKIPPED_SEGMENTS_PROMPT = (
+    "Do you want to report skipped segments to sponsorblock. Only the segment"
+    " UUID will be sent? (Y/n) "
+)
+MUTE_ADS_PROMPT = "Do you want to mute native YouTube ads automatically? (y/N) "
+SKIP_ADS_PROMPT = "Do you want to skip native YouTube ads automatically? (y/N) "
+AUTOPLAY_PROMPT = "Do you want to enable autoplay? (Y/n) "
+
+
+def get_yn_input(prompt):
+    while choice := input(prompt):
+        if choice.lower() in ["y", "n"]:
+            return choice.lower()
+        print("Invalid input. Please enter 'y' or 'n'.")
+    return None
+
+
+async def create_web_session():
+    return aiohttp.ClientSession()
+
+
+async def pair_device(web_session: aiohttp.ClientSession):
+    try:
+        lounge_controller = ytlounge.YtLoungeApi()
+        await lounge_controller.change_web_session(web_session)
+        pairing_code = input(PAIRING_CODE_PROMPT)
+        pairing_code = int(
+            pairing_code.replace("-", "").replace(" ", "")
+        )  # remove dashes and spaces
+        print("Pairing...")
+        paired = await lounge_controller.pair(pairing_code)
+        if not paired:
+            print("Failed to pair device")
+            return
+        device = {
+            "screen_id": lounge_controller.auth.screen_id,
+            "name": lounge_controller.screen_name,
+        }
+        print(f"Paired device: {device['name']}")
+        return device
+    except Exception as e:
+        print(f"Failed to pair device: {e}")
+        return
+
+
+def main(config, debug: bool) -> None:
+    print("Welcome to the iSponsorBlockTV cli setup wizard")
+    loop = asyncio.get_event_loop_policy().get_event_loop()
+    web_session = loop.run_until_complete(create_web_session())
+    if debug:
+        loop.set_debug(True)
+    asyncio.set_event_loop(loop)
+    if hasattr(config, "atvs"):
+        print(
+            "The atvs config option is deprecated and has stopped working. Please read"
+            " this for more information on how to upgrade to V2:"
+            " \nhttps://github.com/dmunozv04/iSponsorBlockTV/wiki/Migrate-from-V1-to-V2"
+        )
+        choice = get_yn_input(ATVS_REMOVAL_PROMPT)
+        if choice == "y":
+            del config["atvs"]
+
+    devices = config.devices
+    choice = get_yn_input(ADD_MORE_DEVICES_PROMPT.format(num_devices=len(devices)))
+    while choice == "y":
+        device = loop.run_until_complete(pair_device(web_session))
+        if device:
+            devices.append(device)
+        choice = get_yn_input(ADD_MORE_DEVICES_PROMPT.format(num_devices=len(devices)))
+    config.devices = devices
+
+    apikey = config.apikey
+    if apikey:
+        choice = get_yn_input(CHANGE_API_KEY_PROMPT)
+        if choice == "y":
+            apikey = input(ENTER_API_KEY_PROMPT)
+    else:
+        choice = get_yn_input(ADD_API_KEY_PROMPT)
+        if choice == "y":
+            print(
+                "Get youtube apikey here:"
+                " https://developers.google.com/youtube/registering_an_application"
+            )
+            apikey = input(ENTER_API_KEY_PROMPT)
+    config.apikey = apikey
+
+    skip_categories = config.skip_categories
+    if skip_categories:
+        choice = get_yn_input(CHANGE_SKIP_CATEGORIES_PROMPT)
+        if choice == "y":
+            categories = input(ENTER_SKIP_CATEGORIES_PROMPT)
+            skip_categories = categories.replace(",", " ").split(" ")
+            skip_categories = [
+                x for x in skip_categories if x != ""
+            ]  # Remove empty strings
+    else:
+        categories = input(ENTER_SKIP_CATEGORIES_PROMPT)
+        skip_categories = categories.replace(",", " ").split(" ")
+        skip_categories = [
+            x for x in skip_categories if x != ""
+        ]  # Remove empty strings
+    config.skip_categories = skip_categories
+
+    channel_whitelist = config.channel_whitelist
+    choice = get_yn_input(WHITELIST_CHANNELS_PROMPT)
+    if choice == "y":
+        if not apikey:
+            print(
+                "WARNING: You need to specify an API key to use this function,"
+                " otherwise the program will fail to start.\nYou can add one by"
+                " re-running this setup wizard."
+            )
+        api_helper = api_helpers.ApiHelper(config, web_session)
+        while True:
+            channel_info = {}
+            channel = input(SEARCH_CHANNEL_PROMPT)
+            if channel == "/exit":
+                break
+
+            task = loop.create_task(
+                api_helper.search_channels(channel, apikey, web_session)
+            )
+            loop.run_until_complete(task)
+            results = task.result()
+            if len(results) == 0:
+                print("No channels found")
+                continue
+
+            for i, item in enumerate(results):
+                print(f"{i}: {item[1]} - Subs: {item[2]}")
+            print("5: Enter a custom channel ID")
+            print("6: Go back")
+
+            while choice := input(SELECT_CHANNEL_PROMPT):
+                if choice in [str(x) for x in range(7)]:
+                    break
+                print("Invalid choice")
+
+            if choice == "5":
+                channel_info["id"] = input(ENTER_CHANNEL_ID_PROMPT)
+                channel_info["name"] = input(ENTER_CUSTOM_CHANNEL_NAME_PROMPT)
+                channel_whitelist.append(channel_info)
+                continue
+            if choice == "6":
+                continue
+
+            channel_info["id"] = results[int(choice)][0]
+            channel_info["name"] = results[int(choice)][1]
+            channel_whitelist.append(channel_info)
+        # Close web session asynchronously
+
+    config.channel_whitelist = channel_whitelist
+
+    choice = get_yn_input(REPORT_SKIPPED_SEGMENTS_PROMPT)
+    config.skip_count_tracking = choice != "n"
+
+    choice = get_yn_input(MUTE_ADS_PROMPT)
+    config.mute_ads = choice == "y"
+
+    choice = get_yn_input(SKIP_ADS_PROMPT)
+    config.skip_ads = choice == "y"
+
+    choice = get_yn_input(AUTOPLAY_PROMPT)
+    config.auto_play = choice != "n"
+
+    print("Config finished")
+    config.save()
+    loop.run_until_complete(web_session.close())

src/iSponsorBlockTV/constants.py

@@ -2,6 +2,7 @@ userAgent = "iSponsorBlockTV/0.1"
 SponsorBlock_service = "youtube"
 SponsorBlock_actiontype = "skip"
 
+SponsorBlock_api = "https://sponsor.ajay.app/api/"
 Youtube_api = "https://www.googleapis.com/youtube/v3/"
 
 skip_categories = (
@@ -19,4 +20,7 @@ skip_categories = (
 
 youtube_client_blacklist = ["TVHTML5_FOR_KIDS"]
 
+
 config_file_blacklist_keys = ["config_file", "data_dir"]
+
+github_wiki_base_url = "https://github.com/dmunozv04/iSponsorBlockTV/wiki"

src/iSponsorBlockTV/dial_client.py

@@ -1,4 +1,5 @@
 """Send out an M-SEARCH request and listening for responses."""
+
 import asyncio
 import socket
 
@@ -6,46 +7,47 @@ import ssdp
 import xmltodict
 from ssdp import network
 
-"""Redistribution and use of the DIAL DIscovery And Launch protocol
-specification (the “DIAL Specification”), with or without modification,
-are permitted provided that the following conditions are met: ●
-Redistributions of the DIAL Specification must retain the above copyright
-notice, this list of conditions and the following disclaimer. ●
-Redistributions of implementations of the DIAL Specification in source code
-form must retain the above copyright notice, this list of conditions and the
-following disclaimer. ● Redistributions of implementations of the DIAL
-Specification in binary form must include the above copyright notice. ● The
-DIAL mark, the NETFLIX mark and the names of contributors to the DIAL
-Specification may not be used to endorse or promote specifications, software,
-products, or any other materials derived from the DIAL Specification without
-specific prior written permission. The DIAL mark is owned by Netflix and
-information on licensing the DIAL mark is available at
-www.dial-multiscreen.org."""
+# Redistribution and use of the DIAL DIscovery And Launch protocol
+# specification (the “DIAL Specification”), with or without modification,
+# are permitted provided that the following conditions are met: ●
+# Redistributions of the DIAL Specification must retain the above copyright
+# notice, this list of conditions and the following disclaimer. ●
+# Redistributions of implementations of the DIAL Specification in source code
+# form must retain the above copyright notice, this list of conditions and the
+# following disclaimer. ● Redistributions of implementations of the DIAL
+# Specification in binary form must include the above copyright notice. ● The
+# DIAL mark, the NETFLIX mark and the names of contributors to the DIAL
+# Specification may not be used to endorse or promote specifications, software,
+# products, or any other materials derived from the DIAL Specification without
+# specific prior written permission. The DIAL mark is owned by Netflix and
+# information on licensing the DIAL mark is available at
+# www.dial-multiscreen.org.
 
-"""
-MIT License
 
-Copyright (c) 2018 Johannes Hoppe
+# MIT License
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+# Copyright (c) 2018 Johannes Hoppe
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE."""
-"""Modified code from
-https://github.com/codingjoe/ssdp/blob/main/ssdp/__main__.py"""
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+# Modified code from
+# https://github.com/codingjoe/ssdp/blob/main/ssdp/__main__.py
 
 
 def get_ip():
@@ -80,6 +82,11 @@ class Handler(ssdp.aio.SSDP):
         if "location" in headers:
             self.devices.append(headers["location"])
 
+    def request_received(self, request: ssdp.messages.SSDPRequest, addr):
+        raise NotImplementedError(
+            "Request received is not implemented, this is a client"
+        )
+
 
 async def find_youtube_app(web_session, url_location):
     async with web_session.get(url_location) as response:
@@ -110,21 +117,21 @@ async def discover(web_session):
     search_target = "urn:dial-multiscreen-org:service:dial:1"
     max_wait = 10
     handler = Handler()
-    """Send out an M-SEARCH request and listening for responses."""
-    family, addr = network.get_best_family(bind, network.PORT)
+    # Send out an M-SEARCH request and listening for responses
+    family, _ = network.get_best_family(bind, network.PORT)
     loop = asyncio.get_event_loop()
     ip_address = get_ip()
     connect = loop.create_datagram_endpoint(
         handler, family=family, local_addr=(ip_address, None)
     )
-    transport, protocol = await connect
+    transport, _ = await connect
 
     target = network.MULTICAST_ADDRESS_IPV4, network.PORT
 
     search_request = ssdp.messages.SSDPRequest(
         "M-SEARCH",
         headers={
-            "HOST": "%s:%d" % target,
+            "HOST": f"{target[0]}:{target[1]}",
             "MAN": '"ssdp:discover"',
             "MX": str(max_wait),  # seconds to delay response [1..5]
             "ST": search_target,
@@ -135,7 +142,6 @@ async def discover(web_session):
 
     search_request.sendto(transport, target)
 
-    # print(search_request, addr[:2])
     try:
         await asyncio.sleep(4)
     finally:

src/iSponsorBlockTV/helpers.py

@@ -8,7 +8,7 @@ import rich_click as click
 from appdirs import user_data_dir
 
 from . import config_setup, main, setup_wizard
-from .constants import config_file_blacklist_keys
+from .constants import config_file_blacklist_keys, github_wiki_base_url
 
 
 class Device:
@@ -42,7 +42,7 @@ class Config:
         self.mute_ads = False
         self.skip_ads = False
         self.auto_play = True
-        self.api_server = "https://sponsor.ajay.app"
+        self.join_name = "iSponsorBlockTV"
         self.__load()
 
     def validate(self):
@@ -51,8 +51,8 @@ class Config:
                 (
                     "The atvs config option is deprecated and has stopped working."
                     " Please read this for more information "
-                    "on how to upgrade to V2:"
-                    " \nhttps://github.com/dmunozv04/iSponsorBlockTV/wiki/Migrate-from-V1-to-V2"
+                    "on how to upgrade to V2:\n"
+                    f"{github_wiki_base_url}/Migrate-from-V1-to-V2"
                 ),
             )
             print("Exiting in 10 seconds...")
@@ -90,7 +90,7 @@ class Config:
                     print(
                         "Running in docker without mounting the data dir, check the"
                         " wiki for more information: "
-                        "https://github.com/dmunozv04/iSponsorBlockTV/wiki/Installation#Docker"
+                        f"{github_wiki_base_url}/Installation#Docker"
                     )
                     print(
                         (
@@ -101,7 +101,7 @@ class Config:
                             "Please read this for more information on how to upgrade"
                             " to V2:"
                         ),
-                        "https://github.com/dmunozv04/iSponsorBlockTV/wiki/Migrate-from-V1-to-V2",
+                        f"{github_wiki_base_url}/Migrate-from-V1-to-V2",
                     )
                     print("Exiting in 10 seconds...")
                     time.sleep(10)
@@ -126,6 +126,9 @@ class Config:
             return self.__dict__ == other.__dict__
         return False
 
+    def __hash__(self):
+        return hash(tuple(sorted(self.items())))
+
 
 @click.group(invoke_without_command=True)
 @click.option(
@@ -152,8 +155,20 @@ def cli(ctx, data, debug, setup, setup_cli):
     ctx.ensure_object(dict)
     ctx.obj["data_dir"] = data
     ctx.obj["debug"] = debug
+
+    logger = logging.getLogger()
+    ctx.obj["logger"] = logger
+    sh = logging.StreamHandler()
+    sh.setFormatter(
+        logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
+    )
+    logger.addHandler(sh)
+
     if debug:
-        logging.basicConfig(level=logging.DEBUG)
+        logger.setLevel(logging.DEBUG)
+    else:
+        logger.setLevel(logging.INFO)
+
     if ctx.invoked_subcommand is None:
         if setup:
             ctx.invoke(setup_command)
@@ -163,29 +178,23 @@ def cli(ctx, data, debug, setup, setup_cli):
             ctx.invoke(start)
 
 
-@cli.command()
+@cli.command(name="setup")
 @click.pass_context
-def setup(ctx):
+def setup_command(ctx):
     """Setup the program graphically"""
     config = Config(ctx.obj["data_dir"])
     setup_wizard.main(config)
     sys.exit()
 
 
-setup_command = setup
-
-
-@cli.command()
+@cli.command(name="setup-cli")
 @click.pass_context
-def setup_cli(ctx):
+def setup_cli_command(ctx):
     """Setup the program in the command line"""
     config = Config(ctx.obj["data_dir"])
     config_setup.main(config, ctx.obj["debug"])
 
 
-setup_cli_command = setup_cli
-
-
 @cli.command()
 @click.pass_context
 def start(ctx):

src/iSponsorBlockTV/macos_install.py

@@ -1,57 +0,0 @@
-import os
-import plistlib
-
-from . import config_setup
-
-"""Not updated to V2 yet, should still work. Here be dragons"""
-default_plist = {
-    "Label": "com.dmunozv04iSponsorBlockTV",
-    "RunAtLoad": True,
-    "StartInterval": 20,
-    "EnvironmentVariables": {"PYTHONUNBUFFERED": "YES"},
-    "StandardErrorPath": "",  # Fill later
-    "StandardOutPath": "",
-    "ProgramArguments": "",
-    "WorkingDirectory": "",
-}
-
-
-def create_plist(path):
-    plist = default_plist
-    plist["ProgramArguments"] = [path + "/iSponsorBlockTV-macos"]
-    plist["StandardErrorPath"] = path + "/iSponsorBlockTV.error.log"
-    plist["StandardOutPath"] = path + "/iSponsorBlockTV.out.log"
-    plist["WorkingDirectory"] = path
-    launchd_path = os.path.expanduser("~/Library/LaunchAgents/")
-    path_to_save = launchd_path + "com.dmunozv04.iSponsorBlockTV.plist"
-
-    with open(path_to_save, "wb") as fp:
-        plistlib.dump(plist, fp)
-
-
-def run_setup(file):
-    config = {}
-    config_setup.main(config, file, debug=False)
-
-
-def main():
-    correct_path = os.path.expanduser("~/iSponsorBlockTV")
-    if os.path.isfile(correct_path + "/iSponsorBlockTV-macos"):
-        print("Program is on the right path")
-        print("The launch daemon will now be installed")
-        create_plist(correct_path)
-        run_setup(correct_path + "/config.json")
-        print(
-            "Launch daemon installed. Please restart the computer to enable it or"
-            " use:\n launchctl load"
-            " ~/Library/LaunchAgents/com.dmunozv04.iSponsorBlockTV.plist"
-        )
-    else:
-        if not os.path.exists(correct_path):
-            os.makedirs(correct_path)
-        print(
-            "Please move the program to the correct path: "
-            + correct_path
-            + "opening now on finder..."
-        )
-        os.system("open -R " + correct_path)

src/iSponsorBlockTV/main.py

@@ -18,18 +18,8 @@ class DeviceListener:
         self.cancelled = False
         self.logger = logging.getLogger(f"iSponsorBlockTV-{device.screen_id}")
         self.web_session = web_session
-        if debug:
-            self.logger.setLevel(logging.DEBUG)
-        else:
-            self.logger.setLevel(logging.INFO)
-        sh = logging.StreamHandler()
-        sh.setFormatter(
-            logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
-        )
-        self.logger.addHandler(sh)
-        self.logger.info(f"Starting device")
         self.lounge_controller = ytlounge.YtLoungeApi(
-            device.screen_id, config, api_helper, self.logger, self.web_session
+            device.screen_id, config, api_helper, self.logger
         )
 
     # Ensures that we have a valid auth token
@@ -38,15 +28,13 @@ class DeviceListener:
             await asyncio.sleep(60 * 60 * 24)  # Refresh every 24 hours
             try:
                 await self.lounge_controller.refresh_auth()
-            except:
-                # traceback.print_exc()
+            except BaseException:
                 pass
 
     async def is_available(self):
         try:
             return await self.lounge_controller.is_available()
-        except:
-            # traceback.print_exc()
+        except BaseException:
             return False
 
     # Main subscription loop
@@ -57,38 +45,40 @@ class DeviceListener:
                 try:
                     self.logger.debug("Refreshing auth")
                     await lounge_controller.refresh_auth()
-                except:
+                except BaseException:
                     await asyncio.sleep(10)
             while not (await self.is_available()) and not self.cancelled:
+                self.logger.debug("Waiting for device to be available")
                 await asyncio.sleep(10)
             try:
                 await lounge_controller.connect()
-            except:
+            except BaseException:
                 pass
             while not lounge_controller.connected() and not self.cancelled:
                 # Doesn't connect to the device if it's a kids profile (it's broken)
+                self.logger.debug("Waiting for device to be connected")
                 await asyncio.sleep(10)
                 try:
                     await lounge_controller.connect()
-                except:
+                except BaseException:
                     pass
             self.logger.info(
                 "Connected to device %s (%s)", lounge_controller.screen_name, self.name
             )
             try:
-                self.logger.info("Subscribing to lounge")
+                self.logger.debug("Subscribing to lounge")
                 sub = await lounge_controller.subscribe_monitored(self)
                 await sub
-            except:
+            except BaseException:
                 pass
 
     # Method called on playback state change
     async def __call__(self, state):
+        time_start = time.monotonic()
         try:
             self.task.cancel()
-        except:
+        except BaseException:
             pass
-        time_start = time.time()
         self.task = asyncio.create_task(self.process_playstatus(state, time_start))
 
     # Processes the playback state change
@@ -98,7 +88,7 @@ class DeviceListener:
             segments = await self.api_helper.get_segments(state.videoId)
         if state.state.value == 1:  # Playing
             self.logger.info(
-                f"Playing video {state.videoId} with {len(segments)} segments"
+                "Playing video %s with %d segments", state.videoId, len(segments)
             )
             if segments:  # If there are segments
                 await self.time_to_segment(segments, state.currentTime, time_start)
@@ -108,63 +98,100 @@ class DeviceListener:
         start_next_segment = None
         next_segment = None
         for segment in segments:
-            if position < 2 and (segment["start"] <= position < segment["end"]):
+            segment_start = segment["start"]
+            segment_end = segment["end"]
+            is_within_start_range = (
+                position < 1 < segment_end and segment_start <= position < segment_end
+            )
+            is_beyond_current_position = segment_start > position
+
+            if is_within_start_range or is_beyond_current_position:
                 next_segment = segment
                 start_next_segment = (
-                    position  # different variable so segment doesn't change
+                    position if is_within_start_range else segment_start
                 )
                 break
-            if segment["start"] > position:
-                next_segment = segment
-                start_next_segment = next_segment["start"]
-                break
         if start_next_segment:
             time_to_next = (
-                start_next_segment - position - (time.time() - time_start) - self.offset
-            )
+                (start_next_segment - position - (time.monotonic() - time_start))
+                / self.lounge_controller.playback_speed
+            ) - self.offset
             await self.skip(time_to_next, next_segment["end"], next_segment["UUID"])
 
     # Skips to the next segment (waits for the time to pass)
     async def skip(self, time_to, position, uuids):
         await asyncio.sleep(time_to)
         self.logger.info("Skipping segment: seeking to %s", position)
-        await asyncio.create_task(self.api_helper.mark_viewed_segments(uuids))
-        await asyncio.create_task(self.lounge_controller.seek_to(position))
+        await asyncio.gather(
+            asyncio.create_task(self.lounge_controller.seek_to(position)),
+            asyncio.create_task(self.api_helper.mark_viewed_segments(uuids)),
+        )
 
-    # Stops the connection to the device
     async def cancel(self):
         self.cancelled = True
-        try:
+        await self.lounge_controller.disconnect()
+        if self.task:
             self.task.cancel()
-        except Exception:
-            pass
+        if self.lounge_controller.subscribe_task_watchdog:
+            self.lounge_controller.subscribe_task_watchdog.cancel()
+        if self.lounge_controller.subscribe_task:
+            self.lounge_controller.subscribe_task.cancel()
+        await asyncio.gather(
+            self.task,
+            self.lounge_controller.subscribe_task_watchdog,
+            self.lounge_controller.subscribe_task,
+            return_exceptions=True,
+        )
+
+    async def initialize_web_session(self):
+        await self.lounge_controller.change_web_session(self.web_session)
 
 
-async def finish(devices):
-    for i in devices:
-        await i.cancel()
+async def finish(devices, web_session, tcp_connector):
+    await asyncio.gather(
+        *(device.cancel() for device in devices), return_exceptions=True
+    )
+    await web_session.close()
+    await tcp_connector.close()
 
 
-def main(config, debug):
+def handle_signal(signum, frame):
+    raise KeyboardInterrupt()
+
+
+async def main_async(config, debug):
     loop = asyncio.get_event_loop_policy().get_event_loop()
     tasks = []  # Save the tasks so the interpreter doesn't garbage collect them
     devices = []  # Save the devices to close them later
     if debug:
         loop.set_debug(True)
-    asyncio.set_event_loop(loop)
     tcp_connector = aiohttp.TCPConnector(ttl_dns_cache=300)
-    web_session = aiohttp.ClientSession(loop=loop, connector=tcp_connector)
+    web_session = aiohttp.ClientSession(connector=tcp_connector)
     api_helper = api_helpers.ApiHelper(config, web_session)
     for i in config.devices:
         device = DeviceListener(api_helper, config, i, debug, web_session)
         devices.append(device)
+        await device.initialize_web_session()
         tasks.append(loop.create_task(device.loop()))
         tasks.append(loop.create_task(device.refresh_auth_loop()))
-    signal(SIGINT, lambda s, f: loop.stop())
-    signal(SIGTERM, lambda s, f: loop.stop())
-    loop.run_forever()
-    print("Cancelling tasks and exiting...")
-    loop.run_until_complete(finish(devices))
-    loop.run_until_complete(web_session.close())
-    loop.run_until_complete(tcp_connector.close())
+    signal(SIGTERM, handle_signal)
+    signal(SIGINT, handle_signal)
+    try:
+        await asyncio.gather(*tasks)
+    except KeyboardInterrupt:
+        print("Cancelling tasks and exiting...")
+        await finish(devices, web_session, tcp_connector)
+        for task in tasks:
+            task.cancel()
+        await asyncio.gather(*tasks, return_exceptions=True)
+    finally:
+        await web_session.close()
+        await tcp_connector.close()
+        loop.close()
+        print("Exited")
+
+
+def main(config, debug):
+    loop = asyncio.get_event_loop()
+    loop.run_until_complete(main_async(config, debug))
     loop.close()

src/iSponsorBlockTV/setup-wizard-style.tcss

@@ -21,9 +21,13 @@
     scrollbar-gutter: stable;
 }
 
-.small-button{
+.button-small {
     height: 3;
-
+    border: none;
+    border-top: none;
+    border-bottom: none;
+    offset: 0 -1;
+    padding: 0;
 }
 
 .button-100 {
@@ -106,13 +110,14 @@ EditDevice {
 }
 
 Element {
-    background: $panel;
+    background: $panel-darken-1;
     border-top: solid $panel-lighten-2;
     layout: horizontal;
     height: 2;
     width: 100%;
     margin: 0 1 0 1;
     padding: 0;
+
 }
 Element > .element-name {
     offset: 0 -1;
@@ -120,7 +125,11 @@ Element > .element-name {
     width: 100%;
     align: left middle;
     text-align: left;
-
+    background: $panel-darken-1;
+    &:hover {
+        background: $panel-lighten-1;
+        border-top: tall $panel-lighten-3;
+    }
 }
 Element > .element-remove {
     dock: right;
@@ -132,7 +141,7 @@ Element > .element-remove {
     margin: 0 1 0 0;
 }
 
-#add-device {
+#add-device, #add-channel {
     text-style: bold;
     width: 100%;
     align: left middle;
@@ -140,6 +149,11 @@ Element > .element-remove {
     dock: left;
 
     text-align: left;
+    background: $panel-darken-1;
+    &:hover {
+        background: $panel-lighten-1;
+        border-top: tall $panel-lighten-3;
+    }
 }
 #add-device-button-container{
     height: 1;

src/iSponsorBlockTV/setup_wizard.py

@@ -79,17 +79,20 @@ class Element(Static):
         self.tooltip = tooltip
 
     def process_values_from_data(self):
-        pass
+        raise NotImplementedError("Subclasses must implement this method.")
 
     def compose(self) -> ComposeResult:
         yield Button(
             label=self.element_name,
-            classes="element-name",
+            classes="element-name button-small",
             disabled=True,
             id="element-name",
         )
         yield Button(
-            "Remove", classes="element-remove", variant="error", id="element-remove"
+            "Remove",
+            classes="element-remove button-small",
+            variant="error",
+            id="element-remove",
         )
 
     def on_mount(self) -> None:
@@ -102,7 +105,6 @@ class Device(Element):
     """A device element."""
 
     def process_values_from_data(self):
-        print(self.element_data)
         if "name" in self.element_data and self.element_data["name"]:
             self.element_name = self.element_data["name"]
         else:
@@ -227,7 +229,8 @@ class ExitScreen(ModalWithClickExit):
 
 
 class AddDevice(ModalWithClickExit):
-    """Screen with a dialog to add a device, either with a pairing code or with lan discovery."""
+    """Screen with a dialog to add a device, either with a pairing code
+    or with lan discovery."""
 
     BINDINGS = [("escape", "dismiss({})", "Return")]
 
@@ -285,7 +288,8 @@ class AddDevice(ModalWithClickExit):
                             " computer\nIf it isn't showing up, try restarting the"
                             " app.\nIf running in docker, make sure to use"
                             " `--network=host`\nTo refresh the list, close and open the"
-                            " dialog again"
+                            " dialog again\n[b][u]If it still doesn't work, "
+                            "pair using a pairing code (it's much more reliable)"
                         ),
                         classes="subtitle",
                     )
@@ -328,17 +332,18 @@ class AddDevice(ModalWithClickExit):
 
     @on(Input.Changed, "#pairing-code-input")
     def changed_pairing_code(self, event: Input.Changed):
-        self.query_one("#add-device-pin-add-button").disabled = (
-            not event.validation_result.is_valid
-        )
+        self.query_one(
+            "#add-device-pin-add-button"
+        ).disabled = not event.validation_result.is_valid
 
     @on(Input.Submitted, "#pairing-code-input")
     @on(Button.Pressed, "#add-device-pin-add-button")
     async def handle_add_device_pin(self) -> None:
         self.query_one("#add-device-pin-add-button").disabled = True
         lounge_controller = ytlounge.YtLoungeApi(
-            "iSponsorBlockTV", web_session=self.web_session
+            "iSponsorBlockTV",
         )
+        await lounge_controller.change_web_session(self.web_session)
         pairing_code = self.query_one("#pairing-code-input").value
         pairing_code = int(
             pairing_code.replace("-", "").replace(" ", "")
@@ -347,7 +352,7 @@ class AddDevice(ModalWithClickExit):
         paired = False
         try:
             paired = await lounge_controller.pair(pairing_code)
-        except:
+        except BaseException:
             pass
         if paired:
             device = {
@@ -377,13 +382,14 @@ class AddDevice(ModalWithClickExit):
 
     @on(SelectionList.SelectedChanged, "#dial-devices-list")
     def changed_device_list(self, event: SelectionList.SelectedChanged):
-        self.query_one("#add-device-dial-add-button").disabled = (
-            not event.selection_list.selected
-        )
+        self.query_one(
+            "#add-device-dial-add-button"
+        ).disabled = not event.selection_list.selected
 
 
 class AddChannel(ModalWithClickExit):
-    """Screen with a dialog to add a channel, either using search or with a channel id."""
+    """Screen with a dialog to add a channel,
+    either using search or with a channel id."""
 
     BINDINGS = [("escape", "dismiss(())", "Return")]
 
@@ -476,7 +482,6 @@ class AddChannel(ModalWithClickExit):
 
     @on(Button.Pressed, "#add-channel-switch-buttons > *")
     def handle_switch_buttons(self, event: Button.Pressed) -> None:
-        button_ = event.button.id
         self.query_one("#add-channel-switcher").current = event.button.id.replace(
             "-button", "-container"
         )
@@ -496,7 +501,7 @@ class AddChannel(ModalWithClickExit):
         self.query_one("#channel-search-results").remove_children()
         try:
             channels_list = await self.api_helper.search_channels(channel_name)
-        except:
+        except BaseException:
             self.query_one("#add-channel-info").update(
                 "[#ff0000]Failed to search for channel"
             )
@@ -550,7 +555,7 @@ class EditDevice(ModalWithClickExit):
     def action_close_screen_saving(self) -> None:
         self.dismiss()
 
-    def dismiss(self) -> None:
+    def dismiss(self, _=None) -> None:
         self.device_data["name"] = self.query_one("#device-name-input").value
         self.device_data["screen_id"] = self.query_one("#device-id-input").value
         self.device_data["offset"] = int(self.query_one("#device-offset-input").value)
@@ -585,7 +590,7 @@ class EditDevice(ModalWithClickExit):
                 )
 
     def on_slider_changed(self, event: Slider.Changed) -> None:
-        offset_input = self.query_one("#device-offset-offset_input")
+        offset_input = self.query_one("#device-offset-input")
         with offset_input.prevent(Input.Changed):
             offset_input.value = str(event.slider.value)
 
@@ -619,7 +624,9 @@ class DevicesManager(Vertical):
     def compose(self) -> ComposeResult:
         yield Label("Devices", classes="title")
         with Horizontal(id="add-device-button-container"):
-            yield Button("Add Device", id="add-device", classes="button-100")
+            yield Button(
+                "Add Device", id="add-device", classes="button-100 button-small"
+            )
         for device in self.devices:
             yield Device(device, tooltip="Click to edit")
 
@@ -788,7 +795,8 @@ class AdSkipMuteManager(Vertical):
 
 
 class ChannelWhitelistManager(Vertical):
-    """Manager for channel whitelist, allows adding/removing channels from the whitelist."""
+    """Manager for channel whitelist,
+    allows adding/removing channels from the whitelist."""
 
     def __init__(self, config, **kwargs) -> None:
         super().__init__(**kwargs)
@@ -813,7 +821,9 @@ class ChannelWhitelistManager(Vertical):
             id="warning-no-key",
         )
         with Horizontal(id="add-channel-button-container"):
-            yield Button("Add Channel", id="add-channel", classes="button-100")
+            yield Button(
+                "Add Channel", id="add-channel", classes="button-100 button-small"
+            )
         for channel in self.config.channel_whitelist:
             yield Channel(channel)
 
@@ -876,34 +886,7 @@ class AutoPlayManager(Vertical):
         self.config.auto_play = event.checkbox.value
 
 
-class ApiServerManager(Vertical):
-    """Manager for the custom API server URL."""
-
-    def __init__(self, config, **kwargs) -> None:
-        super().__init__(**kwargs)
-        self.config = config
-
-    def compose(self) -> ComposeResult:
-        yield Label("Custom API Server", classes="title")
-        yield Label(
-            "You can specify a custom SponsorBlock API server URL here.",
-            classes="subtitle",
-        )
-        with Grid(id="api-server-grid"):
-            yield Input(
-                placeholder="Custom API Server URL",
-                id="api-server-input",
-                value=self.config.api_server,
-            )
-
-    @on(Input.Changed, "#api-server-input")
-    def changed_api_server(self, event: Input.Changed):
-        self.config.api_server = event.input.value
-
-
 class ISponsorBlockTVSetupMainScreen(Screen):
-    """Making this a separate screen to avoid a bug: https://github.com/Textualize/textual/issues/3221"""
-
     TITLE = "iSponsorBlockTV"
     SUB_TITLE = "Setup Wizard"
     BINDINGS = [("q,ctrl+c", "exit_modal", "Exit"), ("s", "save", "Save")]
@@ -940,14 +923,10 @@ class ISponsorBlockTVSetupMainScreen(Screen):
             yield AutoPlayManager(
                 config=self.config, id="autoplay-manager", classes="container"
             )
-            yield ApiServerManager(
-                config=self.config, id="api-server-manager", classes="container"
-            )
 
     def on_mount(self) -> None:
         if self.check_for_old_config_entries():
             self.app.push_screen(MigrationScreen())
-            pass
 
     def action_save(self) -> None:
         self.config.save()
@@ -971,7 +950,7 @@ class ISponsorBlockTVSetupMainScreen(Screen):
             self.app.query_one("#warning-no-key").display = (
                 not event.input.value
             ) and self.config.channel_whitelist
-        except:
+        except BaseException:
             pass
 
 

src/iSponsorBlockTV/ytlounge.py

@@ -1,5 +1,6 @@
 import asyncio
 import json
+from typing import Any, List
 
 import pyytlounge
 from aiohttp import ClientSession
@@ -12,19 +13,19 @@ create_task = asyncio.create_task
 class YtLoungeApi(pyytlounge.YtLoungeApi):
     def __init__(
         self,
-        screen_id,
+        screen_id=None,
         config=None,
         api_helper=None,
         logger=None,
-        web_session: ClientSession = None,
     ):
-        super().__init__("iSponsorBlockTV", logger=logger)
-        if web_session is not None:
-            self.session = web_session  # And use the one we passed
+        super().__init__(
+            config.join_name if config else "iSponsorBlockTV", logger=logger
+        )
         self.auth.screen_id = screen_id
         self.auth.lounge_id_token = None
         self.api_helper = api_helper
         self.volume_state = {}
+        self.playback_speed = 1.0
         self.subscribe_task = None
         self.subscribe_task_watchdog = None
         self.callback = None
@@ -44,7 +45,7 @@ class YtLoungeApi(pyytlounge.YtLoungeApi):
         )  # YouTube sends at least a message every 30 seconds (no-op or any other)
         try:
             self.subscribe_task.cancel()
-        except Exception:
+        except BaseException:
             pass
 
     # Subscribe to the lounge and start the watchdog
@@ -52,24 +53,26 @@ class YtLoungeApi(pyytlounge.YtLoungeApi):
         self.callback = callback
         try:
             self.subscribe_task_watchdog.cancel()
-        except:
+        except BaseException:
             pass  # No watchdog task
         self.subscribe_task = asyncio.create_task(super().subscribe(callback))
         self.subscribe_task_watchdog = asyncio.create_task(self._watchdog())
         return self.subscribe_task
 
     # Process a lounge subscription event
-    def _process_event(self, event_id: int, event_type: str, args):
-        self.logger.debug(f"process_event({event_id}, {event_type}, {args})")
+    # skipcq: PY-R1000
+    def _process_event(self, event_type: str, args: List[Any]):
+        self.logger.debug(f"process_event({event_type}, {args})")
         # (Re)start the watchdog
         try:
             self.subscribe_task_watchdog.cancel()
-        except:
+        except BaseException:
             pass
         finally:
             self.subscribe_task_watchdog = asyncio.create_task(self._watchdog())
-        # A bunch of events useful to detect ads playing, and the next video before it starts playing (that way we
-        # can get the segments)
+        # A bunch of events useful to detect ads playing,
+        # and the next video before it starts playing
+        # (that way we can get the segments)
         if event_type == "onStateChange":
             data = args[0]
             # print(data)
@@ -98,10 +101,10 @@ class YtLoungeApi(pyytlounge.YtLoungeApi):
             ):  # Seen multiple other adStates, assuming they are all ads
                 self.logger.info("Ad has started, muting")
                 create_task(self.mute(True, override=True))
-        # Manages volume, useful since YouTube wants to know the volume when unmuting (even if they already have it)
+        # Manages volume, useful since YouTube wants to know the volume
+        # when unmuting (even if they already have it)
         elif event_type == "onVolumeChanged":
             self.volume_state = args[0]
-            pass
         # Gets segments for the next video before it starts playing
         elif event_type == "autoplayUpNext":
             if len(args) > 0 and (
@@ -155,22 +158,33 @@ class YtLoungeApi(pyytlounge.YtLoungeApi):
         elif event_type == "onAutoplayModeChanged":
             create_task(self.set_auto_play_mode(self.auto_play))
 
-        super()._process_event(event_id, event_type, args)
+        elif event_type == "onPlaybackSpeedChanged":
+            data = args[0]
+            self.playback_speed = float(data.get("playbackSpeed", "1"))
+            create_task(self.get_now_playing())
+
+        super()._process_event(event_type, args)
 
     # Set the volume to a specific value (0-100)
     async def set_volume(self, volume: int) -> None:
         await super()._command("setVolume", {"volume": volume})
 
-    # Mute or unmute the device (if the device already is in the desired state, nothing happens)
-    # mute: True to mute, False to unmute
-    # override: If True, the command is sent even if the device already is in the desired state
-    # TODO: Only works if the device is subscribed to the lounge
     async def mute(self, mute: bool, override: bool = False) -> None:
+        """
+        Mute or unmute the device (if the device already
+        is in the desired state, nothing happens)
+
+        :param bool mute: True to mute, False to unmute
+        :param bool override: If True, the command is sent even if the
+        device already is in the desired state
+
+        TODO: Only works if the device is subscribed to the lounge
+        """
         if mute:
             mute_str = "true"
         else:
             mute_str = "false"
-        if override or not (self.volume_state.get("muted", "false") == mute_str):
+        if override or not self.volume_state.get("muted", "false") == mute_str:
             self.volume_state["muted"] = mute_str
             # YouTube wants the volume when unmuting, so we send it
             await super()._command(
@@ -186,8 +200,18 @@ class YtLoungeApi(pyytlounge.YtLoungeApi):
     async def play_video(self, video_id: str) -> bool:
         return await self._command("setPlaylist", {"videoId": video_id})
 
+    async def get_now_playing(self):
+        return await super()._command("getNowPlaying")
+
     # Test to wrap the command function in a mutex to avoid race conditions with
     # the _command_offset (TODO: move to upstream if it works)
     async def _command(self, command: str, command_parameters: dict = None) -> bool:
         async with self._command_mutex:
             return await super()._command(command, command_parameters)
+
+    async def change_web_session(self, web_session: ClientSession):
+        if self.session is not None:
+            await self.session.close()
+        if self.conn is not None:
+            await self.conn.close()
+        self.session = web_session