Document --skip-pip-packages for more granular package installation control (#1555)

This commit is contained in:
puddly 2022-11-30 02:39:02 -05:00 committed by GitHub
parent 967c787b35
commit af0b620f20
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 5 additions and 5 deletions

View File

@ -42,5 +42,5 @@ pip3 install -e ../my_lib_folder
Now run Home Assistant without installing dependencies from PyPI to avoid overriding your package. Now run Home Assistant without installing dependencies from PyPI to avoid overriding your package.
```shell ```shell
hass --skip-pip hass --skip-pip-packages my_lib_module_name
``` ```

View File

@ -128,17 +128,17 @@ During the development of a component, it can be useful to test against differen
```shell ```shell
pip install pychromecast==3.2.0 --target ~/.homeassistant/deps pip install pychromecast==3.2.0 --target ~/.homeassistant/deps
hass --skip-pip hass --skip-pip-packages pychromecast
``` ```
This will use the specified version, and prevent Home Assistant from trying to override it with what is specified in `requirements`. This will use the specified version, and prevent Home Assistant from trying to override it with what is specified in `requirements`. To prevent any package from being automatically overridden without specifying dependencies, you can launch Home Assistant with the global `--skip-pip` flag.
If you need to make changes to a requirement to support your component, it's also possible to install a development version of the requirement using `pip install -e`: If you need to make changes to a requirement to support your component, it's also possible to install a development version of the requirement using `pip install -e`:
```shell ```shell
git clone https://github.com/balloob/pychromecast.git git clone https://github.com/balloob/pychromecast.git
pip install -e ./pychromecast pip install -e ./pychromecast
hass --skip-pip 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. The following example will install the `except_connect` branch of the `pycoolmaster` library directly from GitHub unless version `0.2.2` is currently installed:

View File

@ -118,7 +118,7 @@ To test it out inside Home Assistant, run the following command from the main Ho
```shell ```shell
pip3 install -e /path/to/hass/frontend/ pip3 install -e /path/to/hass/frontend/
hass --skip-pip hass --skip-pip-packages home-assistant-frontend
``` ```
[hass-frontend]: https://github.com/home-assistant/frontend [hass-frontend]: https://github.com/home-assistant/frontend