From 737120118b5cb043f39eae7cdf2a81daeb38f3f1 Mon Sep 17 00:00:00 2001 From: Jyrki K Date: Fri, 21 Jun 2024 10:02:49 +0300 Subject: [PATCH] Update creating_integration_manifest.md (#2125) Fix the syntax in the example of the requirement pointing to a public GitHub repository . --- docs/creating_integration_manifest.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/docs/creating_integration_manifest.md b/docs/creating_integration_manifest.md index 842fc9d3..5d1d8d50 100644 --- a/docs/creating_integration_manifest.md +++ b/docs/creating_integration_manifest.md @@ -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": [" @ git+https://github.com//.git@"] +} +``` +`` 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"] } ```