From dd9ff0055d8919120bc5a757c975b75f1e5254e4 Mon Sep 17 00:00:00 2001 From: Issac Date: Wed, 22 Apr 2020 03:57:46 +0300 Subject: [PATCH] Example of git-based dependency for development (#468) --- docs/creating_integration_manifest.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/creating_integration_manifest.md b/docs/creating_integration_manifest.md index fd8a122c..69161a0a 100644 --- a/docs/creating_integration_manifest.md +++ b/docs/creating_integration_manifest.md @@ -90,6 +90,13 @@ pip install -e ./pychromecast hass --skip-pip ``` +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: + +```json +{ + "requirements": ["git+https://github.com/issacg/pycoolmaster.git@except_connect#pycoolmaster==0.2.2"] +} + ## Zeroconf If your integration supports discovery via [Zeroconf](https://en.wikipedia.org/wiki/Zero-configuration_networking), you can add the type to your manifest. If the user has the `zeroconf` integration loaded, it will load the `zeroconf` step of your integration's config flow when it is discovered.