[pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

.github/workflows/build_docker_images.yml

@@ -25,12 +25,12 @@ jobs:
     steps:
       # Get the repository's code
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       # Generate docker tags
       - name: Docker meta
         id: meta
-        uses: docker/metadata-action@v4
+        uses: docker/metadata-action@v5
         with:
           images: ghcr.io/dmunozv04/isponsorblocktv, dmunozv04/isponsorblocktv
           tags: |
@@ -42,32 +42,32 @@ jobs:
 
       # https://github.com/docker/setup-qemu-action
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
+        uses: docker/setup-qemu-action@v3
       # https://github.com/docker/setup-buildx-action
       - name: Set up Docker Buildx
         id: buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
 
       - name: Login to DockerHub
         if: github.event_name != 'pull_request'
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
 
       - name: Login to GHCR
         if: github.event_name != 'pull_request'
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           registry: ghcr.io
           username: ${{ github.repository_owner }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Build and push
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
-          platforms: linux/amd64, linux/arm64
+          platforms: linux/amd64, linux/arm64, linux/arm/v7
           push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}

.github/workflows/release.yml

@@ -0,0 +1,198 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Release Package
+
+on:
+  push:
+    branches:
+      - '*'
+    tags:
+      - 'v*'
+  pull_request:
+    branches:
+      - '*'
+  release:
+    types: [published]
+
+defaults:
+  run:
+    shell: bash
+
+env:
+  PYTHON_VERSION: "3.11"
+permissions:
+  contents: read
+jobs:
+  build-sdist-and-wheel:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+
+    - name: Set up Python ${{ env.PYTHON_VERSION }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ env.PYTHON_VERSION }}
+
+    - name: Install Hatch
+      run: |
+        python -m pip install --upgrade pip
+        pip install hatch
+
+    - name: Build package
+      run: python -m hatch build
+
+    - name: Upload artifact
+      uses: actions/upload-artifact@v4
+      with:
+        name: sdist-and-wheel
+        path: dist/*
+        if-no-files-found: error
+
+
+  build-binaries:
+    name: Build binaries for ${{ matrix.job.target }} (${{ matrix.job.os }})
+    needs:
+      - build-sdist-and-wheel
+    runs-on: ${{ matrix.job.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        job:
+        # Linux
+        - target: x86_64-unknown-linux-gnu
+          os: ubuntu-latest
+          cross: true
+          release_suffix: x86_64-linux
+        - target: aarch64-unknown-linux-gnu
+          os: ubuntu-latest
+          cross: true
+          release_suffix: aarch64-linux
+        # Windows
+        - target: x86_64-pc-windows-msvc
+          os: windows-2022
+          release_suffix: x86_64-windows
+        # macOS
+        - target: aarch64-apple-darwin
+          os: macos-14
+          release_suffix: aarch64-osx
+        - target: x86_64-apple-darwin
+          os: macos-12
+          release_suffix: x86_64-osx
+
+    env:
+      PYAPP_PASS_LOCATION: "1"
+      PYAPP_UV_ENABLED: "1"
+      HATCH_BUILD_LOCATION: dist
+      CARGO: cargo
+      CARGO_BUILD_TARGET: ${{ matrix.job.target }}
+      PYAPP_REPO: pyapp # Use local copy of pyapp (needed for cross-compiling)
+      PYAPP_VERSION: v0.23.0
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+
+    - name: Clone PyApp
+      run: git clone --depth 1 --branch $PYAPP_VERSION https://github.com/ofek/pyapp $PYAPP_REPO
+
+    - name: Set up Python ${{ env.PYTHON_VERSION }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ env.PYTHON_VERSION }}
+
+    - name: Install Hatch
+      run: |
+        python -m pip install --upgrade pip
+        pip install hatch
+
+    - name: Install Rust toolchain
+      if: ${{ !matrix.job.cross }}
+      uses: dtolnay/rust-toolchain@stable
+      with:
+        targets: ${{ matrix.job.target }}
+
+    - name: Set up cross compiling tools
+      if: matrix.job.cross
+      uses: taiki-e/setup-cross-toolchain-action@v1
+      with:
+        target: ${{ matrix.job.target}}
+
+    - name: Show toolchain information
+      run: |-
+        rustup toolchain list
+        rustup default
+        rustup -V
+        rustc -V
+        cargo -V
+        hatch --version
+
+    - name: Get artifact
+      uses: actions/download-artifact@v4
+      with:
+        name: sdist-and-wheel
+        path: ${{ github.workspace }}/dist
+        merge-multiple: true
+
+    - name: Build Binary
+      working-directory: ${{ github.workspace }}
+      run: |-
+        current_version=$(hatch version)
+        PYAPP_PROJECT_PATH="${{ github.workspace }}/dist/isponsorblocktv-${current_version}-py3-none-any.whl" hatch -v build -t binary
+
+    - name: Rename binary
+      working-directory: ${{ github.workspace }}
+      run: |-
+        mv dist/binary/iSponsorBlockTV* dist/binary/iSponsorBlockTV-${{ matrix.job.release_suffix }}
+
+    - name: Upload built binary package
+      uses: actions/upload-artifact@v4
+      with:
+        name: binaries-${{ matrix.job.release_suffix }}
+        path: dist/binary/*
+        if-no-files-found: error
+
+
+  publish-to-pypi:
+    needs: build-sdist-and-wheel
+    permissions:
+      id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
+    # only run step if the event is a published release
+    if: github.event_name == 'release' && github.event.action == 'published'
+    runs-on: ubuntu-latest
+    steps:
+    - name: Get artifact
+      uses: actions/download-artifact@v4
+      with:
+        name: sdist-and-wheel
+        path: dist
+        merge-multiple: true
+
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@release/v1
+
+
+  publish-to-release:
+    permissions:
+      contents: write
+    needs:
+      - build-sdist-and-wheel
+      - build-binaries
+    if: github.event_name == 'release' && github.event.action == 'published'
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/download-artifact@v4
+      name: Get artifact
+      with:
+        path: dist
+        merge-multiple: true
+    - name: Add assets to release
+      uses: softprops/action-gh-release@v2
+      with:
+        files: dist/*

.github/workflows/release_pypi.yml

@@ -1,37 +0,0 @@
-# This workflow will upload a Python Package using Twine when a release is created
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
-
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-
-name: Upload Python Package
-
-on:
-  release:
-    types: [published]
-
-permissions:
-  contents: read
-  id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
-jobs:
-  deploy:
-
-    runs-on: ubuntu-latest
-
-    steps:
-    - name: Checkout
-      uses: actions/checkout@v3
-    - name: Set up Python
-      uses: actions/setup-python@v3
-      with:
-        python-version: '3.11'
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install build wheel
-    - name: Build package
-      run: python -m build
-    - name: Publish package
-      uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/update_docker_readme.yml

@@ -22,7 +22,7 @@ jobs:
 
           # Update description
       - name: Update repo description
-        uses: peter-evans/dockerhub-description@v3
+        uses: peter-evans/dockerhub-description@v4
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}

Dockerfile

@@ -1,5 +1,7 @@
 # syntax=docker/dockerfile:1
-FROM python:3.11-alpine3.19 as compiler
+FROM python:3.11-alpine3.19 AS base
+
+FROM base AS compiler
 
 WORKDIR /app
 
@@ -8,18 +10,26 @@ COPY src .
 RUN python3 -m compileall -b -f . && \
     find . -name "*.py" -type f -delete
 
-FROM python:3.11-alpine3.19
+FROM base AS dep_installer
+
+COPY requirements.txt .
+
+RUN apk add --no-cache gcc musl-dev && \
+    pip install --upgrade pip wheel && \
+    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 {} +
+
+FROM base
 
 ENV PIP_NO_CACHE_DIR=off iSPBTV_docker=True iSPBTV_data_dir=data TERM=xterm-256color COLORTERM=truecolor
 
 COPY requirements.txt .
 
-RUN pip install --upgrade pip wheel && \
-    pip install -r requirements.txt && \
-    pip uninstall -y pip wheel && \
-    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 {} +
+COPY --from=dep_installer /usr/local /usr/local
 
 WORKDIR /app
 

config.json.template

@@ -12,10 +12,12 @@
     "skip_count_tracking": true,
     "mute_ads": true,
     "skip_ads": true,
+    "auto_play": true,
     "apikey": "",
     "channel_whitelist": [
         {"id": "",
         "name": ""
         }
-    ]
+    ],
+    "api_server": "https://sponsor.ajay.app"
 }

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "iSponsorBlockTV"
-version = "2.0.6"
+version = "2.2.1"
 authors = [
     {"name" = "dmunozv04"}
 ]

requirements.txt

@@ -1,10 +1,11 @@
-aiohttp==3.9.0
+aiohttp==3.9.5
 appdirs==1.4.4
 argparse==1.4.0
 async-cache==1.1.1
-pyytlounge==1.6.3
-rich==13.6.0
+pyytlounge==2.0.0
+rich==13.7.1
 ssdp==1.3.0
-textual==0.40.0
+textual==0.58.0
 textual-slider==0.1.1
 xmltodict==0.13.0
+rich_click==1.8.3

src/iSponsorBlockTV/api_helpers.py

@@ -27,6 +27,7 @@ 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)
@@ -130,7 +131,7 @@ class ApiHelper:
             "service": constants.SponsorBlock_service,
         }
         headers = {"Accept": "application/json"}
-        url = constants.SponsorBlock_api + "skipSegments/" + vid_id_hashed
+        url = self.api_server + "/api/skipSegments/" + vid_id_hashed
         async with self.web_session.get(
             url, headers=headers, params=params
         ) as response:
@@ -201,7 +202,7 @@ class ApiHelper:
         Lets the contributor know that someone skipped the segment (thanks)"""
         if self.skip_count_tracking:
             for i in uuids:
-                url = constants.SponsorBlock_api + "viewedVideoSponsorTime/"
+                url = self.api_server + "/api/viewedVideoSponsorTime/"
                 params = {"UUID": i}
                 await self.web_session.post(url, params=params)
 

src/iSponsorBlockTV/config_setup.py

@@ -4,13 +4,54 @@ 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(
-            "Enter pairing code (found in Settings - Link with TV code): "
-        )
+        pairing_code = input(PAIRING_CODE_PROMPT)
         pairing_code = int(
             pairing_code.replace("-", "").replace(" ", "")
         )  # remove dashes and spaces
@@ -33,6 +74,7 @@ async def pair_device():
 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)
@@ -42,59 +84,47 @@ def main(config, debug: bool) -> None:
             " this for more information on how to upgrade to V2:"
             " \nhttps://github.com/dmunozv04/iSponsorBlockTV/wiki/Migrate-from-V1-to-V2"
         )
-        if (
-            input(
-                "Do you want to remove the legacy 'atvs' entry (the app won't start"
-                " with it present)? (y/n) "
-            )
-            == "y"
-        ):
+        choice = get_yn_input(ATVS_REMOVAL_PROMPT)
+        if choice == "y":
             del config["atvs"]
+
     devices = config.devices
-    while not input(f"Paired with {len(devices)} Device(s). Add more? (y/n) ") == "n":
+    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:
-        if input("API key already specified. Change it? (y/n) ") == "y":
-            apikey = input("Enter your API key: ")
+        choice = get_yn_input(CHANGE_API_KEY_PROMPT)
+        if choice == "y":
+            apikey = input(ENTER_API_KEY_PROMPT)
     else:
-        if (
-            input(
-                "API key only needed for the channel whitelist function. Add it? (y/n) "
-            )
-            == "y"
-        ):
+        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 your API key: ")
+            apikey = input(ENTER_API_KEY_PROMPT)
     config.apikey = apikey
 
     skip_categories = config.skip_categories
     if skip_categories:
-        if input("Skip categories already specified. Change them? (y/n) ") == "y":
-            categories = input(
-                "Enter skip categories (space or comma sepparated) Options: [sponsor"
-                " selfpromo exclusive_access interaction poi_highlight intro outro"
-                " preview filler music_offtopic]:\n"
-            )
+        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 (space or comma sepparated) Options: [sponsor,"
-            " selfpromo, exclusive_access, interaction, poi_highlight, intro, outro,"
-            " preview, filler, music_offtopic:\n"
-        )
+        categories = input(ENTER_SKIP_CATEGORIES_PROMPT)
         skip_categories = categories.replace(",", " ").split(" ")
         skip_categories = [
             x for x in skip_categories if x != ""
@@ -102,21 +132,18 @@ def main(config, debug: bool) -> None:
     config.skip_categories = skip_categories
 
     channel_whitelist = config.channel_whitelist
-    if (
-        input("Do you want to whitelist any channels from being ad-blocked? (y/n) ")
-        == "y"
-    ):
+    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."
             )
-        web_session = aiohttp.ClientSession()
         api_helper = api_helpers.ApiHelper(config, web_session)
         while True:
             channel_info = {}
-            channel = input('Enter a channel name or "/exit" to exit: ')
+            channel = input(SEARCH_CHANNEL_PROMPT)
             if channel == "/exit":
                 break
 
@@ -134,15 +161,14 @@ def main(config, debug: bool) -> None:
             print("5: Enter a custom channel ID")
             print("6: Go back")
 
-            choice = -1
-            choice = input("Select one option of the above [0-6]: ")
-            while choice not in [str(x) for x in range(7)]:
+            while choice := input(SELECT_CHANNEL_PROMPT):
+                if choice in [str(x) for x in range(7)]:
+                    break
                 print("Invalid choice")
-                choice = input("Select one option of the above [0-6]: ")
 
             if choice == "5":
-                channel_info["id"] = input("Enter a channel ID: ")
-                channel_info["name"] = input("Enter the channel name: ")
+                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":
@@ -152,16 +178,25 @@ def main(config, debug: bool) -> None:
             channel_info["name"] = results[int(choice)][1]
             channel_whitelist.append(channel_info)
         # Close web session asynchronously
-        loop.run_until_complete(web_session.close())
 
     config.channel_whitelist = channel_whitelist
 
-    config.skip_count_tracking = (
-        not input(
-            "Do you want to report skipped segments to sponsorblock. Only the segment"
-            " UUID will be sent? (y/n) "
-        )
-        == "n"
-    )
+    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())

src/iSponsorBlockTV/constants.py

@@ -2,7 +2,6 @@ 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 = (
@@ -20,5 +19,4 @@ skip_categories = (
 
 youtube_client_blacklist = ["TVHTML5_FOR_KIDS"]
 
-
 config_file_blacklist_keys = ["config_file", "data_dir"]

src/iSponsorBlockTV/helpers.py

@@ -1,10 +1,10 @@
-import argparse
 import json
 import logging
 import os
 import sys
 import time
 
+import rich_click as click
 from appdirs import user_data_dir
 
 from . import config_setup, main, setup_wizard
@@ -41,6 +41,8 @@ class Config:
         self.skip_count_tracking = True
         self.mute_ads = False
         self.skip_ads = False
+        self.auto_play = True
+        self.api_server = "https://sponsor.ajay.app"
         self.__load()
 
     def validate(self):
@@ -125,35 +127,93 @@ class Config:
         return False
 
 
-def app_start():
-    # If env has a data dir use that, otherwise use the default
-    default_data_dir = os.getenv("iSPBTV_data_dir") or user_data_dir(
-        "iSponsorBlockTV", "dmunozv04"
-    )
-    parser = argparse.ArgumentParser(description="iSponsorblockTV")
-    parser.add_argument(
-        "--data-dir", "-d", default=default_data_dir, help="data directory"
-    )
-    parser.add_argument(
-        "--setup", "-s", action="store_true", help="setup the program graphically"
-    )
-    parser.add_argument(
-        "--setup-cli",
-        "-sc",
-        action="store_true",
-        help="setup the program in the command line",
-    )
-    parser.add_argument("--debug", action="store_true", help="debug mode")
-    args = parser.parse_args()
-
-    config = Config(args.data_dir)
-    if args.debug:
+@click.group(invoke_without_command=True)
+@click.option(
+    "--data",
+    "-d",
+    default=lambda: os.getenv("iSPBTV_data_dir")
+    or user_data_dir("iSponsorBlockTV", "dmunozv04"),
+    help="data directory",
+)
+@click.option("--debug", is_flag=True, help="debug mode")
+# legacy commands as arguments
+@click.option(
+    "--setup", is_flag=True, help="Setup the program graphically", hidden=True
+)
+@click.option(
+    "--setup-cli",
+    is_flag=True,
+    help="Setup the program in the command line",
+    hidden=True,
+)
+@click.pass_context
+def cli(ctx, data, debug, setup, setup_cli):
+    """iSponsorblockTV"""
+    ctx.ensure_object(dict)
+    ctx.obj["data_dir"] = data
+    ctx.obj["debug"] = debug
+    if debug:
         logging.basicConfig(level=logging.DEBUG)
-    if args.setup:  # Set up the config file graphically
-        setup_wizard.main(config)
-        sys.exit()
-    if args.setup_cli:  # Set up the config file
-        config_setup.main(config, args.debug)
-    else:
-        config.validate()
-        main.main(config, args.debug)
+    if ctx.invoked_subcommand is None:
+        if setup:
+            ctx.invoke(setup_command)
+        elif setup_cli:
+            ctx.invoke(setup_cli_command)
+        else:
+            ctx.invoke(start)
+
+
+@cli.command()
+@click.pass_context
+def setup(ctx):
+    """Setup the program graphically"""
+    config = Config(ctx.obj["data_dir"])
+    setup_wizard.main(config)
+    sys.exit()
+
+
+setup_command = setup
+
+
+@cli.command()
+@click.pass_context
+def setup_cli(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):
+    """Start the main program"""
+    config = Config(ctx.obj["data_dir"])
+    config.validate()
+    main.main(config, ctx.obj["debug"])
+
+
+# Create fake "self" group to show pyapp options in help menu
+# Subcommands remove, restore, update
+pyapp_group = click.RichGroup("self", help="pyapp options (update, remove, restore)")
+pyapp_group.add_command(
+    click.RichCommand("update", help="Update the package to the latest version")
+)
+pyapp_group.add_command(
+    click.Command(
+        "remove", help="Remove the package, wiping the installation but not the data"
+    )
+)
+pyapp_group.add_command(
+    click.RichCommand(
+        "restore", help="Restore the package to its original state by reinstalling it"
+    )
+)
+if os.getenv("PYAPP"):
+    cli.add_command(pyapp_group)
+
+
+def app_start():
+    cli(obj={})

src/iSponsorBlockTV/logging_helpers.py

@@ -1,160 +0,0 @@
-import logging
-
-from rich.logging import RichHandler
-from rich.style import Style
-from rich.text import Text
-
-"""
-Copyright (c) 2020 Will McGugan
-
-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 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 rich (https://github.com/textualize/rich)
-"""
-
-
-class LogHandler(RichHandler):
-    def __init__(self, device_name, log_name_len, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        self.filter_strings = []
-        self._log_render = LogRender(
-            device_name=device_name,
-            log_name_len=log_name_len,
-            show_time=True,
-            show_level=True,
-            show_path=False,
-            time_format="[%x %X]",
-            omit_repeated_times=True,
-            level_width=None,
-        )
-
-    def add_filter_string(self, s):
-        self.filter_strings.append(s)
-
-    def _filter(self, s):
-        for i in self.filter_strings:
-            s = s.replace(i, "REDACTED")
-        return s
-
-    def format(self, record):
-        original = super().format(record)
-        return self._filter(original)
-
-
-class LogRender:
-    def __init__(
-        self,
-        device_name,
-        log_name_len,
-        show_time=True,
-        show_level=False,
-        show_path=True,
-        time_format="[%x %X]",
-        omit_repeated_times=True,
-        level_width=8,
-    ):
-        self.filter_strings = []
-        self.log_name_len = log_name_len
-        self.device_name = device_name
-        self.show_time = show_time
-        self.show_level = show_level
-        self.show_path = show_path
-        self.time_format = time_format
-        self.omit_repeated_times = omit_repeated_times
-        self.level_width = level_width
-        self._last_time = None
-
-    def __call__(
-        self,
-        console,
-        renderables,
-        log_time,
-        time_format=None,
-        level="",
-        path=None,
-        line_no=None,
-        link_path=None,
-    ):
-        from rich.containers import Renderables
-        from rich.table import Table
-
-        output = Table.grid(padding=(0, 1))
-        output.expand = True
-        if self.show_time:
-            output.add_column(style="log.time")
-        if self.show_level:
-            output.add_column(style="log.level", width=self.level_width)
-        output.add_column(
-            width=self.log_name_len, style=Style(color="yellow"), overflow="fold"
-        )
-        output.add_column(ratio=1, style="log.message", overflow="fold")
-        if self.show_path and path:
-            output.add_column(style="log.path")
-        row = []
-        if self.show_time:
-            log_time = log_time or console.get_datetime()
-            time_format = time_format or self.time_format
-            if callable(time_format):
-                log_time_display = time_format(log_time)
-            else:
-                log_time_display = Text(log_time.strftime(time_format))
-            if log_time_display == self._last_time and self.omit_repeated_times:
-                row.append(Text(" " * len(log_time_display)))
-            else:
-                row.append(log_time_display)
-                self._last_time = log_time_display
-        if self.show_level:
-            row.append(level)
-        row.append(Text(self.device_name))
-        row.append(Renderables(renderables))
-        if self.show_path and path:
-            path_text = Text()
-            path_text.append(
-                path, style=f"link file://{link_path}" if link_path else ""
-            )
-            if line_no:
-                path_text.append(":")
-                path_text.append(
-                    f"{line_no}",
-                    style=f"link file://{link_path}#{line_no}" if link_path else "",
-                )
-            row.append(path_text)
-
-        output.add_row(*row)
-        return output
-
-
-class LogFormatter(logging.Formatter):
-    def __init__(
-        self, fmt=None, datefmt=None, style="%", validate=True, filter_strings=None
-    ):
-        super().__init__(fmt, datefmt, style, validate)
-        self.filter_strings = filter_strings or []
-
-    def add_filter_string(self, s):
-        self.filter_strings.append(s)
-
-    def _filter(self, s):
-        print(s)
-        for i in self.filter_strings:
-            s = s.replace(i, "REDACTED")
-        return s
-
-    def format(self, record):
-        original = logging.Formatter.format(self, record)
-        return self._filter(original)

src/iSponsorBlockTV/main.py

@@ -5,29 +5,31 @@ from signal import SIGINT, SIGTERM, signal
 from typing import Optional
 
 import aiohttp
-import rich
 
-from . import api_helpers, logging_helpers, ytlounge
+from . import api_helpers, ytlounge
 
 
 class DeviceListener:
-    def __init__(self, api_helper, config, device, log_name_len, debug: bool):
+    def __init__(self, api_helper, config, device, debug: bool, web_session):
         self.task: Optional[asyncio.Task] = None
         self.api_helper = api_helper
         self.offset = device.offset
         self.name = device.name
         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)
-        rh = logging_helpers.LogHandler(device.name, log_name_len, level=logging.DEBUG)
-        rh.add_filter_string(device.screen_id)
-        self.logger.addHandler(rh)
+        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
+            device.screen_id, config, api_helper, self.logger, self.web_session
         )
 
     # Ensures that we have a valid auth token
@@ -50,13 +52,13 @@ class DeviceListener:
     # Main subscription loop
     async def loop(self):
         lounge_controller = self.lounge_controller
-        while not lounge_controller.linked():
-            try:
-                self.logger.debug("Refreshing auth")
-                await lounge_controller.refresh_auth()
-            except:
-                await asyncio.sleep(10)
         while not self.cancelled:
+            while not lounge_controller.linked():
+                try:
+                    self.logger.debug("Refreshing auth")
+                    await lounge_controller.refresh_auth()
+                except:
+                    await asyncio.sleep(10)
             while not (await self.is_available()) and not self.cancelled:
                 await asyncio.sleep(10)
             try:
@@ -74,7 +76,7 @@ class DeviceListener:
                 "Connected to device %s (%s)", lounge_controller.screen_name, self.name
             )
             try:
-                # print("Subscribing to lounge")
+                self.logger.info("Subscribing to lounge")
                 sub = await lounge_controller.subscribe_monitored(self)
                 await sub
             except:
@@ -153,16 +155,16 @@ def main(config, debug):
     tcp_connector = aiohttp.TCPConnector(ttl_dns_cache=300)
     web_session = aiohttp.ClientSession(loop=loop, connector=tcp_connector)
     api_helper = api_helpers.ApiHelper(config, web_session)
-    longest_name_len = len(list(sorted([i.name for i in config.devices]))[-1])
     for i in config.devices:
-        device = DeviceListener(api_helper, config, i, longest_name_len, debug)
+        device = DeviceListener(api_helper, config, i, debug, web_session)
         devices.append(device)
         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())
-    rich.reconfigure(color_system="standard")
     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())
+    loop.close()

src/iSponsorBlockTV/setup-wizard-style.tcss

@@ -363,3 +363,9 @@ MigrationScreen {
     width: 1fr;
     content-align: center middle;
 }
+
+/* Autoplay */
+#autoplay-container{
+    padding: 1;
+    height: auto;
+}

