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-18 23:06:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update creating_integration_manifest.md (#2125)

Browse Source 
Fix the syntax in the example of the requirement pointing to a public GitHub repository .
This commit is contained in:
Jyrki K 2024-06-21 10:02:49 +03:00 committed by GitHub
parent b6f3926366
commit 737120118b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/creating_integration_manifest.md
View File

@ -151,11 +151,20 @@ pip install -e ./pychromecast
hass --skip-pip-packages pychromecast
```
It is also possible to use a public git repository to install a requirement. This can be useful, for example, to test changes to a requirement dependency before it's been published to PyPI. The following example will install the `except_connect` branch of the `pycoolmaster` library directly from GitHub unless version `0.2.2` is currently installed:
It is also possible to use a public git repository to install a requirement. This can be useful, for example, to test changes to a requirement dependency before it's been published to PyPI. Syntax:
```json
{
"requirements": ["git+https://github.com/issacg/pycoolmaster.git@except_connect#pycoolmaster==0.2.2"]
"requirements": ["<project> @ git+https://github.com/<user>/<project>.git@<git ref>"]
}
```
`<git ref>` can be any git reference: branch, tag, commit hash, ... . See [PIP documentation about git support](https://pip.pypa.io/en/stable/topics/vcs-support/#git).
The following example will install the `except_connect` branch of the `pycoolmaster` library directly from GitHub:
```json
{
"requirements": ["pycoolmaster @ git+https://github.com/issacg/pycoolmaster.git@except_connect"]
}
```