diff --git a/source/developers/component_deps_and_reqs.markdown b/source/developers/component_deps_and_reqs.markdown index 2a6ae27d0e..81adbd9da1 100644 --- a/source/developers/component_deps_and_reqs.markdown +++ b/source/developers/component_deps_and_reqs.markdown @@ -41,3 +41,16 @@ 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` + + +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'] +```