feat: enhance devcontainer with venv management and configurable HA installation by jpawlowski · Pull Request #297 · ludeeus/integration_blueprint

jpawlowski · 2025-11-26T19:02:16Z

Changes to development environment setup:

devcontainer.json:

Add containerEnv with HA_VERSION (default: 2025.11.3) for flexible HA core versioning
Add Python environment variables (PYTHONASYNCIODEBUG, PYTHONUNBUFFERED, PYTHONDONTWRITEBYTECODE, PYTHONUTF8)
Configure Python interpreter path to use workspace .venv
Add Pylance analysis settings with workspace-scoped diagnostics
Configure analysis include/exclude paths for better IDE performance
Add extraPaths to resolve dependencies in .venv site-packages

bootstrap script:

Create and manage Python virtual environment in $HOME/.venv with workspace symlink
Auto-activate venv in bash/zsh shell configurations for persistent sessions
Remove --system flag from uv pip install to use venv instead of system Python
Install Home Assistant core with configurable HA_VERSION environment variable
Download and install requirements_all.txt for full integration dependency support
Download and install requirements_test.txt + requirements_test_pre_commit.txt for testing
Add cleanup of temporary requirement files after installation

requirements.txt:

Remove homeassistant package (now installed via bootstrap with version control)
Clarify file purpose: project/dev tooling only

.pre-commit-config.yaml:

Update ruff hooks to activate venv before execution for consistent tool versions

This provides an isolated, reproducible development environment with proper dependency
management and IDE integration for custom Home Assistant integration development.

…stant logs

…omments in validation

… use of Ruff for linting

…ks information

…ptions, add version inputs

…ts.txt

…nt translations

…t and error handling details

…n keys; enhance error handling and add reconfiguration support in config flow

…res, development scripts, and next steps

…anslations for clarity

…sary constructor parameters; streamline entity initialization

…ities

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

jpawlowski · 2025-11-26T19:03:30Z

@ludeeus this is the alternative we were talking about in #283

Copilot

Pull request overview

This PR comprehensively modernizes the integration blueprint's development environment with enhanced scripts, improved DevContainer configuration, and updated integration code to follow current Home Assistant best practices. The changes introduce the "Scripts to Rule Them All" pattern, add support for the uv package manager, and enhance developer tooling with comprehensive pre-commit hooks, linting, and type checking support.

Key changes:

Enhanced development scripts following standardized patterns with unified output formatting
Updated Home Assistant compatibility to 2025.7+ with synchronized dependency management
Modernized integration code with translation keys, diagnostics support, and improved error handling

Reviewed changes

Copilot reviewed 46 out of 53 changed files in this pull request and generated 19 comments.

Show a summary per file

File	Description
`scripts/*`	New development scripts (bootstrap, setup, develop, clean, lint, test, etc.) with standardized output
`scripts/.lib/output.sh`	Shared library for consistent colored output across all scripts
`scripts/setup/*`	Setup utilities (bootstrap, reset, sync-hacs) for environment management
`schemas/json/*`	JSON schemas for manifest and translation validation
`requirements.txt`	Updated to remove Home Assistant core (now managed via bootstrap)
`pyproject.toml`	New project configuration with Ruff, pytest, and metadata
`hacs.json`	Updated Home Assistant version requirement to 2025.9.4
`config/configuration.yaml`	Enhanced development-friendly configuration with reduced logging noise
`custom_components/integration_blueprint/*.py`	Modernized integration code with translation keys, diagnostics, and error handling
`README.md`	Updated documentation explaining new scripts and features
`.devcontainer/*`	Modular DevContainer configuration with Git setup automation
`.editorconfig`, `.prettierrc.yml`, etc.	New editor and formatter configurations
`.pre-commit-config.yaml`	Pre-commit hooks for automatic code quality checks
`.github/workflows/*`	Updated CI workflows to use new scripts and uv

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

ludeeus · 2025-11-26T19:30:15Z

A quick glance.
This is way to big, i can not accept this.
Please split it up in reviewable chunks.
This is also adding things that are not here already.
New things needs to be one pr for each addition.

jpawlowski · 2025-11-26T19:31:38Z

Quite many of it belongs together, most don't make sense by themselves 🤷‍♂️

