Merge remote-tracking branch 'blueprint/dev' into dev

Limych · Limych · commit c6e970aa373f · 2023-02-09T00:24:24.000+03:00
# Conflicts:
#	LICENSE.md
#	README.md
#	custom_components/integration_blueprint/__init__.py
#	custom_components/integration_blueprint/binary_sensor.py
#	custom_components/integration_blueprint/config_flow.py
#	custom_components/integration_blueprint/const.py
#	custom_components/integration_blueprint/sensor.py
#	custom_components/integration_blueprint/switch.py
#	hacs.json
#	tests/const.py
#	tests/test_config_flow.py
#	tests/test_switch.py
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -48,11 +48,11 @@ jobs:
         # 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.
-        
+
         # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
         # queries: security-extended,security-and-quality
 
-        
+
     # 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
@@ -61,7 +61,7 @@ jobs:
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
 
-    #   If the Autobuild fails above, remove it and uncomment the following three lines. 
+    #   If the Autobuild fails above, remove it and uncomment the following three lines.
     #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
 
     # - run: |
diff --git a/.github/workflows/issue-lock.yml b/.github/workflows/issue-lock.yml
@@ -3,12 +3,20 @@ name: Lock Inactive Threads
 on:
   schedule:
     - cron: '0 5 * * *'
+  workflow_dispatch:
+
+permissions:
+  issues: write
+  pull-requests: write
+
+concurrency:
+  group: lock
 
 jobs:
   lock:
     runs-on: ubuntu-latest
     steps:
-      - uses: dessant/lock-threads@v3
+      - uses: dessant/lock-threads@v4
         with:
           github-token: ${{ github.token }}
           issue-lock-inactive-days: 30
diff --git a/.github/workflows/py-dead-code.yml b/.github/workflows/py-dead-code.yml
@@ -15,7 +15,7 @@ jobs:
           echo "package=$(ls -F | grep \/$ | grep -v "bin\|examples\|tests" | sed -n "s/\///g;1p")" >> $GITHUB_ENV
 
       - name: "Set up Python"
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v4
         with:
           python-version: '3.9'
 
diff --git a/.github/workflows/py-test.yml b/.github/workflows/py-test.yml
@@ -23,7 +23,7 @@ jobs:
           echo "package=$(ls -F | grep \/$ | grep -v "bin\|examples\|tests" | sed -n "s/\///g;1p")" >> $GITHUB_ENV
 
       - name: "Set up Python"
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v4
         with:
           python-version: '3.9'
 
@@ -72,7 +72,7 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
 
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -7,8 +7,8 @@ on:
       - "[v0-9]+.[0-9]+*"
 
 jobs:
-  release_zip_file:
-    name: "Prepare release asset"
+  release:
+    name: "Publish new release"
     runs-on: ubuntu-latest
     steps:
       - name: "Check out repository"
@@ -17,7 +17,7 @@ jobs:
       - working-directory: ./custom_components
         run: |
           echo "package=$(ls -F | grep \/$ | sed -n "s/\///g;1p")" >> $GITHUB_ENV
-          echo "release_version=$(git describe --abbrev=0 | sed s/v//)" >> $GITHUB_ENV
+          echo "release_version=$(git describe --tags | sed s/v//)" >> $GITHUB_ENV
       - working-directory: ./custom_components
         run: |
           echo "basedir=$(pwd)/${{ env.package }}" >> $GITHUB_ENV
@@ -34,34 +34,32 @@ jobs:
         run: |
           zip ${{ env.package }}.zip -r ./
 
-      - name: "Upload zip to release"
+      - name: "Release"
         if: env.release_version != '' && success()
-        uses: svenstaro/upload-release-action@v2
+        uses: softprops/action-gh-release@v1
         with:
-          repo_token: ${{ secrets.GITHUB_TOKEN }}
-          file: ${{ env.basedir }}/${{ env.package }}.zip
-          asset_name: ${{ env.package }}.zip
-          tag: ${{ env.release_version }}
-          overwrite: true
+          files: ${{ env.basedir }}/${{ env.package }}.zip
 
-  releasenotes:
-    name: "Prepare releasenotes"
+  release-notes:
+    name: "Compose release notes"
+    needs: release
     runs-on: ubuntu-latest
     steps:
       - name: "Check out repository"
         uses: actions/checkout@v3
 
       - working-directory: ./custom_components
         run: |