src/iSponsorBlockTV/setup_wizard.py

@@ -102,7 +102,6 @@ class Device(Element):
     """A device element."""
 
     def process_values_from_data(self):
-        print("HIIII")
         print(self.element_data)
         if "name" in self.element_data and self.element_data["name"]:
             self.element_name = self.element_data["name"]
@@ -235,8 +234,8 @@ class AddDevice(ModalWithClickExit):
     def __init__(self, config, **kwargs) -> None:
         super().__init__(**kwargs)
         self.config = config
-        web_session = aiohttp.ClientSession()
-        self.api_helper = api_helpers.ApiHelper(config, web_session)
+        self.web_session = aiohttp.ClientSession()
+        self.api_helper = api_helpers.ApiHelper(config, self.web_session)
         self.devices_discovered_dial = []
 
     def compose(self) -> ComposeResult:
@@ -337,7 +336,9 @@ class AddDevice(ModalWithClickExit):
     @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")
+        lounge_controller = ytlounge.YtLoungeApi(
+            "iSponsorBlockTV", web_session=self.web_session
+        )
         pairing_code = self.query_one("#pairing-code-input").value
         pairing_code = int(
             pairing_code.replace("-", "").replace(" ", "")
@@ -849,6 +850,57 @@ class ChannelWhitelistManager(Vertical):
         self.app.push_screen(AddChannel(self.config), callback=self.new_channel)
 
 
+class AutoPlayManager(Vertical):
+    """Manager for autoplay, allows enabling/disabling autoplay."""
+
+    def __init__(self, config, **kwargs) -> None:
+        super().__init__(**kwargs)
+        self.config = config
+
+    def compose(self) -> ComposeResult:
+        yield Label("Autoplay", classes="title")
+        yield Label(
+            "This feature allows you to enable/disable autoplay",
+            classes="subtitle",
+            id="autoplay-subtitle",
+        )
+        with Horizontal(id="autoplay-container"):
+            yield Checkbox(
+                value=self.config.auto_play,
+                id="autoplay-switch",
+                label="Enable autoplay",
+            )
+
+    @on(Checkbox.Changed, "#autoplay-switch")
+    def changed_skip(self, event: Checkbox.Changed):
+        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"""
 
@@ -885,6 +937,12 @@ class ISponsorBlockTVSetupMainScreen(Screen):
             yield ApiKeyManager(
                 config=self.config, id="api-key-manager", classes="container"
             )
+            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():

src/iSponsorBlockTV/ytlounge.py

@@ -2,6 +2,7 @@ import asyncio
 import json
 
 import pyytlounge
+from aiohttp import ClientSession
 
 from .constants import youtube_client_blacklist
 
@@ -9,8 +10,17 @@ create_task = asyncio.create_task
 
 
 class YtLoungeApi(pyytlounge.YtLoungeApi):
-    def __init__(self, screen_id, config=None, api_helper=None, logger=None):
+    def __init__(
+        self,
+        screen_id,
+        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
         self.auth.screen_id = screen_id
         self.auth.lounge_id_token = None
         self.api_helper = api_helper
@@ -20,9 +30,12 @@ class YtLoungeApi(pyytlounge.YtLoungeApi):
         self.callback = None
         self.logger = logger
         self.shorts_disconnected = False
+        self.auto_play = True
         if config:
             self.mute_ads = config.mute_ads
             self.skip_ads = config.skip_ads
+            self.auto_play = config.auto_play
+        self._command_mutex = asyncio.Lock()
 
     # Ensures that we still are subscribed to the lounge
     async def _watchdog(self):
@@ -67,23 +80,23 @@ class YtLoungeApi(pyytlounge.YtLoungeApi):
             data = args[0]
             # Unmute when the video starts playing
             if self.mute_ads and data.get("state", "0") == "1":
-                # print("Ad has ended, unmuting")
+                self.logger.info("Ad has ended, unmuting")
                 create_task(self.mute(False, override=True))
         elif event_type == "onAdStateChange":
             data = args[0]
             if data["adState"] == "0":  # Ad is not playing
-                # print("Ad has ended, unmuting")
+                self.logger.info("Ad has ended, unmuting")
                 create_task(self.mute(False, override=True))
             elif (
                 self.skip_ads and data["isSkipEnabled"] == "true"
             ):  # YouTube uses strings for booleans
-                self._logger.info("Ad can be skipped, skipping")
+                self.logger.info("Ad can be skipped, skipping")
                 create_task(self.skip_ad())
                 create_task(self.mute(False, override=True))
             elif (
                 self.mute_ads
             ):  # Seen multiple other adStates, assuming they are all ads
-                self._logger.info("Ad has started, muting")
+                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)
         elif event_type == "onVolumeChanged":
@@ -94,7 +107,7 @@ class YtLoungeApi(pyytlounge.YtLoungeApi):
             if len(args) > 0 and (
                 vid_id := args[0]["videoId"]
             ):  # if video id is not empty
-                print(f"Getting segments for next video: {vid_id}")
+                self.logger.info(f"Getting segments for next video: {vid_id}")
                 create_task(self.api_helper.get_segments(vid_id))
 
         # #Used to know if an ad is skippable or not
@@ -102,18 +115,18 @@ class YtLoungeApi(pyytlounge.YtLoungeApi):
             data = args[0]
             # Gets segments for the next video (after the ad) before it starts playing
             if vid_id := data["contentVideoId"]:
-                self._logger.info(f"Getting segments for next video: {vid_id}")
+                self.logger.info(f"Getting segments for next video: {vid_id}")
                 create_task(self.api_helper.get_segments(vid_id))
             elif (
                 self.skip_ads and data["isSkipEnabled"] == "true"
             ):  # YouTube uses strings for booleans
-                self._logger.info("Ad can be skipped, skipping")
+                self.logger.info("Ad can be skipped, skipping")
                 create_task(self.skip_ad())
                 create_task(self.mute(False, override=True))
             elif (
                 self.mute_ads
             ):  # Seen multiple other adStates, assuming they are all ads
-                self._logger.info("Ad has started, muting")
+                self.logger.info("Ad has started, muting")
                 create_task(self.mute(True, override=True))
 
         elif event_type == "loungeStatus":
@@ -133,9 +146,14 @@ class YtLoungeApi(pyytlounge.YtLoungeApi):
                 self.shorts_disconnected = False
                 create_task(self.play_video(video_id_saved))
         elif event_type == "loungeScreenDisconnected":
-            data = args[0]
-            if data["reason"] == "disconnectedByUserScreenInitiated":  # Short playing?
-                self.shorts_disconnected = True
+            if args:  # Sometimes it's empty
+                data = args[0]
+                if (
+                    data["reason"] == "disconnectedByUserScreenInitiated"
+                ):  # Short playing?
+                    self.shorts_disconnected = True
+        elif event_type == "onAutoplayModeChanged":
+            create_task(self.set_auto_play_mode(self.auto_play))
 
         super()._process_event(event_id, event_type, args)
 
@@ -167,3 +185,9 @@ class YtLoungeApi(pyytlounge.YtLoungeApi):
 
     async def play_video(self, video_id: str) -> bool:
         return await self._command("setPlaylist", {"videoId": video_id})
+
+    # 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)