From b22ae5949b1b86f27ddc52e2bd696596cdf02c8a Mon Sep 17 00:00:00 2001 From: Oncleben31 Date: Mon, 11 May 2020 10:24:30 +0200 Subject: [PATCH] Improve README for container dev and library update. (#27) --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index e2ceafc..c0d548e 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,26 @@ File | Purpose `README.md` | The file you are reading now, should contain info about the integration, installation and configuration instructions. `requirements.txt` | Python packages used by this integration. +## How? + +If you want to use all the potential and features of this blueprint tempalte you +should use Visual Studio Code to develop in a container. In this container you +will have all the tools to ease your python development and a dedicated Home +Assistant core instance to run your integration. See `.devcontainer/README.md` for more information. + +If you need to work on the python library in parallel of this integration +(`sampleclient` in this example) there are different options. The following one seems +easy to implement: + +- Create a dedicated branch for your python library on a public git repository (example: branch +`dev` on `https://github.com/ludeeus/sampleclient`) +- Update in the `manifest.json` file the `requirements` key to point on your development branch +( example: `"requirements": ["git+https://github.com/ludeeus/sampleclient.git@dev#devp==0.0.1beta1"]`) +- Each time you need to make a modification to your python library, push it to your +development branch and increase the number of the python library version in `manifest.json` file +to ensure Home Assistant update the code of the python library. (example `"requirements": ["git+https://...==0.0.1beta2"]`). + + *** README content if this was a published component: ***