-          echo "release_version=$(git describe --abbrev=0 | sed s/v//)" >> $GITHUB_ENV
+          echo "release_version=$(git describe --tags | sed s/v//)" >> $GITHUB_ENV
 
       - name: "Set up Python"
         if: env.release_version != '' && success()
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v4
         with:
           python-version: 3.9
 
       - name: "Cache pip"
+        if: env.release_version != '' && success()
         uses: actions/cache@v3
         with:
           # This path is specific to Ubuntu
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -5,30 +5,39 @@ repos:
         name: Update manifest.json
         entry: bin/update_manifest
         language: script
-        files: ^custom_components/.+/const\.py$
+        files: ^(custom_components/.+/const\.py|requirements\.txt)$
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.0.241
+    hooks:
+      - id: ruff
+        args:
+          - --fix
+        files: ^(custom_components|bin|tests)/.+\.py$
   - repo: https://github.com/asottile/pyupgrade
-    rev: v2.7.4
+    rev: v3.3.1
     hooks:
       - id: pyupgrade
-        args: [--py37-plus]
+        args: [ --py310-plus ]
+        stages: [manual]
   - repo: https://github.com/psf/black
-    rev: 22.3.0
+    rev: 23.1.0
     hooks:
       - id: black
         args:
           - --safe
           - --quiet
         files: ^(custom_components|bin|tests)/.+\.py$
-  - repo: https://gitlab.com/pycqa/flake8
-    rev: 3.8.1
+  - repo: https://github.com/pycqa/flake8.git
+    rev: 6.0.0
     hooks:
       - id: flake8
         additional_dependencies:
           - flake8-docstrings==1.5.0
           - pydocstyle==5.0.2
         files: ^(custom_components|bin|tests)/.+\.py$
+        stages: [manual]
   - repo: https://github.com/PyCQA/bandit
-    rev: 1.7.0
+    rev: 1.7.4
     hooks:
       - id: bandit
         args:
@@ -37,11 +46,11 @@ repos:
           - --configfile=tests/bandit.yaml
         files: ^(custom_components|bin|tests)/.+\.py$
   - repo: https://github.com/pre-commit/mirrors-isort
-    rev: v5.6.4
+    rev: v5.10.1
     hooks:
       - id: isort
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.5.0
+    rev: v4.4.0
     hooks:
       - id: check-executables-have-shebangs
         stages: [manual]
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -32,4 +32,3 @@
       }
     ]
   }
