Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Describe how to work with a fork of Python Thermia Online API #92

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+20 −0
Open

Describe how to work with a fork of Python Thermia Online API #92

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,26 @@ custom_components/thermia_water_heater/__init__.py
custom_components/thermia_water_heater/manifest.json
custom_components/thermia_water_heater/water_heater.py
```
## Manually installing Python Thermia Online API

Ordinarily Home Assistant will automatically install dependencies such as the [Python Thermia Online API](https://github.com/klejejs/python-thermia-online-api) when installing an integration. However if you are working on improving this integration, it may be helpful to install a forked version of the [Python Thermia Online API](https://github.com/klejejs/python-thermia-online-api) with improvements you may be working on. The easiest way to do this, is to push your changes to a fork of [Python Thermia Online API](https://github.com/klejejs/python-thermia-online-api) on your github.

Then if you have manually installed Home Assistant, you can install the forked Thermia Online API as follows:

```shell
root@ha:~$ pip uninstall -y ThermiaOnlineAPI
root@ha:~$ pip install git+https://github.com/<username>/python-thermia-online-api.git#egg=ThermiaOnlineAPI
```

Otherwise if you are using the [Home Assistant Virtual Machine](https://www.home-assistant.io/installation/alternative), you will first need to logon to the docker container where Home Assistant is running before following the steps above.

```shell
root@ha:~$ docker exec -it homeassistant sh
/config # pip uninstall -y ThermiaOnlineAPI
/config # pip install git+https://github.com/<username>/python-thermia-online-api.git#egg=ThermiaOnlineAPI
...
```


---

Expand Down
Loading