[2024] Modernize development environment (devcontainer, pre-commit etc)

.devcontainer/README.md

@@ -41,3 +41,20 @@ Run Home Assistant on port 9123 | Launch Home Assistant with your custom compone
 Run Home Assistant configuration against /config | Check the configuration.
 Upgrade Home Assistant to latest dev | Upgrade the Home Assistant core version in the container to the latest version of the `dev` branch.
 Install a specific version of Home Assistant | Install a specific version of Home Assistant core in the container.
+
+### Step by Step debugging
+
+With the development container,
+you can test your custom component in Home Assistant with step by step debugging.
+
+You need to modify the `configuration.yaml` file in `.devcontainer` folder
+by uncommenting the line:
+
+```yaml
+# debugpy:
+```
+
+Then launch the task `Run Home Assistant on port 9123`, and launch the debugger
+with the existing debugging configuration `Python: Attach Local`.
+
+For more information, look at [the Remote Python Debugger integration documentation](https://www.home-assistant.io/integrations/debugpy/).

.devcontainer/configuration.yaml

@@ -4,3 +4,6 @@ logger:
   default: error
   logs:
     custom_components.sagemcom_fast: debug
+
+# If you need to debug uncomment the line below (doc: https://www.home-assistant.io/integrations/debugpy/)
+# debugpy:

.devcontainer/devcontainer.json

@@ -1,39 +1,36 @@
 // See https://aka.ms/vscode-remote/devcontainer.json for format details.
 {
-	"image": "ghcr.io/ludeeus/devcontainer/integration:latest",
+	"image": "mcr.microsoft.com/devcontainers/python:1-3.11-bullseye",
 	"name": "ha-sagemcom-fast",
-	"context": "..",
-	"appPort": [
-		"8123:8123"
-	],
-	"postCreateCommand": "container install && pip install -r requirements_dev.txt && pre-commit install && pre-commit install-hooks",
-	"extensions": [
-		"ms-python.python",
-		"github.vscode-pull-request-github",
-		"github.copilot",
-		"ms-python.vscode-pylance"
-	],
-	"settings": {
-		"files.eol": "\n",
-		"editor.tabSize": 4,
-		"terminal.integrated.defaultProfile.linux": "bash",
-		"terminal.integrated.profiles.linux": {
-			"zsh": {
-				"path": "/bin/bash"
-			}
-		},
-		"python.analysis.autoSearchPaths": false,
-		"python.linting.pylintEnabled": true,
-		"python.linting.enabled": true,
-		"python.linting.pylintArgs": [
-			"--disable",
-			"import-error"
-		],
-		"python.formatting.provider": "black",
-		"editor.formatOnPaste": false,
-		"editor.formatOnSave": true,
-		"editor.formatOnType": true,
-		"files.trimTrailingWhitespace": true,
-		"python.linting.mypyEnabled": true,
+	"forwardPorts": [8123],
+  	"portsAttributes": {
+		"8123": {
+			"label": "Home Assistant",
+			"onAutoForward": "openBrowserOnce"
+		}
+	},
+	"postCreateCommand": "pip install -r requirements_dev.txt && pre-commit install && pre-commit install-hooks",
+	"containerEnv": {
+		"DEVCONTAINER": "1"
+	  },
+	  "remoteUser": "vscode",
+	  "customizations": {
+		"vscode": {
+		  "extensions": [
+			"ms-python.vscode-pylance",
+			"ms-python.python",
+			"redhat.vscode-yaml",
+			"esbenp.prettier-vscode",
+			"GitHub.vscode-pull-request-github",
+			"GitHub.copilot"
+		  ],
+		  "settings": {
+			"python.pythonPath": "/usr/local/bin/python",
+			"editor.formatOnPaste": false,
+			"editor.formatOnSave": true,
+			"editor.formatOnType": true,
+			"files.trimTrailingWhitespace": true
+		  }
+		}
 	}
 }

.github/CODEOWNERS

@@ -1,2 +1 @@
 * @iMicknl
-* @arunpoudel

.github/FUNDING.yml

@@ -0,0 +1 @@
+custom: ["https://paypal.me/imick"]

.github/dependabot.yml

@@ -0,0 +1,15 @@
+version: 2
+updates:
+  - package-ecosystem: pip
+    directory: "/"
+    schedule:
+      interval: "daily"
+      time: "08:00"
+    open-pull-requests-limit: 10
+
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: "daily"
+      time: "08:00"
+    open-pull-requests-limit: 10

.github/workflows/linters.yml

@@ -7,6 +7,6 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
-      - uses: pre-commit/action@v2.0.0
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+      - uses: pre-commit/action@v3.0.0

.github/workflows/release-drafter.yml

@@ -3,7 +3,7 @@ name: Release Drafter
 on:
   push:
     branches:
-      - master
+      - main
 
 jobs:
   update_release_draft:

.gitignore

@@ -131,7 +131,9 @@ dmypy.json
 # Pyre type checker
 .pyre/
 
-# HA Config directory for local testing
-/Config/
-
 **/.DS_Store
+
+# DevContainer
+config
+!.vscode/tasks.json
+!.vscode/launch.json

.pre-commit-config.yaml

@@ -1,39 +1,39 @@
 repos:
   - repo: https://github.com/asottile/pyupgrade
-    rev: v2.7.2
+    rev: v2.31.1
     hooks:
       - id: pyupgrade
         args: [--py37-plus]
   - repo: https://github.com/psf/black
-    rev: 20.8b1
+    rev: 22.3.0
     hooks:
       - id: black
         args:
           - --safe
           - --quiet
         files: ^((custom_components)/.+)?[^/]+\.py$
   - repo: https://github.com/codespell-project/codespell
-    rev: v1.17.1
+    rev: v2.1.0
     hooks:
       - id: codespell
         args:
           - --ignore-words-list=hass,alot,datas,dof,dur,farenheit,hist,iff,ines,ist,lightsensor,mut,nd,pres,referer,ser,serie,te,technik,ue,uint,visability,wan,wanna,withing
           - --skip="./.*,*.csv,*.json,*.md"
           - --quiet-level=2
         exclude_types: [csv, json]
-  - repo: https://gitlab.com/pycqa/flake8
-    rev: 3.8.4
+  - repo: https://github.com/PyCQA/flake8
+    rev: 3.9.2
     hooks:
       - id: flake8
         additional_dependencies:
           - flake8-docstrings==1.5.0
           - pydocstyle==5.1.1
         files: ^(custom_components)/.+\.py$
   - repo: https://github.com/PyCQA/isort
-    rev: 5.5.3
+    rev: 5.12.0
     hooks:
       - id: isort
   - repo: https://github.com/adrienverge/yamllint.git
-    rev: v1.24.2
+    rev: v1.26.3
     hooks:
       - id: yamllint

.vscode/launch.json

@@ -0,0 +1,15 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+      {
+        "name": "Home Assistant with Sagemcom Fast",
+        "type": "python",
+        "request": "launch",
+        "python": "/usr/local/bin/python",
+        "module": "homeassistant",
+        "cwd": "${workspaceFolder}",
+        "justMyCode": false,
+        "args": ["--debug", "-c", "config"]
+      }
+    ]
+}