-  
diff --git a/README.md b/README.md
@@ -183,6 +183,8 @@ The original setup of this component is by [Andrey "Limych" Khrolenok](https://g
 For a full list of all authors and contributors,
 check [the contributor's page][contributors].
 
+This Home Assistant custom component was created and is updated using the [HA-Blueprint template](https://github.com/Limych/ha-blueprint). You can use this template to maintain your own Home Assistant custom components.
+
 ## License
 
 MIT License
diff --git a/bin/release b/bin/release
@@ -119,7 +119,7 @@ log.info "Commit tagged as v$new"
 if echo "${new}" | grep -q "-"; then
     dev=$(bump_prerel "${new}")
 else
-    dev="$(echo "${new}" | awk -F. '/[0-9]+\./{$NF++;print}' OFS=.)-alpha"
+    dev="$(echo "${new}" | awk -F. '/[0-9]+\./{($NF)++;print}' OFS=.)-alpha"
 fi
 
 log.info "Patch files to version '${dev}'..."
diff --git a/bin/setup b/bin/setup
@@ -14,7 +14,9 @@ source ./bin/_common
 
 if [ ! -d "venv" ]; then
     log.info "Initializing the virtual environment..."
-    ${python} -m venv venv
+    # For error 'executable `python` not found' run
+    # rm -Rf ~/.local/share/virtualenv
+    ${python} -m venv ./venv
     source ./venv/bin/activate
     python="${ROOT}/venv/bin/python3"
 fi
diff --git a/bin/update_manifest b/bin/update_manifest
@@ -16,11 +16,13 @@ fi
 
 component=$(ls -q "${ROOT}/custom_components/" | grep -v __ | head -n 1)
 const_path="custom_components/${component}/const.py"
+reqs_path="requirements.txt"
 
 name=$(grep "^NAME: Final =" ${const_path} | sed -E "s/^[^\"]+\"([^\"]*).*$/\\1/")
 domain=$(grep "^DOMAIN: Final =" ${const_path} | sed -E "s/^[^\"]+\"([^\"]*).*$/\\1/")
 version=$(grep "^VERSION: Final =" ${const_path} | sed -E "s/^[^\"]+\"([^\"]*).*$/\\1/")
 issue_url=$(grep "^ISSUE_URL: Final =" ${const_path} | sed -E "s/^[^\"]+\"([^\"]*).*$/\\1/")
+ha_version=$(grep "^homeassistant>=" ${reqs_path} | sed -E "s/^[^=]+=(\S*).*$/\\1/")
 
 log.info "Update manifest.json data..."
 manifest_path="custom_components/${component}/manifest.json"
@@ -29,6 +31,9 @@ sed -i -E "s!(\"domain\": \")[^\"]*!\\1${domain}!" ${manifest_path}
 sed -i -E "s!(\"version\": \")[^\"]*!\\1${version}!" ${manifest_path}
 sed -i -E "s!(\"issue_tracker\": \")[^\"]*!\\1${issue_url}!" ${manifest_path}
 
+bin/update_requirements
+
 log.info "Update hacs.json data..."
 hacs_path="${ROOT}/hacs.json"
 sed -i -E "s!(\"name\": \")[^\"]*!\\1${name}!" ${hacs_path}
+sed -i -E "s!(\"homeassistant\": \")[^\"]*!\\1${ha_version}!" ${hacs_path}
diff --git a/bin/update_requirements b/bin/update_requirements
@@ -25,38 +25,27 @@ def get_package(requre: str) -> str:
     return requre.split(">")[0].split("<")[0].split("!")[0].split("=")[0].split("~")[0]
 
 
-harequire = []
+harequire = ["homeassistant"]
 request = requests.get(
-    "https://raw.githubusercontent.com/home-assistant/core/dev/requirements.txt"
+    "https://raw.githubusercontent.com/home-assistant/core/dev/requirements.txt",
+    timeout=10
 )
 request = request.text.split("\n")
 for req in request:
     if "=" in req:
         harequire.append(get_package(req))
 
-print(harequire)
-
 with open(f"{PKG_PATH}/manifest.json", encoding="utf8") as manifest:
     manifest = json.load(manifest)
-    requirements = []
-    for req in manifest["requirements"]:
-        requirements.append(get_package(req))
-    manifest["requirements"] = requirements
+
 with open(f"{ROOT}/requirements.txt", encoding="utf8") as requirements:
     tmp = requirements.readlines()
     requirements = []
     for req in tmp:
-        requirements.append(req.replace("\n", ""))
-for req in requirements:
-    pkg = get_package(req)
-    if pkg in manifest["requirements"]:
-        manifest["requirements"].remove(pkg)
-        manifest["requirements"].append(req)
-
-for req in manifest["requirements"]:
-    pkg = get_package(req)
-    if pkg in harequire:
-        print(f"{pkg} in HA requirements, no need here.")
-print(json.dumps(manifest["requirements"], indent=4))
+        pkg = get_package(req)
+        if pkg not in harequire:
+            requirements.append(req.replace("\n", ""))
+    manifest["requirements"] = requirements
+
 with open(f"{PKG_PATH}/manifest.json", "w", encoding="utf8") as manifestfile:
     manifestfile.write(json.dumps(manifest, indent=4))
diff --git a/hacs.json b/hacs.json
@@ -2,6 +2,5 @@
     "name": "Indoor Air Quality UK Index",
     "domains": ["sensor"],
     "hacs": "1.6.0",
-    "iot_class": "Assumed State",
-    "homeassistant": "0.118.0"
+    "homeassistant": "2022.10.0"
 }
diff --git a/pylintrc b/pylintrc
@@ -16,7 +16,6 @@ good-names=id,i,j,k,ex,Run,_,fp,T
 # locally-disabled - it spams too much
 # duplicate-code - unavoidable
 # cyclic-import - doesn't test if both import on load
-# abstract-class-little-used - prevents from setting right foundation
 # unused-argument - generic callbacks and setup methods create a lot of warnings
 # too-many-* - are not enforced for the sake of readability
 # too-few-* - same as too-many-*
@@ -26,7 +25,6 @@ good-names=id,i,j,k,ex,Run,_,fp,T
 # wrong-import-order - isort guards this
 disable=
   format,
-  abstract-class-little-used,
   abstract-method,
   cyclic-import,
   duplicate-code,
diff --git a/pyproject.toml b/pyproject.toml
diff --git a/requirements-dev.txt b/requirements-dev.txt
diff --git a/requirements-test.txt b/requirements-test.txt
diff --git a/requirements.txt b/requirements.txt
diff --git a/setup.cfg b/setup.cfg