…nstallation Changes to development environment setup: **devcontainer.json:** - Add containerEnv with HA_VERSION (default: 2025.11.3) for flexible HA core versioning - Add Python environment variables (PYTHONASYNCIODEBUG, PYTHONUNBUFFERED, PYTHONDONTWRITEBYTECODE, PYTHONUTF8) - Configure Python interpreter path to use workspace .venv - Add Pylance analysis settings with workspace-scoped diagnostics - Configure analysis include/exclude paths for better IDE performance - Add extraPaths to resolve dependencies in .venv site-packages **bootstrap script:** - Create and manage Python virtual environment in $HOME/.venv with workspace symlink - Auto-activate venv in bash/zsh shell configurations for persistent sessions - Remove --system flag from uv pip install to use venv instead of system Python - Install Home Assistant core with configurable HA_VERSION environment variable - Download and install requirements_all.txt for full integration dependency support - Download and install requirements_test.txt + requirements_test_pre_commit.txt for testing - Add cleanup of temporary requirement files after installation **requirements.txt:** - Remove homeassistant package (now installed via bootstrap with version control) - Clarify file purpose: project/dev tooling only **.pre-commit-config.yaml:** - Update ruff hooks to activate venv before execution for consistent tool versions This provides an isolated, reproducible development environment with proper dependency management and IDE integration for custom Home Assistant integration development.

jpawlowski · 2025-11-27T14:12:38Z

@ludeeus i stripped down the patch to what I think is essential. However, using venv comes with some other implications that leave room for improvement.

ludeeus · 2025-12-06T09:35:37Z

  pipx install uv
 fi

+echo "==> Checking for Python virtual environment..."


Why is a venv needed inside a devcontainer?

The reason is that we would need to use sudo permissions to install in system context:

# uv pip install --system homeassistant==2025.12.0 Using Python 3.13.9 environment at: /usr/local Resolved 127 packages in 388ms Prepared 16 packages in 5.26s error: Failed to install: click-8.3.1-py3-none-any.whl (click==8.3.1) Caused by: failed to create directory `/usr/local/lib/python3.13/site-packages/click`: Permission denied (os error 13)

We are installing uv in user context already and it is not available in system context.
In the end, we are following the HA Core setup here which I think is where we want to be as closely aligned as possible.

in HA core devcontainer is a secondary option.
Having a virtual environment (venv) in a container is isolation within isolation?

The reason here is not isolation but simplicity. Following the rule not to use sudo is never a bad idea...

It is inside a container, why does it matter?

People will not like to have to add --system and use sudo every time they install something manually. It just feels more natural to do everything in user context, despite the container. I wouldn't overcomplicate things.

But hey, you do you. You can change the code to whatever you feel is right for your blueprint.

…F-8 setting since it is default for Python 3.13

jiesou · 2026-02-11T07:39:06Z

Any update? 😄

jpawlowski · 2026-02-11T11:43:44Z

When it comes to me, I've created my own template in the meantime.

Shulyaka · 2026-03-03T20:04:20Z

      - id: ruff-format
        name: ruff format
-        entry: ruff format
+        entry: bash -c 'source $HOME/.venv/bin/activate && ruff format "$@"' --


