Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Chore/replace deprecated devcontainer image #431

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Chore/replace deprecated devcontainer image #431

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c3a2526
add missing requirements.txt
bj00rn Oct 29, 2024
852c6bc
upgrade devcontainer from integration_blueprint
bj00rn Oct 29, 2024
89f2ae7
fix nordpool package not resolving correctly
bj00rn Oct 29, 2024
377fcfd
make script executable
bj00rn Oct 29, 2024
dd19537
move configuration to config dir as per integration_blueprint
bj00rn Oct 29, 2024
1a1a7ab
remove deprecated tasks
bj00rn Oct 29, 2024
4df5055
add numpy dependency, seems to be required for onboarding
bj00rn Oct 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 34 additions & 23 deletions .devcontainer/devcontainer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,31 +1,42 @@
// See https://aka.ms/vscode-remote/devcontainer.json for format details.
{
"image": "ghcr.io/ludeeus/devcontainer/integration:stable",
"image": "mcr.microsoft.com/devcontainers/python:3.12",
"name": "Nordpool integration development",
"context": "..",
"appPort": [
"9123:8123"
],
"postCreateCommand": "container install",
"extensions": [
"ms-python.python",
"github.vscode-pull-request-github",
"ryanluker.vscode-coverage-gutters",
"ms-python.vscode-pylance"
// Mount 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.
"mounts": [
"source=${localWorkspaceFolder}/custom_components,target=${containerWorkspaceFolder}/config/custom_components,type=bind,consistency=cached"
],
"settings": {
"files.eol": "\n",
"editor.tabSize": 4,
"terminal.integrated.shell.linux": "/bin/bash",
"python.pythonPath": "/usr/bin/python3",
"python.analysis.autoSearchPaths": false,
"python.linting.pylintEnabled": true,
"python.linting.enabled": true,
"python.formatting.provider": "black",
"editor.formatOnPaste": false,
"editor.formatOnSave": true,
"editor.formatOnType": true,
"files.trimTrailingWhitespace": true
}

"postCreateCommand": "scripts/setup",
"customizations": {
"vscode": {
"extensions": [
"ms-python.python",
"github.vscode-pull-request-github",
"ryanluker.vscode-coverage-gutters",
"ms-python.vscode-pylance"
],
"settings": {
"files.eol": "\n",
"editor.tabSize": 4,
"terminal.integrated.shell.linux": "/bin/bash",
"python.pythonPath": "/usr/bin/python3",
"python.analysis.autoSearchPaths": false,
"python.linting.pylintEnabled": true,
"python.linting.enabled": true,
"python.formatting.provider": "black",
"editor.formatOnPaste": false,
"editor.formatOnSave": true,
"editor.formatOnType": true,
"files.trimTrailingWhitespace": true
}
}
},
"remoteUser": "vscode",
"features": {}
}
4 changes: 4 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# Home Assistant configuration
config/*
!config/configuration.yaml

# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
Expand Down
20 changes: 1 addition & 19 deletions .vscode/tasks.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,8 @@
{
"label": "Run Home Assistant on port 9123",
"type": "shell",
"command": "container start",
"command": "scripts/dev",
"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",
"problemMatcher": []
}
]
}
0 .devcontainer/configuration.yaml → config/configuration.yaml
View file
Open in desktop
File renamed without changes.
4 changes: 4 additions & 0 deletions requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
colorlog==6.8.2
homeassistant==2024.6.4
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this hass pinned here?

Copy link
Contributor Author

@bj00rn bj00rn Nov 8, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the new devcontainer setup, HASS dependency is pinned here in requirements. These dependencies are for development only and are installed by the setup script. In the previous devcontainer setup I believe HASS was installed by default in the container image. The previous image also contained a script for selecting HASS version.

The pin 2024.6 is from integration_blueprint and somewhat arbitrary I guess.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please drop numpy and unpin homeassistant. We want the latest regular version

pip>=21.3.1
numpy
6 changes: 0 additions & 6 deletions scripts/dev
100644 → 100755
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,6 @@ if [[ ! -d "${PWD}/config" ]]; then
hass --config "${PWD}/config" --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"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why was this removed?

Copy link
Contributor Author

@bj00rn bj00rn Dec 30, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No longer needed since custom_components is mounted in devcontainer.json.

Pythonpath won’t work anymore (unless you remove dependency on nordpool package) due to name collision with integration package.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have already removed the nordpool dependency. Please add it back so the scripts still works without dev container.


echo $PWD

# Start Home Assistant
Expand Down
Empty file modified scripts/setup
100644 → 100755
View file
Open in desktop
Empty file.
Loading