@bharper/atv-js 0.2.6 → 0.3.4

package/pyatv/.github/ISSUE_TEMPLATE/investigation.yml

@@ -0,0 +1,16 @@
+name: Investigation
+description: Use for investigations or if something is unclear before creating an implementation proposal
+labels: [investigate]
+body:
+  - type: textarea
+    id: to-investigate
+    attributes:
+      label: What to investigate?
+    validations:
+      required: true
+  - type: textarea
+    id: expected-outcome
+    attributes:
+      label: Expected outcome
+    validations:
+      required: true

package/pyatv/.github/ISSUE_TEMPLATE/minor-change.yml

@@ -0,0 +1,10 @@
+name: Minor Change
+description: Use this to suggest minor changes to code or documentation.
+body:
+  - type: textarea
+    id: minor-change
+    attributes:
+      label: What to change?
+      description: Please describe in as much detail as possible what to change.
+    validations:
+      required: true

package/pyatv/.github/ISSUE_TEMPLATE/question-or-idea.yml

@@ -0,0 +1,11 @@
+name: Question or support
+description: If you are using pyatv and have questions regarding how to use it in any way (e.g. development), use this template.
+labels: [question]
+body:
+  - type: textarea
+    id: question-support
+    attributes:
+      label: What do you need help with?
+      description: Please enter your question below. Make sure to include software versions, error logs, etc. when applicable. The more information you provide, the easier it will be to help.
+    validations:
+      required: true

package/pyatv/.github/dependabot.yml

@@ -0,0 +1,26 @@
+version: 2
+updates:
+- package-ecosystem: pip
+  directory: "/requirements"
+  schedule:
+    interval: daily
+    time: "04:00"
+  open-pull-requests-limit: 10
+  reviewers:
+  - postlund
+  assignees:
+  - postlund
+  labels:
+  - dependencies
+- package-ecosystem: docker
+  directory: /
+  schedule:
+    interval: daily
+    time: "04:00"
+  open-pull-requests-limit: 3
+  reviewers:
+    - postlund
+  assignees:
+    - postlund
+  labels:
+    - dependencies

package/pyatv/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,71 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '36 5 * * 5'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'python' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more:
+        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

package/pyatv/.github/workflows/release.yml

@@ -0,0 +1,160 @@
+name: Publish containers and make release
+
+on:
+  push:
+    branches: ['master', 'test_release_branch']
+    tags:
+      - '*'
+  workflow_dispatch:
+
+env:
+  REGISTRY: ghcr.io
+  PYTHON_VERSION: 3.12
+
+jobs:
+  build_containers:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Cargo download work-around
+        run: |
+          mkdir -p ~/.cargo
+          cat <<EOF > ~/.cargo/config.toml
+          [net]
+          git-fetch-with-cli = true
+          EOF
+
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+
+      - name: Set up Buildx
+        id: buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Build wheel
+        id: wheel
+        run: |
+          # If not a release branch, add SHA1 to patch version
+          if [ "$(python scripts/version.py is_release)" = "false" ]; then
+            python scripts/version.py sha1
+          fi
+
+          python -m pip install --upgrade build
+          python -m build
+          echo "version=$(python scripts/version.py get)" >> $GITHUB_OUTPUT
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@v2
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: ${{ env.REGISTRY }}/${{ github.repository }}
+          labels: |
+            org.opencontainers.image.ref.name=${{ github.ref }}
+          tags: |
+            type=ref,event=branch
+            type=ref,event=pr,
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=sha
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          builder: ${{ steps.buildx.outputs.name }}
+          platforms: linux/amd64,linux/arm64
+          push: true
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          build-args: |
+            VERSION=${{ steps.wheel.outputs.version }}
+
+      - name: Upload built artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: packages
+          path: |
+            dist
+
+  make_release:
+    if: ${{ startsWith(github.ref, 'refs/tags/v') }}
+    needs: build_containers
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Download pre-built packages
+        uses: actions/download-artifact@v4.1.7
+        with:
+          name: packages
+          path: dist
+
+      - name: Extract release notes and name
+        id: info
+        shell: python {0}
+        run: |
+          import os
+          import re
+
+          name = None
+          version = None
+          notes = ""
+          with open("CHANGES.md", "r", encoding="utf-8") as handle:
+            for line in handle:
+              if line.startswith("##"):
+                if name is None:
+                  version, name = re.match(r"## ([0-9.]+) ([^(]+) \(.*", line).groups()
+                else:
+                  break
+              if name is not None:
+                notes += line
+
+          with open(os.environ["GITHUB_OUTPUT"], "a", encoding="utf-8") as fh:
+              fh.writelines([f"name={name}\n", f"version={version}\n"])
+
+          with open("notes.md", "w", encoding="utf-8") as handle:
+            handle.write(notes)
+
+      - name: Publish release
+        uses: ncipollo/release-action@v1
+        with:
+          artifacts: "dist/pyatv-${{ steps.info.outputs.version }}.tar.gz,dist/pyatv-${{ steps.info.outputs.version }}-*.whl"
+          bodyFile: "notes.md"
+          token: ${{ secrets.GITHUB_TOKEN }}
+          draft: false
+          tag: v${{ steps.info.outputs.version }}
+          name: ${{ steps.info.outputs.name }}
+
+      - name: Publish distribution to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}
+          skip_existing: true

