From 41631bd88133948b482469338adbe465b04817b6 Mon Sep 17 00:00:00 2001 From: NovapaX Date: Tue, 17 Apr 2018 00:06:20 +0200 Subject: [PATCH 1/4] Update component_deps_and_reqs.markdown --- source/developers/component_deps_and_reqs.markdown | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/source/developers/component_deps_and_reqs.markdown b/source/developers/component_deps_and_reqs.markdown index 2a6ae27d0e..111ec45a48 100644 --- a/source/developers/component_deps_and_reqs.markdown +++ b/source/developers/component_deps_and_reqs.markdown @@ -41,3 +41,12 @@ If you need to make changes to a requirement to support your component, it's als * `git clone https://github.com/balloob/pychromecast.git` * `pip install ./pychromecast` * `hass --skip-pip` + +You can also to point to a hosted package in the form of a zip-file as a requirement. GitHub provides zip-files for a specific branch, release or even a specific commit. To do that the string in `REQUIREMENTS` needs to be composed of two parts: +* an URL pointing to the zip-file (e.g. https://github.com/my/repo/archive/branch-x.zip) a +* a hashtag and pip-string (as described above) to declare what package and version that zipfile contains. + +For example, the Neato robot vacuum components specifies the v.0.0.5 release on GitHub as a requirement that gets installed as pybotvac version 0.0.5 (`pybotvac==0.0.5`) +```python +REQUIREMENTS = ['https://github.com/jabesq/pybotvac/archive/v0.0.5.zip'#pybotvac==0.0.5'] +``` From f2f34e8e9d8fae4ee2fc42cc30e552f6a94725c7 Mon Sep 17 00:00:00 2001 From: NovapaX Date: Thu, 19 Apr 2018 12:08:40 +0200 Subject: [PATCH 2/4] Update component_deps_and_reqs.markdown --- source/developers/component_deps_and_reqs.markdown | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/source/developers/component_deps_and_reqs.markdown b/source/developers/component_deps_and_reqs.markdown index 111ec45a48..1204779240 100644 --- a/source/developers/component_deps_and_reqs.markdown +++ b/source/developers/component_deps_and_reqs.markdown @@ -42,7 +42,8 @@ If you need to make changes to a requirement to support your component, it's als * `pip install ./pychromecast` * `hass --skip-pip` -You can also to point to a hosted package in the form of a zip-file as a requirement. GitHub provides zip-files for a specific branch, release or even a specific commit. To do that the string in `REQUIREMENTS` needs to be composed of two parts: + +For testing and development purposes you can also to point to a hosted package in the form of a zip-file as a requirement. (note: components included in home-assisstant should just point to published pypi packages/versions if possible) GitHub provides zip-files for a specific branch, release or even a specific commit. To do that the string in `REQUIREMENTS` needs to be composed of two parts: * an URL pointing to the zip-file (e.g. https://github.com/my/repo/archive/branch-x.zip) a * a hashtag and pip-string (as described above) to declare what package and version that zipfile contains. From f6db975a4169b56be8c28f6fa40955508f953080 Mon Sep 17 00:00:00 2001 From: NovapaX Date: Thu, 19 Apr 2018 12:11:05 +0200 Subject: [PATCH 3/4] Update component_deps_and_reqs.markdown --- source/developers/component_deps_and_reqs.markdown | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/source/developers/component_deps_and_reqs.markdown b/source/developers/component_deps_and_reqs.markdown index 1204779240..131f034a0f 100644 --- a/source/developers/component_deps_and_reqs.markdown +++ b/source/developers/component_deps_and_reqs.markdown @@ -43,10 +43,13 @@ If you need to make changes to a requirement to support your component, it's als * `hass --skip-pip` -For testing and development purposes you can also to point to a hosted package in the form of a zip-file as a requirement. (note: components included in home-assisstant should just point to published pypi packages/versions if possible) GitHub provides zip-files for a specific branch, release or even a specific commit. To do that the string in `REQUIREMENTS` needs to be composed of two parts: +For testing and development purposes you can also to point to a hosted package in the form of a zip-file as a requirement. GitHub provides zip-files for a specific branch, release or even a specific commit. To do that the string in `REQUIREMENTS` needs to be composed of two parts: + * an URL pointing to the zip-file (e.g. https://github.com/my/repo/archive/branch-x.zip) a * a hashtag and pip-string (as described above) to declare what package and version that zipfile contains. +Note: components included in home-assisstant should point to published pypi packages/versions if possible + For example, the Neato robot vacuum components specifies the v.0.0.5 release on GitHub as a requirement that gets installed as pybotvac version 0.0.5 (`pybotvac==0.0.5`) ```python REQUIREMENTS = ['https://github.com/jabesq/pybotvac/archive/v0.0.5.zip'#pybotvac==0.0.5'] From 7dbf76c25f4f33b221eaa59d6993c71baae83c61 Mon Sep 17 00:00:00 2001 From: NovapaX Date: Thu, 19 Apr 2018 12:12:13 +0200 Subject: [PATCH 4/4] Update component_deps_and_reqs.markdown --- source/developers/component_deps_and_reqs.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/developers/component_deps_and_reqs.markdown b/source/developers/component_deps_and_reqs.markdown index 131f034a0f..81adbd9da1 100644 --- a/source/developers/component_deps_and_reqs.markdown +++ b/source/developers/component_deps_and_reqs.markdown @@ -52,5 +52,5 @@ Note: components included in home-assisstant should point to published pypi pack For example, the Neato robot vacuum components specifies the v.0.0.5 release on GitHub as a requirement that gets installed as pybotvac version 0.0.5 (`pybotvac==0.0.5`) ```python -REQUIREMENTS = ['https://github.com/jabesq/pybotvac/archive/v0.0.5.zip'#pybotvac==0.0.5'] +REQUIREMENTS = ['https://github.com/jabesq/pybotvac/archive/v0.0.5.zip#pybotvac==0.0.5'] ```