Merge branch 'main' into feature-device-name

.deepsource.toml

@@ -5,4 +5,4 @@ name = "python"
 enabled = true
 
   [analyzers.meta]
-  runtime_version = "3.x.x"
+  runtime_version = "3.x.x"

.dockerignore

@@ -0,0 +1,9 @@
+# Ignore files
+.dockerignore
+.gitignore
+.deepsource.toml
+.github
+
+Dockerfile
+docker-compose.yml
+README.md

.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/main.yml → .github/workflows/build_docker_images.yml

@@ -15,61 +15,65 @@ on:
 
   workflow_dispatch:
 
-permissions: 
+permissions:
   contents: read
   packages: write
-  
+
 jobs:
   build:
+    env:
+        DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
     runs-on: ubuntu-latest
     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
+          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
             type=ref,event=tag
             type=ref,event=branch
             type=schedule
-      
+
       # 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@v6
         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 }}
-          cache-from: type=registry,ref=ghcr.io/dmunozv04/isponsorblocktv:buildcache
-          cache-to: type=registry,ref=ghcr.io/dmunozv04/isponsorblocktv:buildcache,mode=max
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

.github/workflows/release.yml

@@ -0,0 +1,205 @@
+# 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.release_suffix }} (${{ 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: 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-latest
+          release_suffix: x86_64-windows
+        # macOS
+        - target: aarch64-apple-darwin
+          os: macos-latest
+          release_suffix: aarch64-osx
+        - target: x86_64-apple-darwin
+          os: macos-latest
+          cross: true
+          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_DISTRIBUTION_VARIANT_CPU: ${{ matrix.job.cpu_variant }}
+      PYAPP_REPO: pyapp # Use local copy of pyapp (needed for cross-compiling)
+      PYAPP_VERSION: v0.24.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/update_docker_readme.yml

@@ -22,9 +22,9 @@ 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 }}
           repository: dmunozv04/isponsorblocktv
-          short-description: ${{ github.event.repository.description }}
+          short-description: ${{ github.event.repository.description }}

.gitignore

@@ -159,4 +159,4 @@ data/config.json
 
 .DS_Store
 
-.DS_Store
+.DS_Store

.markdownlintignore

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