package/pyatv/.github/workflows/tests.yml

@@ -0,0 +1,104 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: >-
+      ${{ matrix.python-version }}
+      /
+      ${{ matrix.platform }}
+      /
+      (regression: ${{ matrix.regression }})
+    runs-on: ${{ matrix.platform }}
+    env:
+      CACHE_INVALIDATE: "v4"
+      CACHE_KEY: ${{ github.run_id }}-${{ github.job }}-${{ matrix.python-version }}-${{ matrix.platform }}-${{ matrix.regression }}
+    strategy:
+      matrix:
+        # https://help.github.com/articles/virtual-environments-for-github-actions
+        platform:
+          - ubuntu-latest
+          - macos-latest
+          - windows-latest
+        python-version:
+          - "3.9"
+          - "3.10"
+          - "3.11"
+          - "3.12"
+          - "3.13"
+          - "3.14"
+        chickn-args:
+          - "--no-venv"
+        regression:
+          - false
+        include:
+          - platform: ubuntu-latest
+            python-version: 3.9
+            chickn-args: "--no-venv -v requirements_file=base_versions.txt"
+            regression: true
+    steps:
+    # Receipe for not running jobs again when re-running workflow
+    # https://medium.com/xcnotes/how-to-re-run-only-failed-jobs-on-github-actions-b79b13d1ceb2
+    - id: timestamp
+      shell: bash
+      run: echo "::set-output name=timestamp::$(timestamp +%s)"
+    - name: Restore the previous run result
+      uses: actions/cache@v4
+      with:
+        path: |
+          run_result
+        key: ${{ env.CACHE_KEY }}-${{ steps.timestamp.outputs.timestamp }}
+        restore-keys: |
+          ${{ env.CACHE_KEY }}-
+    - id: run_result
+      shell: bash
+      run: cat run_result 2>/dev/null || echo 'default'
+
+    # Regular flow continues here
+    - uses: actions/checkout@v2
+      if: steps.run_result.outputs.run_result != 'success'
+      with:
+        fetch-depth: 2
+    - name: Set up Python ${{ matrix.python-version }}
+      if: steps.run_result.outputs.run_result != 'success'
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - uses: syphar/restore-virtualenv@v1
+      if: steps.run_result.outputs.run_result != 'success'
+      id: cache-virtualenv
+      with:
+        custom_cache_key_element: ${{ env.CACHE_INVALIDATE }}
+        requirement_files: |
+          **/*.txt
+          **/requirements/**.txt
+
+    - uses: syphar/restore-pip-download-cache@v1
+      if: steps.run_result.outputs.run_result != 'success' && steps.cache-virtualenv.outputs.cache-hit != 'true'
+
+    - name: Install dependencies
+      if: steps.run_result.outputs.run_result != 'success'
+      run: |
+        python -m pip install --upgrade setuptools pip pyyaml
+    - name: Test with chickn
+      if: steps.run_result.outputs.run_result != 'success'
+      run: python ./scripts/chickn.py -t miniaudio -t ${{ matrix.python-version }} ${{ matrix.chickn-args }}
+      shell: bash
+    - name: Upload coverage to Codecov
+      if: steps.run_result.outputs.run_result != 'success'
+      uses: codecov/codecov-action@v1
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        file: ./coverage.xml
+        name: pyatv
+        fail_ci_if_error: false
+
+    - name: Mark build as successful
+      if: steps.run_result.outputs.run_result != 'success'
+      run: echo "::set-output name=run_result::success" > run_result

package/pyatv/.gitpod.yml

@@ -0,0 +1,23 @@
+image: gitpod/workspace-full
+tasks:
+  - name: Documentation
+    command: ./scripts/build_docs.sh
+  - name: Development
+    before: "echo 'export PIP_USER=no' >> ~/.bashrc && export PIP_USER=no"
+    init: ./scripts/setup_dev_env.sh && source bin/activate; python scripts/chickn.py
+    command: source bin/activate
+
+ports:
+  - port: 4000 # Used for documentation
+    onOpen: open-preview
+    visibility: private
+
+vscode:
+  extensions:
+    - ms-python.python
+    - hbenl.test-adapter-converter
+    - hbenl.vscode-test-explorer
+
+github:
+  prebuilds:
+    addBadge: true