jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-22 00:36:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add content from #5199 (#14)

Browse Source 
https://github.com/home-assistant/home-assistant.github.io/pull/5199
This commit is contained in:
Fabian Affolter 2018-05-13 15:35:21 +02:00 committed by GitHub
parent 14c5e77212
commit 3ed5197cf9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/creating_component_deps_and_reqs.md
View File

@ -34,3 +34,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 an archive (zip/tar.gz) file as a requirement. GitHub provides archive 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 archive file (e.g. `https://github.com/my/repo/archive/branch-x.zip`)
* a hashtag and `pip` string (as described above) to declare what package and version that archive file contains
Note: Components and platforms included in Home Assistant should point to published PyPI packages. This ensures that the unit tests will not be slowed down as they can be cached.
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']
```