Merge pull request #145 from oischinger/devenv

fix dev environment
oischinger · Aug 12, 2023 · 491c82a · 491c82a · github-actions · Aug 12, 2023
2 parents b65533b + 0d630cf
commit 491c82a
Show file tree

Hide file tree

Showing 5 changed files with 44 additions and 4 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
+venv
 .vscode
 *.code-workspace
 *.pyc

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -51,7 +51,7 @@ repos:
           - --configfile=tests/bandit.yaml
         files: ^(homeassistant|script|tests)/.+\.py$
   - repo: https://github.com/PyCQA/isort
-    rev: 5.11.4
+    rev: 5.12.0
     hooks:
       - id: isort
   - repo: https://github.com/pre-commit/pre-commit-hooks

diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
@@ -1,13 +1,49 @@
-
 # Development
 
 This custom component repository is unrelated to the [Home Assistant Core](https://github.com/home-assistant/core) repository.
 
 Most of the times it is some commits ahead of the core repository.
 
+## Development environment
+
+### Install core dependencies:
+
+Make sure your system has an up to date python version (ideally the same as required [here](https://developers.home-assistant.io/docs/development_environment)).
+
+```
+sudo apt-get update
+sudo apt-get install python3-pip python3-dev python3-venv
+```
+
+### Create a venv
+
+In the root directory of this repository create a venv initially:
+
+```
+python3 -m venv venv
+```
+
+Change to the venv:
+
+```
+source venv/bin/activate
+```
+
+### Install development and test dependencies
+
+```
+python3 -m pip install -r requirements_dev.txt
+python3 -m pip install -r requirements_test.txt
+```
+
+### Run tests
+
+Just run `pytest`
+
 # Creating a PR
 
 To create a PR to this repository please install this commit hook:
+
 ```
 python3 -m pip install pre-commit
 pre-commit install
@@ -22,4 +58,3 @@ Make sure to setup the development environment like as described [here](https://
 Create a patch from a given commit e.g. with `git format-patch HEAD~1` and apply it on the HA Core repo with this command:
 
 `git am -p2 --directory=homeassistant/components path_to_ha_vicare/custom_components/vicare/0001-some.patch`
-
diff --git a/README.md b/README.md
@@ -39,6 +39,10 @@ Open the `Configuration` of your Home-Assistant instance and select `Integration
 Add a new integration, search and select `vicare`.
 A dialog appears to enter your [ViCare API](https://developer.viessmann.com/start.html) credentials. Please see the documentation of the [official Home Assistant ViCare integration](https://www.home-assistant.io/integrations/vicare) for further details.
 
+## Development
+
+See [DEVELOPMENT.md](DEVELOPMENT.md) for how to set up a development environment and contribute.
+
 ## Links/Credits:
 
 - [Original feature request in HA community](https://community.home-assistant.io/t/viessmann-component/77873)

diff --git a/requirements_dev.txt b/requirements_dev.txt
@@ -1,2 +1,2 @@
-PyViCare >= 2.25.0
+PyViCare == 2.25.0
 homeassistant >= 2023.4.1
File	Stmts	Miss	Cover	Missing
__init__.py	68	11	83%	57, 61, 65, 74, 79–80, 89, 110–112, 118
binary_sensor.py	99	17	82%	107, 110, 114–116, 186–187, 199–200, 259–266
button.py	72	16	77%	58, 61, 65–67, 125–135
climate.py	222	83	62%	217–220, 222–224, 226–229, 231, 233–234, 236–237, 239–240, 243, 245–247, 249–250, 254–255, 259, 261, 263–265, 267–269, 273–280, 304–305, 307–309, 311–312, 316–317, 319–323, 331–338, 344, 364–366, 380–382, 386–387, 389–393, 395, 404–405, 407, 411
config_flow.py	14	0	100%
const.py	21	0	100%
diagnostics.py	19	19	0%	2, 4–5, 7–10, 12–13, 15, 18, 22, 24, 30, 32–36
helpers.py	9	0	100%
sensor.py	107	17	84%	601, 604, 680–681, 693–694, 755–756, 759, 762–769
water_heater.py	112	20	82%	115–117, 121–122, 126–127, 129–136, 181–183, 198, 208
TOTAL	743	183	75%