pyvesync 3.0.0rc2__tar.gz → 3.1.0__tar.gz

{pyvesync-3.0.0rc2 → pyvesync-3.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyvesync
-Version: 3.0.0rc2
+Version: 3.1.0
 Summary: pyvesync is a library to manage Etekcity Devices, Cosori Air Fryers, and Levoit Air Purifiers run on the VeSync app.
 Author: Mark Perdue
 Author-email: Joe Trabulsy <webdjoe@gmail.com>
@@ -17,18 +17,31 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: aiohttp>=3.8.1
 Requires-Dist: mashumaro[orjson]>=3.13.1
-Requires-Dist: python-dateutil>=2.8.1
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
 Requires-Dist: pyyaml; extra == "dev"
+Requires-Dist: pylint; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
 Requires-Dist: tox; extra == "dev"
+Requires-Dist: requests; extra == "dev"
 Requires-Dist: aiofiles; extra == "dev"
 Provides-Extra: docs
 Requires-Dist: mkdocstrings-python; extra == "docs"
 Requires-Dist: mkdocs; extra == "docs"
+Requires-Dist: ruff; extra == "docs"
+Requires-Dist: Pygments; extra == "docs"
 Requires-Dist: mkdocs-material; extra == "docs"
 Requires-Dist: mkdocstrings; extra == "docs"
+Requires-Dist: mkdocs-include-markdown-plugin; extra == "docs"
+Requires-Dist: mkdocs-material-extensions; extra == "docs"
+Requires-Dist: pymdown-extensions; extra == "docs"
+Requires-Dist: mike; extra == "docs"
+Requires-Dist: mkdocs-git-revision-date-localized-plugin; extra == "docs"
+Requires-Dist: docstring-inheritance; extra == "docs"
+Requires-Dist: mkdocs-autoref; extra == "docs"
 Dynamic: license-file
 
 # pyvesync [![build status](https://img.shields.io/pypi/v/pyvesync.svg)](https://pypi.python.org/pypi/pyvesync) [![Build Status](https://dev.azure.com/webdjoe/pyvesync/_apis/build/status/webdjoe.pyvesync?branchName=master)](https://dev.azure.com/webdjoe/pyvesync/_build/latest?definitionId=4&branchName=master) [![Open Source? Yes!](https://badgen.net/badge/Open%20Source%20%3F/Yes%21/blue?icon=github)](https://github.com/Naereen/badges/) [![PyPI license](https://img.shields.io/pypi/l/ansicolortags.svg)](https://pypi.python.org/pypi/ansicolortags/) <!-- omit in toc -->
@@ -179,13 +192,14 @@ The VeSync signature is:
 VeSync(
     username: str,
     password: str,
+    country_code: str = DEFAULT_COUNTRY_CODE,  # US
     session: ClientSession | None = None,
     time_zone: str = DEFAULT_TZ  # America/New_York
+    debug: bool = False,
+    redact: bool = True,
     )
 ```
 
-The VeSync class no longer accepts a `debug` or `redact` argument. To set debug the library set `manager.debug = True` to the instance and `manager.redact = True`.
-
 ### Product Types
 
 There is a new nomenclature for product types that defines the device class. The
@@ -332,6 +346,59 @@ async def main():
             device.display()
 
 
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+If you want to reuse your token and account_id between runs. The `VeSync.auth` object holds the credentials and helper methods to save and load credentials.
+
+```python
+import asyncio
+from pyvesync import VeSync
+from pyvesync.logs import VeSyncLoginError
+
+# VeSync is an asynchronous context manager
+# VeSync(username, password, debug=False, redact=True, session=None)
+
+async def main():
+    async with VeSync("user", "password") as manager:
+
+        # If credentials are stored in a file, it can be loaded
+        # the default location is ~/.vesync_token
+        await manager.load_credentials_from_file()
+        # or the file path can be passed
+        await manager.load_credentials_from_file("/path/to/token_file")
+
+        # Or credentials can be passed directly
+        manager.set_credentials("your_token", "your_account_id")
+
+        # No login needed
+        # await manager.login()
+
+        # To store credentials to a file after login
+        await manager.save_credentials() # Saves to default location ~/.vesync_token
+        # or pass a file path
+        await manager.save_credentials("/path/to/token_file")
+
+        # Output Credentials as JSON String
+        await manager.output_credentials()
+
+        await manager.update()
+
+        # Acts as a set of device instances
+        device_container = manager.devices
+
+        outlets = device_container.outlets # List of outlet instances
+        outlet = outlets[0]
+        await outlet.update()
+        await outlet.turn_off()
+        outlet.display()
+
+        # Iterate of entire device list
+        for devices in device_container:
+            device.display()
+
+
 if __name__ == "__main__":
     asyncio.run(main())
 ```

pyvesync-3.0.0rc2/src/pyvesync.egg-info/PKG-INFO → pyvesync-3.1.0/README.md

@@ -1,36 +1,3 @@
-Metadata-Version: 2.4
-Name: pyvesync
-Version: 3.0.0rc2
-Summary: pyvesync is a library to manage Etekcity Devices, Cosori Air Fryers, and Levoit Air Purifiers run on the VeSync app.
-Author: Mark Perdue
-Author-email: Joe Trabulsy <webdjoe@gmail.com>
-License: MIT
-Project-URL: Home Page, https://github.com/webdjoe/pyvesync
-Project-URL: Documentation, https://webdjoe.github.io/pyvesync/latest/
-Keywords: iot,vesync,levoit,etekcity,cosori,valceno
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Intended Audience :: Developers
-Classifier: Natural Language :: English
-Classifier: Topic :: Home Automation
-Requires-Python: >=3.11
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: aiohttp>=3.8.1
-Requires-Dist: mashumaro[orjson]>=3.13.1
-Requires-Dist: python-dateutil>=2.8.1
-Provides-Extra: dev
-Requires-Dist: pytest; extra == "dev"
-Requires-Dist: pytest-cov; extra == "dev"
-Requires-Dist: pyyaml; extra == "dev"
-Requires-Dist: tox; extra == "dev"
-Requires-Dist: aiofiles; extra == "dev"
-Provides-Extra: docs
-Requires-Dist: mkdocstrings-python; extra == "docs"
-Requires-Dist: mkdocs; extra == "docs"
-Requires-Dist: mkdocs-material; extra == "docs"
-Requires-Dist: mkdocstrings; extra == "docs"
-Dynamic: license-file
-
 # pyvesync [![build status](https://img.shields.io/pypi/v/pyvesync.svg)](https://pypi.python.org/pypi/pyvesync) [![Build Status](https://dev.azure.com/webdjoe/pyvesync/_apis/build/status/webdjoe.pyvesync?branchName=master)](https://dev.azure.com/webdjoe/pyvesync/_build/latest?definitionId=4&branchName=master) [![Open Source? Yes!](https://badgen.net/badge/Open%20Source%20%3F/Yes%21/blue?icon=github)](https://github.com/Naereen/badges/) [![PyPI license](https://img.shields.io/pypi/l/ansicolortags.svg)](https://pypi.python.org/pypi/ansicolortags/) <!-- omit in toc -->
 
 pyvesync is a library to manage VeSync compatible [smart home devices](#supported-devices)
@@ -179,13 +146,14 @@ The VeSync signature is:
 VeSync(
     username: str,
     password: str,
+    country_code: str = DEFAULT_COUNTRY_CODE,  # US
     session: ClientSession | None = None,
     time_zone: str = DEFAULT_TZ  # America/New_York
+    debug: bool = False,
+    redact: bool = True,
     )
 ```
 
-The VeSync class no longer accepts a `debug` or `redact` argument. To set debug the library set `manager.debug = True` to the instance and `manager.redact = True`.
-
 ### Product Types
 
 There is a new nomenclature for product types that defines the device class. The
@@ -332,6 +300,59 @@ async def main():
             device.display()
 
 
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+If you want to reuse your token and account_id between runs. The `VeSync.auth` object holds the credentials and helper methods to save and load credentials.
+
+```python
+import asyncio
+from pyvesync import VeSync
+from pyvesync.logs import VeSyncLoginError
+
+# VeSync is an asynchronous context manager
+# VeSync(username, password, debug=False, redact=True, session=None)
+
+async def main():
+    async with VeSync("user", "password") as manager:
+
+        # If credentials are stored in a file, it can be loaded
+        # the default location is ~/.vesync_token
+        await manager.load_credentials_from_file()
+        # or the file path can be passed
+        await manager.load_credentials_from_file("/path/to/token_file")
+
+        # Or credentials can be passed directly
+        manager.set_credentials("your_token", "your_account_id")
+
+        # No login needed
+        # await manager.login()
+
+        # To store credentials to a file after login
+        await manager.save_credentials() # Saves to default location ~/.vesync_token
+        # or pass a file path
+        await manager.save_credentials("/path/to/token_file")
+
+        # Output Credentials as JSON String
+        await manager.output_credentials()
+
+        await manager.update()
+
+        # Acts as a set of device instances
+        device_container = manager.devices
+
+        outlets = device_container.outlets # List of outlet instances
+        outlet = outlets[0]
+        await outlet.update()
+        await outlet.turn_off()
+        outlet.display()
+
+        # Iterate of entire device list
+        for devices in device_container:
+            device.display()
+
+
 if __name__ == "__main__":
     asyncio.run(main())
 ```

{pyvesync-3.0.0rc2 → pyvesync-3.1.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pyvesync"
-version = "3.0.0rc2"
+version = "3.1.0"
 description = "pyvesync is a library to manage Etekcity Devices, Cosori Air Fryers, and Levoit Air Purifiers run on the VeSync app."
 readme = "README.md"
 requires-python = ">=3.11"
@@ -23,7 +23,6 @@ classifiers = [
 dependencies = [
     "aiohttp>=3.8.1",
     "mashumaro[orjson]>=3.13.1",
-    "python-dateutil>=2.8.1"
 ]
 
 [project.urls]
@@ -35,14 +34,28 @@ dev = [
     "pytest",
     "pytest-cov",
     "pyyaml",
+    "pylint",
+    "mypy",
+    "ruff",
+    "pre-commit",
     "tox",
+    "requests",
     "aiofiles"
 ]
 docs = [
     "mkdocstrings-python",
     "mkdocs",
+    "ruff",
+    "Pygments",
     "mkdocs-material",
     "mkdocstrings",
+    "mkdocs-include-markdown-plugin",
+    "mkdocs-material-extensions",
+    "pymdown-extensions",
+    "mike",
+    "mkdocs-git-revision-date-localized-plugin",
+    "docstring-inheritance",
+    "mkdocs-autoref"
 ]
 
 [tool.setuptools.packages.find]
@@ -56,6 +69,29 @@ norecursedirs = ["*.egg-info", ".git", ".tox", "dist", "build", "venv"]
 pythonpath = "src"
 log_cli = true
 
+[tool.coverage.run]
+branch = true
+omit = [
+    "test/*",
+    "src/tests/*",
+    "testing_scripts/*"
+]
+
+[tool.coverage.report]
+exclude_also = [
+    'pragma: no cover',
+    'if self\\.debug',
+    "def __repr__",
+    "def __str__",
+    "def __eq__",
+    "def __hash__",
+    "def firmware_update",
+    "def get_config",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "@(abc\\.)?abstractmethod",
+]
+
 [tool.pylint.MAIN]
 persistent = false
 ignore-paths = ["^test\\.*$"]

{pyvesync-3.0.0rc2 → pyvesync-3.1.0}/setup.py

@@ -2,5 +2,4 @@
 
 from setuptools import setup
 
-
 setup()

pyvesync-3.1.0/src/pyvesync/__init__.py

@@ -0,0 +1,5 @@
+"""VeSync API Library."""
+
+from pyvesync.vesync import VeSync
+
+__all__ = ['VeSync']