This will not work out of the container (it's not always in $HOME)

Shulyaka · 2026-03-03T23:23:52Z

 fi

+echo "==> Checking for Python virtual environment..."
+if [ ! -d "$HOME/.venv" ]; then


What if this script is run not in devcontainer, and the user has $HOME/.venv for completely unrelated reason?

jiesou · 2026-03-04T01:23:28Z

If choose to place .venv in $HOME instead of the project root is for performance, then consider this:

"mounts": [
  "source=${localWorkspaceFolderBasename}-venv,target=${containerWorkspaceFolder}/.venv,type=volume"
]

See: https://code.visualstudio.com/remote/advancedcontainers/improve-performance#_use-a-targeted-named-volume

This way .venv stays at the conventional project root location, so 2 issues Shulyaka raised can be easily solve, scripts doesn't need to care whether it's running inside a devcontainer or not.

ludeeus and others added 23 commits October 17, 2025 08:24

Add bootstrap, help, lint, lint-check, motd, setup, and update scripts

1e4e1b2

Update .gitignore to include additional temporary files and Home Assi…

b41923f

…stant logs

Add pre-commit configuration for Ruff linter and formatter

529ba86

Add pyproject.toml configuration for Ruff linter

296e8c4

Refactor GitHub Actions workflows: update linting steps and improve c…

f026eb2

…omments in validation

Update devcontainer name and add postStartCommand for MOTD

bff9d5c

Update contribution guidelines: reorder steps for clarity and specify…

1dc1c57

… use of Ruff for linting

Enhance README.md: add development scripts section and pre-commit hoo…

1a21f35

…ks information

Update issue templates: enhance bug report and feature request descri…

c1aa2a7

…ptions, add version inputs

Update Home Assistant version to 2025.9.4 in hacs.json and requiremen…

db6c5d7

…ts.txt

Add diagnostics support for Integration Blueprint

bfd5edd

Replace async_timeout with asyncio for timeout handling in API client

3190995

Add reconfiguration support and error messages to integration bluepri…

1e3caeb

…nt translations

Enhance documentation in DataUpdateCoordinator with additional contex…

62d2f82

…t and error handling details

Refactor binary sensor, sensor, and switch entities to use translatio…

a806792

…n keys; enhance error handling and add reconfiguration support in config flow

Revise README.md for clarity and structure; enhance sections on featu…

f68e587

…res, development scripts, and next steps

Refactor error handling in config flow and switch entities; update tr…

bbcef18

…anslations for clarity

Refactor binary sensor, sensor, and switch entities to remove unneces…

f4c21fb

…sary constructor parameters; streamline entity initialization

Add filters to logger for go2rtc component; improve debugging capabil…

7078ac4

…ities

Apply suggestion from @Copilot

fc45d2e

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Apply suggestion from @Copilot

2135175

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update CONTRIBUTING.md

34a98e7

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Merge branch 'main' into 2025update

1b7490e

Copilot AI review requested due to automatic review settings November 26, 2025 19:02

Copilot started reviewing on behalf of jpawlowski November 26, 2025 19:02 View session

Copilot finished reviewing on behalf of jpawlowski November 26, 2025 19:05

Copilot AI reviewed Nov 26, 2025

View reviewed changes

jpawlowski force-pushed the 2025update-alternative branch from d9d149a to 356d785 Compare November 27, 2025 14:10

jpawlowski changed the base branch from main to 2025update November 27, 2025 14:11

jpawlowski changed the title ~~Modernize development environment with enhanced scripts, DevContainer configuration, and improved integration structure~~ feat: enhance devcontainer with venv management and configurable HA installation Nov 27, 2025

chore(deps): Bump HA to 2025.11.3 as development reference version

a54a182

ludeeus requested changes Dec 6, 2025

View reviewed changes

jpawlowski added 2 commits December 6, 2025 11:15

refactor: remove hardcoded HA_VERSION and derive from hacs.json

133f775

refactor: clean up .devcontainer.json formatting and remove unused UT…

4d574b0

…F-8 setting since it is default for Python 3.13

Shulyaka reviewed Mar 3, 2026

View reviewed changes

Shulyaka mentioned this pull request Mar 9, 2026

Update for venv in devcontainer #320

Open

ludeeus deleted the branch ludeeus:main March 20, 2026 09:50

ludeeus closed this Mar 20, 2026

ludeeus reopened this Mar 20, 2026

ludeeus changed the base branch from 2025update to main March 20, 2026 09:56

Conversation

jpawlowski commented Nov 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jpawlowski commented Nov 26, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ludeeus commented Nov 26, 2025

Uh oh!

jpawlowski commented Nov 26, 2025

Uh oh!

jpawlowski commented Nov 27, 2025

Uh oh!

ludeeus Dec 6, 2025

Choose a reason for hiding this comment

Uh oh!

jpawlowski Dec 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ludeeus Dec 6, 2025

Choose a reason for hiding this comment

Uh oh!

jpawlowski Dec 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ludeeus Dec 6, 2025

Choose a reason for hiding this comment

Uh oh!

jpawlowski Dec 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jiesou commented Feb 11, 2026

Uh oh!

jpawlowski commented Feb 11, 2026

Uh oh!

Shulyaka Mar 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Shulyaka Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

jiesou commented Mar 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

jpawlowski commented Nov 26, 2025 •

edited

Loading

jpawlowski Dec 6, 2025 •

edited

Loading

jpawlowski Dec 6, 2025 •

edited

Loading

jpawlowski Dec 6, 2025 •

edited

Loading

Shulyaka Mar 3, 2026 •

edited

Loading

jiesou commented Mar 4, 2026 •

edited

Loading