Merge pull request #1058 from KartoffelToby/feature/development

Feature/development

.devcontainer/configuration.yaml

@@ -92,6 +92,6 @@ template:
 
 
 # If you need to debug uncomment the line below (doc: https://www.home-assistant.io/integrations/debugpy/)
-#debugpy:
+debugpy:
 
 

.devcontainer/devcontainer.json

@@ -3,11 +3,16 @@
   "image": "mcr.microsoft.com/devcontainers/python:0-3.11",
   "name": "BETTER THERMOSTAT development",
   "initializeCommand": "/bin/mkdir -p ${localWorkspaceFolder}/.haconfig && /bin/cp ${localWorkspaceFolder}/.devcontainer/configuration.yaml ${localWorkspaceFolder}/.haconfig",
+  "containerUser": "1000",
+  "remoteUser": "1000",
   "appPort": [
     "9123:8123"
   ],
+  "forwardPorts": [
+    9123
+  ],
   "portsAttributes": {
-    "8123": {
+    "9123": {
       "label": "HomeAssistant port",
       "protocol": "http",
       "onAutoForward": "notify"
@@ -39,8 +44,8 @@
       ]
     }
   },
-  "postCreateCommand": "pip install -r requirements.dev.txt",
+  "postCreateCommand": "scripts/setup",
   "mounts": [
     "source=${localWorkspaceFolder}/.haconfig,target=/config,type=bind,consistency=cached"
   ]
-}
+}

.gitignore

@@ -8,4 +8,4 @@ venv
 .idea
 custom_components/hacs
 x_*
-.haconfig
+.haconfig

.vscode/launch.json

@@ -10,10 +10,12 @@
             "request": "launch",
             "module": "homeassistant",
             "args": [
+                "--debug",
                 "-c",
                 "/config"
             ],
-            "justMyCode": true
-        }
+            "justMyCode": false,
+            "console": "internalConsole"
+        },
     ]
 }

.vscode/tasks.json

@@ -4,25 +4,25 @@
         {
             "label": "Run Home Assistant on port 9123",
             "type": "shell",
-            "command": "container start",
+            "command": "scripts/start",
             "problemMatcher": []
         },
         {
-            "label": "Run Home Assistant configuration against /config",
+            "label": "Sync configuration.yaml (Override local)",
             "type": "shell",
-            "command": "container check",
+            "command": "scripts/sync",
             "problemMatcher": []
         },
         {
             "label": "Upgrade Home Assistant to latest dev",
             "type": "shell",
-            "command": "container install",
+            "command": "scripts/upgrade-dev",
             "problemMatcher": []
         },
         {
             "label": "Install a specific version of Home Assistant",
             "type": "shell",
-            "command": "container set-version",
+            "command": "scripts/upgrade-version",
             "problemMatcher": []
         }
     ]

CONTRIBUTING.md

@@ -5,6 +5,29 @@
 The following is a set of guidelines for contributing to Better Thermostat. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this
 document in a pull request.
 
+## Development
+
+#### Requirements
+- VSCode
+- Docker
+- Devcontainer Extension
+
+#### Setup
+1. Clone the repository
+2. Open the repository in VSCode
+3. Click on the green button in the bottom left corner and select "Reopen in Container"
+4. Wait for the container to build
+5. Open Task Runner and run "Run Home Assistant on port 9123"
+6. Open the browser and go to http://localhost:9123 -> Inital DEV HA Setup
+
+
+#### Nice to know
+
+- Debuging is possible with the VSCode Debuger. Just run the HomeAssistant in Debugger and open browser on http://localhost:9123 (No task run needed)
+- Update your local in devcontainer configuration.yaml to the current version of the repository to get the latest changes. -> Run "Sync configuration.yaml (Override local)" in Task Runner
+- Test BT in a specific HA version -> Run "Install a specific version of Home Assistant" in Task Runner and the the version you want to test in the terminal promt.
+- Test BT with the latest HA version -> Run "pgrade Home Assistant to latest dev" in Task Runner
+
 ## How Can I Contribute?
 
 ## New Adapter

requirements.dev.txt

@@ -1 +1,7 @@
-homeassistant==2023.9.2
+homeassistant==2023.9.2
+pre-commit==2.15.0
+black==23.9.1
+codespell==2.2.2
+ruff==0.0.289
+yamllint==1.32.0
+flake8==4.0.1

scripts/setup

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+set -e
+
+cd "$(dirname "$0")/.."
+
+python3 -m pip install --requirement requirements.dev.txt

scripts/start

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+
+set -e
+
+cd "$(dirname "$0")/.."
+
+# Create config dir if not present
+if [[ ! -d "${PWD}/.haconfig" ]]; then
+    mkdir -p "${PWD}/.haconfig"
+    hass --config "${PWD}/.haconfig" --script ensure_config
+fi
+
+# Set the path to custom_components
+## This let's us have the structure we want <root>/custom_components/integration_blueprint
+## while at the same time have Home Assistant configuration inside <root>/config
+## without resulting to symlinks.
+export PYTHONPATH="${PYTHONPATH}:${PWD}/custom_components"
+
+# Start Home Assistant
+hass --config "${PWD}/.haconfig" --debug

scripts/sync

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+set -e
+
+cd "$(dirname "$0")/.."
+
+echo "Syncing configuration.yaml"
+
+cp -f .devcontainer/configuration.yaml ${PWD}/.haconfig/configuration.yaml
+
+echo "Done. Restart Home Assistant to see changes."

scripts/upgrade-dev

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+set -e
+
+cd "$(dirname "$0")/.."
+
+python3 -m pip install homeassistant
+
+echo "Done."

scripts/upgrade-version

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+set -e
+
+read -p "What HA Version? " VERSION
+echo "Installing ${my_var}!"
+
+
+cd "$(dirname "$0")/.."
+
+python3 -m pip install homeassistant==$VERSION
+
+echo "Done."