.vscode/tasks.json

@@ -2,27 +2,9 @@
     "version": "2.0.0",
     "tasks": [
         {
-            "label": "Run Home Assistant on port 9123",
+            "label": "Run Home Assistant on port 8123",
             "type": "shell",
-            "command": "container start",
-            "problemMatcher": []
-        },
-        {
-            "label": "Run Home Assistant configuration against /config",
-            "type": "shell",
-            "command": "container check",
-            "problemMatcher": []
-        },
-        {
-            "label": "Upgrade Home Assistant to latest dev",
-            "type": "shell",
-            "command": "container install",
-            "problemMatcher": []
-        },
-        {
-            "label": "Install a specific version of Home Assistant",
-            "type": "shell",
-            "command": "container set-version",
+            "command": "bash scripts/run",
             "problemMatcher": []
         }
     ]

.yamllint

@@ -0,0 +1,61 @@
+ignore: |
+  .github
+rules:
+  braces:
+    level: error
+    min-spaces-inside: 0
+    max-spaces-inside: 1
+    min-spaces-inside-empty: -1
+    max-spaces-inside-empty: -1
+  brackets:
+    level: error
+    min-spaces-inside: 0
+    max-spaces-inside: 0
+    min-spaces-inside-empty: -1
+    max-spaces-inside-empty: -1
+  colons:
+    level: error
+    max-spaces-before: 0
+    max-spaces-after: 1
+  commas:
+    level: error
+    max-spaces-before: 0
+    min-spaces-after: 1
+    max-spaces-after: 1
+  comments:
+    level: error
+    require-starting-space: true
+    min-spaces-from-content: 2
+  comments-indentation:
+    level: error
+  document-end:
+    level: error
+    present: false
+  document-start:
+    level: error
+    present: false
+  empty-lines:
+    level: error
+    max: 1
+    max-start: 0
+    max-end: 1
+  hyphens:
+    level: error
+    max-spaces-after: 1
+  indentation:
+    level: error
+    spaces: 2
+    indent-sequences: true
+    check-multi-line-strings: false
+  key-duplicates:
+    level: error
+  line-length: disable
+  new-line-at-end-of-file:
+    level: error
+  new-lines:
+    level: error
+    type: unix
+  trailing-spaces:
+    level: error
+  truthy:
+    level: warning