sunsynk-api-client 1.2.0__tar.gz → 1.2.1__tar.gz

sunsynk_api_client-1.2.1/PKG-INFO

@@ -0,0 +1,99 @@
+Metadata-Version: 2.4
+Name: sunsynk-api-client
+Version: 1.2.1
+Summary: API client for interacting with SunSynk APIs.
+Author: James Ridgway
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/jamesridgway/sunsynk-api-client
+Project-URL: Changelog, https://github.com/jamesridgway/sunsynk-api-client/releases
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Framework :: AsyncIO
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp>=3.9
+Requires-Dist: cryptography>=41
+Dynamic: license-file
+
+# Sunsynk API Client
+[![CI](https://github.com/jamesridgway/sunsynk-api-client/actions/workflows/ci.yml/badge.svg)](https://github.com/jamesridgway/sunsynk-api-client/actions/workflows/ci.yml)
+
+An API client library for reading data from the Sunsynk API that is used by the Sunsynk Connect apps and 
+[PowerView](https://pv.inteless.com/) portal.
+
+
+## Install
+
+    pip install sunsynk-api-client
+
+## Example Usage
+
+    import asyncio
+    import os
+    
+    from sunsynk.client import SunsynkClient
+    
+    
+    async def main():
+        sunsynk_username = os.getenv('SUNSYNK_USERNAME')
+        sunsynk_password = os.getenv('SUNSYNK_PASSWORD')
+    
+        async with SunsynkClient(sunsynk_username, sunsynk_password) as client:
+            inverters = await client.get_inverters()
+            for inverter in inverters:
+                grid = await client.get_inverter_realtime_grid(inverter.sn)
+                battery = await client.get_inverter_realtime_battery(inverter.sn)
+                solar_pv = await client.get_inverter_realtime_input(inverter.sn)
+    
+                await client.get_inverter_realtime_output(inverter.sn)
+    
+                print(f"Inverter (sn: {inverter.sn}) is drawing {grid.get_power()}W from the grid, {battery.power}W from battery and {solar_pv.get_power()}W.")
+    
+        print('Done!')
+    
+    asyncio.run(main())
+
+
+## Use With an Existing aiohttp Session
+
+Pass a `session` to share an existing `aiohttp.ClientSession`. The client does
+not close a shared session:
+
+    async with aiohttp.ClientSession() as session:
+        client = SunsynkClient(sunsynk_username, sunsynk_password, session=session)
+        await client.login()
+        inverters = await client.get_inverters()
+
+## Errors
+
+All errors raised by the client subclass `sunsynk.exceptions.SunsynkError`:
+
+* `SunsynkAuthenticationError` - the username or password is not correct.
+* `SunsynkConnectionError` - the API could not be reached, timed out, or
+  returned an unexpected response.
+
+Numeric values in the API responses are converted to `float` or `int`. Values
+that are missing are `None`.
+
+## Load, Plant Details and Weather
+
+In addition to the inverter realtime data shown above, the client can also read
+the realtime load/UPS metrics, full plant details (including coordinates), and
+the weather for a plant's location:
+
+    async with SunsynkClient(sunsynk_username, sunsynk_password) as client:
+        inverters = await client.get_inverters()
+        load = await client.get_inverter_realtime_load(inverters[0].sn)
+        print(f"Load is drawing {load.get_power()}W ({load.daily_used} kWh used today)")
+
+        # get_plant returns the full plant detail, including lon/lat coordinates
+        plant = await client.get_plant(inverters[0].plant.id)
+
+        # The Sunsynk weather endpoint expects the coordinates as "lat,lon"
+        weather = await client.get_weather(f"{plant.lat},{plant.lon}")
+        print(f"It is currently {weather.get_current_temp()}C and {weather.description}")
+
+`get_weather` defaults to today's date; pass `date="YYYY-MM-DD"` to request a
+specific day.

{sunsynk_api_client-1.2.0 → sunsynk_api_client-1.2.1}/README.md

@@ -5,6 +5,10 @@ An API client library for reading data from the Sunsynk API that is used by the
 [PowerView](https://pv.inteless.com/) portal.
 
 
+## Install
+
+    pip install sunsynk-api-client
+
 ## Example Usage
 
     import asyncio

sunsynk_api_client-1.2.1/pyproject.toml

@@ -0,0 +1,33 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "sunsynk-api-client"
+version = "1.2.1"
+description = "API client for interacting with SunSynk APIs."
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "James Ridgway" }]
+requires-python = ">=3.13"
+dependencies = [
+    "aiohttp>=3.9",
+    "cryptography>=41",
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Framework :: AsyncIO",
+]
+
+[project.urls]
+Homepage = "https://github.com/jamesridgway/sunsynk-api-client"
+Changelog = "https://github.com/jamesridgway/sunsynk-api-client/releases"
+
+[tool.setuptools.packages.find]
+include = ["sunsynk*"]
+
+[tool.setuptools.package-data]
+sunsynk = ["py.typed"]

sunsynk_api_client-1.2.1/sunsynk/__init__.py

@@ -0,0 +1,3 @@
+"""Async client for the Sunsynk API."""
+
+__version__ = "1.2.1"

sunsynk_api_client-1.2.1/sunsynk_api_client.egg-info/PKG-INFO

@@ -0,0 +1,99 @@
+Metadata-Version: 2.4
+Name: sunsynk-api-client
+Version: 1.2.1
+Summary: API client for interacting with SunSynk APIs.
+Author: James Ridgway
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/jamesridgway/sunsynk-api-client
+Project-URL: Changelog, https://github.com/jamesridgway/sunsynk-api-client/releases
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Framework :: AsyncIO
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp>=3.9
+Requires-Dist: cryptography>=41
+Dynamic: license-file
+
+# Sunsynk API Client
+[![CI](https://github.com/jamesridgway/sunsynk-api-client/actions/workflows/ci.yml/badge.svg)](https://github.com/jamesridgway/sunsynk-api-client/actions/workflows/ci.yml)
+
+An API client library for reading data from the Sunsynk API that is used by the Sunsynk Connect apps and 
+[PowerView](https://pv.inteless.com/) portal.
+
+
+## Install
+
+    pip install sunsynk-api-client
+
+## Example Usage
+
+    import asyncio
+    import os
+    
+    from sunsynk.client import SunsynkClient
+    
+    
+    async def main():
+        sunsynk_username = os.getenv('SUNSYNK_USERNAME')
+        sunsynk_password = os.getenv('SUNSYNK_PASSWORD')
+    
+        async with SunsynkClient(sunsynk_username, sunsynk_password) as client:
+            inverters = await client.get_inverters()
+            for inverter in inverters:
+                grid = await client.get_inverter_realtime_grid(inverter.sn)
+                battery = await client.get_inverter_realtime_battery(inverter.sn)
+                solar_pv = await client.get_inverter_realtime_input(inverter.sn)
+    
+                await client.get_inverter_realtime_output(inverter.sn)
+    
+                print(f"Inverter (sn: {inverter.sn}) is drawing {grid.get_power()}W from the grid, {battery.power}W from battery and {solar_pv.get_power()}W.")
+    
+        print('Done!')
+    
+    asyncio.run(main())
+
+
+## Use With an Existing aiohttp Session
+
+Pass a `session` to share an existing `aiohttp.ClientSession`. The client does
+not close a shared session:
+
+    async with aiohttp.ClientSession() as session:
+        client = SunsynkClient(sunsynk_username, sunsynk_password, session=session)
+        await client.login()
+        inverters = await client.get_inverters()
+
+## Errors
+
+All errors raised by the client subclass `sunsynk.exceptions.SunsynkError`:
+
+* `SunsynkAuthenticationError` - the username or password is not correct.
+* `SunsynkConnectionError` - the API could not be reached, timed out, or
+  returned an unexpected response.
+
+Numeric values in the API responses are converted to `float` or `int`. Values
+that are missing are `None`.
+
+## Load, Plant Details and Weather
+
+In addition to the inverter realtime data shown above, the client can also read
+the realtime load/UPS metrics, full plant details (including coordinates), and
+the weather for a plant's location:
+
+    async with SunsynkClient(sunsynk_username, sunsynk_password) as client:
+        inverters = await client.get_inverters()
+        load = await client.get_inverter_realtime_load(inverters[0].sn)
+        print(f"Load is drawing {load.get_power()}W ({load.daily_used} kWh used today)")
+
+        # get_plant returns the full plant detail, including lon/lat coordinates
+        plant = await client.get_plant(inverters[0].plant.id)
+
+        # The Sunsynk weather endpoint expects the coordinates as "lat,lon"
+        weather = await client.get_weather(f"{plant.lat},{plant.lon}")
+        print(f"It is currently {weather.get_current_temp()}C and {weather.description}")
+
+`get_weather` defaults to today's date; pass `date="YYYY-MM-DD"` to request a
+specific day.

{sunsynk_api_client-1.2.0 → sunsynk_api_client-1.2.1}/sunsynk_api_client.egg-info/SOURCES.txt

@@ -1,6 +1,6 @@
 LICENSE
 README.md
-setup.py
+pyproject.toml
 sunsynk/__init__.py
 sunsynk/battery.py
 sunsynk/client.py
@@ -14,8 +14,6 @@ sunsynk/plant.py
 sunsynk/pviv.py
 sunsynk/py.typed
 sunsynk/resource.py
-sunsynk/version.py
-sunsynk/version_info.py
 sunsynk/vip.py
 sunsynk/vip_resource.py
 sunsynk/weather.py

sunsynk_api_client-1.2.0/PKG-INFO

@@ -1,27 +0,0 @@
-Metadata-Version: 2.4
-Name: sunsynk-api-client
-Version: 1.2.0
-Summary: API client for interacting with SunSynk APIs.
-Home-page: https://github.com/jamesridgway/sunsynk-api-client
-Author: James Ridgway
-License: MIT
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.14
-Classifier: Framework :: AsyncIO
-Requires-Python: >=3.13
-License-File: LICENSE
-Requires-Dist: aiohttp>=3.9
-Requires-Dist: cryptography>=41
-Dynamic: author
-Dynamic: classifier
-Dynamic: description
-Dynamic: home-page
-Dynamic: license
-Dynamic: license-file
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
-
-API client for interacting with SunSynk APIs.

sunsynk_api_client-1.2.0/setup.py

@@ -1,31 +0,0 @@
-import os
-
-from setuptools import setup, find_packages
-
-from sunsynk.version_info import Version
-
-Version.generate()
-
-with open(os.path.abspath(os.path.join(os.path.dirname(__file__), 'requirements.txt'))) as f:
-    install_reqs = f.read().splitlines()
-
-setup(
-    name='sunsynk-api-client',
-    version=Version.get(),
-    description='API client for interacting with SunSynk APIs.',
-    long_description='API client for interacting with SunSynk APIs.',
-    author='James Ridgway',
-    url='https://github.com/jamesridgway/sunsynk-api-client',
-    license='MIT',
-    packages=find_packages(exclude=['tests', 'tests.*']),
-    package_data={'sunsynk': ['py.typed']},
-    python_requires='>=3.13',
-    install_requires=install_reqs,
-    classifiers=[
-        'License :: OSI Approved :: MIT License',
-        'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.13',
-        'Programming Language :: Python :: 3.14',
-        'Framework :: AsyncIO',
-    ],
-)

sunsynk_api_client-1.2.0/sunsynk/version.py

@@ -1 +0,0 @@
-SUNSYNK_API_CLIENT_VERSION = "1.2.0"

sunsynk_api_client-1.2.0/sunsynk/version_info.py

@@ -1,41 +0,0 @@
-import os
-import platform
-import subprocess
-import sys
-
-VERSION_FILENAME = os.path.abspath(os.path.join(os.path.dirname(__file__), 'version.py'))
-
-
-class Version:
-    @staticmethod
-    def generate() -> str:
-        with subprocess.Popen(["git", "describe", "--always", "--tags"],
-                              stdout=subprocess.PIPE,
-                              stderr=None) as process:
-            last_tag = process.communicate()[0].decode('ascii').strip()
-            version = last_tag.split('-g', maxsplit=1)[0].replace('-', '.') if '-g' in last_tag else last_tag
-            with open(VERSION_FILENAME, 'w',encoding='utf-8') as file:
-                file.write(f'SUNSYNK_API_CLIENT_VERSION = "{version}"\n')
-            return version
-
-    @staticmethod
-    def get(retry=True) -> str:
-        try:
-            # pylint: disable=C0415
-            from sunsynk.version import SUNSYNK_API_CLIENT_VERSION
-            return SUNSYNK_API_CLIENT_VERSION
-        except ModuleNotFoundError:
-            if retry:
-                Version.generate()
-                return Version.get(False)
-            return 'unknown'
-        except ImportError:
-            if retry:
-                Version.generate()
-                return Version.get(False)
-            return 'unknown'
-
-    @staticmethod
-    def get_env_info() -> str:
-        os_info = f"Release: {platform.release()}, Platform: {platform.platform()}"
-        return f"(Python: {platform.python_version()}), OS: ({os_info}). Default Encoding: {sys.getdefaultencoding()}"

sunsynk_api_client-1.2.0/sunsynk_api_client.egg-info/PKG-INFO

@@ -1,27 +0,0 @@
-Metadata-Version: 2.4
-Name: sunsynk-api-client
-Version: 1.2.0
-Summary: API client for interacting with SunSynk APIs.
-Home-page: https://github.com/jamesridgway/sunsynk-api-client
-Author: James Ridgway
-License: MIT
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.14
-Classifier: Framework :: AsyncIO
-Requires-Python: >=3.13
-License-File: LICENSE
-Requires-Dist: aiohttp>=3.9
-Requires-Dist: cryptography>=41
-Dynamic: author
-Dynamic: classifier
-Dynamic: description
-Dynamic: home-page
-Dynamic: license
-Dynamic: license-file
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
-
-API client for interacting with SunSynk APIs.