From 880bd5c31133fb8e2b7cbaa0092ec1ad33c0071e Mon Sep 17 00:00:00 2001 From: Shivam Maurya <54358380+shvmm@users.noreply.github.com> Date: Mon, 23 Jun 2025 15:16:51 +0530 Subject: [PATCH 01/10] Update development-environment.md Tested instructions for development on Windows11 --- docs/contributing/development-environment.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/docs/contributing/development-environment.md b/docs/contributing/development-environment.md index cd64a7c..41e6fea 100644 --- a/docs/contributing/development-environment.md +++ b/docs/contributing/development-environment.md @@ -7,8 +7,8 @@ In short, ESPHome is set up to use a Python virtual environment. This guide will walk you through the steps to set up an environment you can use for development. !!!note - These instructions that follow apply for Linux and macOS. Windows users can still develop ESPHome and its - components, but the process is slightly different and not covered (yet) in this guide. + The instructions that follow apply for Linux and macOS. Windows users can still develop ESPHome and its + components, but the process is slightly different and covered at the bottom of this guide. ## Requirements @@ -116,3 +116,17 @@ git push -u origin my-new-feature Once you've pushed your branch, if you wish, you can [submit your work for integration into ESPHome](submitting-your-work.md). + +# Testing Development Changes on Windows + +On Windows, One way to test changes is by creating a branch in your remote fork of the main ESPHome GitHub repo, +and then installing it just like "installing ESPHome Manually" section with the below command: + +```bash +pip install --pre https://github.com/username/esphome/archive/patch-2.zip +``` +OR +```bash +pip install -U git+https://github.com/username/esphome.git@patch-2 --force-reinstall +``` +The `--force-reinstall` flag is important! From bce66496cbede0bfa22f769ab1ae3fafa21a7416 Mon Sep 17 00:00:00 2001 From: Shivam Maurya <54358380+shvmm@users.noreply.github.com> Date: Mon, 23 Jun 2025 15:25:08 +0530 Subject: [PATCH 02/10] Update development-environment.md --- docs/contributing/development-environment.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/contributing/development-environment.md b/docs/contributing/development-environment.md index 41e6fea..61d5e59 100644 --- a/docs/contributing/development-environment.md +++ b/docs/contributing/development-environment.md @@ -121,12 +121,13 @@ Once you've pushed your branch, if you wish, you can On Windows, One way to test changes is by creating a branch in your remote fork of the main ESPHome GitHub repo, and then installing it just like "installing ESPHome Manually" section with the below command: +Here, username and branch is your username and ESPHome fork branch name respectively on Github. ```bash -pip install --pre https://github.com/username/esphome/archive/patch-2.zip +pip install --pre https://github.com/username/esphome/archive/branch.zip ``` OR ```bash -pip install -U git+https://github.com/username/esphome.git@patch-2 --force-reinstall +pip install -U git+https://github.com/username/esphome.git@branch --force-reinstall ``` -The `--force-reinstall` flag is important! +The `--force-reinstall` flag is important for testing small changes! From 4242da53d675742f34da3af55c9a44dd56cf557b Mon Sep 17 00:00:00 2001 From: Shivam Maurya <54358380+shvmm@users.noreply.github.com> Date: Mon, 23 Jun 2025 15:31:07 +0530 Subject: [PATCH 03/10] Update development-environment.md --- docs/contributing/development-environment.md | 25 ++++++++++---------- 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/docs/contributing/development-environment.md b/docs/contributing/development-environment.md index 61d5e59..9d2c526 100644 --- a/docs/contributing/development-environment.md +++ b/docs/contributing/development-environment.md @@ -117,17 +117,18 @@ git push -u origin my-new-feature Once you've pushed your branch, if you wish, you can [submit your work for integration into ESPHome](submitting-your-work.md). -# Testing Development Changes on Windows +???+ # Testing Development Changes on Windows -On Windows, One way to test changes is by creating a branch in your remote fork of the main ESPHome GitHub repo, -and then installing it just like "installing ESPHome Manually" section with the below command: -Here, username and branch is your username and ESPHome fork branch name respectively on Github. + On Windows, One way to test changes is by creating a branch in your remote fork of the main ESPHome GitHub repo, + and then installing it just like [Installing ESPHome Manually](https://esphome.io/guides/installing_esphome) with the below command: -```bash -pip install --pre https://github.com/username/esphome/archive/branch.zip -``` -OR -```bash -pip install -U git+https://github.com/username/esphome.git@branch --force-reinstall -``` -The `--force-reinstall` flag is important for testing small changes! + Here, username and branch is your username and ESPHome fork branch name respectively on Github. + + ```bash + pip install --pre https://github.com/username/esphome/archive/branch.zip + ``` + OR + ```bash + pip install -U git+https://github.com/username/esphome.git@branch --force-reinstall + ``` + The `--force-reinstall` flag is important for testing small changes! From 616d0d968e72bed15c82dcb0009089a7c089a5ce Mon Sep 17 00:00:00 2001 From: Shivam Maurya <54358380+shvmm@users.noreply.github.com> Date: Mon, 23 Jun 2025 15:32:19 +0530 Subject: [PATCH 04/10] Update development-environment.md --- docs/contributing/development-environment.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/development-environment.md b/docs/contributing/development-environment.md index 9d2c526..19b74e5 100644 --- a/docs/contributing/development-environment.md +++ b/docs/contributing/development-environment.md @@ -117,7 +117,7 @@ git push -u origin my-new-feature Once you've pushed your branch, if you wish, you can [submit your work for integration into ESPHome](submitting-your-work.md). -???+ # Testing Development Changes on Windows +???+ Testing Development Changes on Windows On Windows, One way to test changes is by creating a branch in your remote fork of the main ESPHome GitHub repo, and then installing it just like [Installing ESPHome Manually](https://esphome.io/guides/installing_esphome) with the below command: From e379053f40844d270249ddd90dc64e255b083c08 Mon Sep 17 00:00:00 2001 From: Shivam Maurya <54358380+shvmm@users.noreply.github.com> Date: Mon, 23 Jun 2025 20:28:43 +0530 Subject: [PATCH 05/10] Update development-environment.md --- docs/contributing/development-environment.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/contributing/development-environment.md b/docs/contributing/development-environment.md index 19b74e5..ecb5283 100644 --- a/docs/contributing/development-environment.md +++ b/docs/contributing/development-environment.md @@ -117,7 +117,9 @@ git push -u origin my-new-feature Once you've pushed your branch, if you wish, you can [submit your work for integration into ESPHome](submitting-your-work.md). -???+ Testing Development Changes on Windows +???+ Windows + + # Testing Development Changes on Windows On Windows, One way to test changes is by creating a branch in your remote fork of the main ESPHome GitHub repo, and then installing it just like [Installing ESPHome Manually](https://esphome.io/guides/installing_esphome) with the below command: From 9600d5f6da85c9a72c3c6d08ec5c70b55f47f9e3 Mon Sep 17 00:00:00 2001 From: Shivam Maurya <54358380+shvmm@users.noreply.github.com> Date: Mon, 23 Jun 2025 20:31:45 +0530 Subject: [PATCH 06/10] Update development-environment.md --- docs/contributing/development-environment.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/contributing/development-environment.md b/docs/contributing/development-environment.md index ecb5283..29468fb 100644 --- a/docs/contributing/development-environment.md +++ b/docs/contributing/development-environment.md @@ -119,8 +119,8 @@ Once you've pushed your branch, if you wish, you can ???+ Windows - # Testing Development Changes on Windows - + ## Testing Development Changes on Windows + On Windows, One way to test changes is by creating a branch in your remote fork of the main ESPHome GitHub repo, and then installing it just like [Installing ESPHome Manually](https://esphome.io/guides/installing_esphome) with the below command: From 91544e0cad4a76c503148a219e48b2554ef3b3a4 Mon Sep 17 00:00:00 2001 From: Shivam Maurya <54358380+shvmm@users.noreply.github.com> Date: Tue, 24 Jun 2025 11:11:01 +0530 Subject: [PATCH 07/10] Apply suggestions from code review Co-authored-by: Keith Burzinski --- docs/contributing/development-environment.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/contributing/development-environment.md b/docs/contributing/development-environment.md index 29468fb..0fb02bc 100644 --- a/docs/contributing/development-environment.md +++ b/docs/contributing/development-environment.md @@ -121,10 +121,12 @@ Once you've pushed your branch, if you wish, you can ## Testing Development Changes on Windows - On Windows, One way to test changes is by creating a branch in your remote fork of the main ESPHome GitHub repo, - and then installing it just like [Installing ESPHome Manually](https://esphome.io/guides/installing_esphome) with the below command: + To test changes when using Windows: + - Create a branch in your remote fork of the main ESPHome GitHub repo + - Install from your fork in the same manner you would + [install ESPHome manually](https://esphome.io/guides/installing_esphome) but with the following command: - Here, username and branch is your username and ESPHome fork branch name respectively on Github. + Here, `username` and `branch` are (respectively) your GitHub username and branch name in your ESPHome fork on Github. ```bash pip install --pre https://github.com/username/esphome/archive/branch.zip From 1d8f8c3a557d586a06ef724cf14f5eda5b4d0651 Mon Sep 17 00:00:00 2001 From: Keith Burzinski Date: Tue, 24 Jun 2025 01:28:45 -0500 Subject: [PATCH 08/10] Update docs/contributing/development-environment.md --- docs/contributing/development-environment.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/contributing/development-environment.md b/docs/contributing/development-environment.md index 0fb02bc..c7ddb5f 100644 --- a/docs/contributing/development-environment.md +++ b/docs/contributing/development-environment.md @@ -122,6 +122,7 @@ Once you've pushed your branch, if you wish, you can ## Testing Development Changes on Windows To test changes when using Windows: + - Create a branch in your remote fork of the main ESPHome GitHub repo - Install from your fork in the same manner you would [install ESPHome manually](https://esphome.io/guides/installing_esphome) but with the following command: From dbc5be2cc6780c78d27aa7bd4d90b64de0675c10 Mon Sep 17 00:00:00 2001 From: Keith Burzinski Date: Tue, 24 Jun 2025 01:33:19 -0500 Subject: [PATCH 09/10] Update docs/contributing/development-environment.md --- docs/contributing/development-environment.md | 25 ++++++++++---------- 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/docs/contributing/development-environment.md b/docs/contributing/development-environment.md index c7ddb5f..cb6f0d6 100644 --- a/docs/contributing/development-environment.md +++ b/docs/contributing/development-environment.md @@ -125,15 +125,16 @@ Once you've pushed your branch, if you wish, you can - Create a branch in your remote fork of the main ESPHome GitHub repo - Install from your fork in the same manner you would - [install ESPHome manually](https://esphome.io/guides/installing_esphome) but with the following command: - - Here, `username` and `branch` are (respectively) your GitHub username and branch name in your ESPHome fork on Github. - - ```bash - pip install --pre https://github.com/username/esphome/archive/branch.zip - ``` - OR - ```bash - pip install -U git+https://github.com/username/esphome.git@branch --force-reinstall - ``` - The `--force-reinstall` flag is important for testing small changes! +[install ESPHome manually](https://esphome.io/guides/installing_esphome) but with one of the following commands: + + ```bash + pip install --pre https://github.com/username/esphome/archive/branch.zip + ``` + OR + ```bash + pip install -U git+https://github.com/username/esphome.git@branch --force-reinstall + ``` + + Note that `username` and `branch` are (respectively) your GitHub username and branch name in your ESPHome fork on Github. + + The `--force-reinstall` flag is important for testing changes! From 4682cfccd160aeb152c32ff2dca4f8a5599ba48a Mon Sep 17 00:00:00 2001 From: Keith Burzinski Date: Tue, 24 Jun 2025 01:34:38 -0500 Subject: [PATCH 10/10] Update docs/contributing/development-environment.md --- docs/contributing/development-environment.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/development-environment.md b/docs/contributing/development-environment.md index cb6f0d6..cb8691c 100644 --- a/docs/contributing/development-environment.md +++ b/docs/contributing/development-environment.md @@ -125,7 +125,7 @@ Once you've pushed your branch, if you wish, you can - Create a branch in your remote fork of the main ESPHome GitHub repo - Install from your fork in the same manner you would -[install ESPHome manually](https://esphome.io/guides/installing_esphome) but with one of the following commands: + [install ESPHome manually](https://esphome.io/guides/installing_esphome) but with one of the following commands: ```bash pip install --pre https://github.com/username/esphome/archive/branch.zip