Skip to content

Commit

Permalink
Bump version & docs
Browse files Browse the repository at this point in the history
  • Loading branch information
webdjoe committed Dec 23, 2024
1 parent a772fae commit 72cdfe8
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 8 deletions.
12 changes: 7 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Setting up the Development Environment
# Contributing to the pyvesync Library

## Setting up the Development Environment

1. Git clone the repository

Expand Down Expand Up @@ -33,7 +35,7 @@ If the above steps were executed successfully, you should now have:
Any change in the code will now be directly reflected and can be tested. To deactivate the python venv, simply
run `deactivate`.

# Testing Python with Tox
## Testing Python with Tox

Install tox, navigate to the pyvesync repository which contains the tox.ini file, and run tox as follows:

Expand All @@ -48,12 +50,12 @@ tox -e lint # flake8 & pydocstrings
tox -e mypy # type checkings
```

Tests are run based off of the API calls recorded in the [api](src/tests/api) directory. Please read the [Test Readme](src/tests/README.md) for further details on the structure of the tests.
Tests are run based off of the API calls recorded in the [api](src/tests/api) directory. Please read the [Test Readme](src/tests/README.md) for further details on the structure of the tests.


# Ensure new devices are Integrated in Tests

If you integrate a new device, please read the [testing README](tests/README.md) to ensure that your device is tested.
If you integrate a new device, please read the [testing README](src/tests/README.md) to ensure that your device is tested.

## Testing with pytest and Writing API to YAML

Expand Down Expand Up @@ -85,4 +87,4 @@ If fixing an existing device where the API call was incorrect or the api has cha
pytest --write_api --overwrite

tox -e testenv -- --write_api --overwrite
```
```
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

setup(
name='pyvesync',
version='2.1.13',
version='2.1.14',
description='pyvesync is a library to manage Etekcity\
Devices, Cosori Air Fryers and Levoit Air \
Purifiers run on the VeSync app.',
Expand Down
4 changes: 2 additions & 2 deletions src/pyvesync/vesyncswitch.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@
Attributes:
feature_dict (dict): Dictionary of switch models and their supported features.
Defines the class to use for each switch model and the list of features
switch_modules (dict): Dictionary of switch models as keys and their associated classes
as string values.
switch_modules (dict): Dictionary of switch models as keys and their associated
classes as string values.
Note:
The switch device is built from the `feature_dict` dictionary and used by the
Expand Down
1 change: 1 addition & 0 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,5 @@ ignore_errors = True
deps =
mypy
types-requests
allowlist_externals = mypy
commands = mypy src/pyvesync

0 comments on commit 72cdfe8

Please sign in to comment.