comwatt-client 0.2__tar.gz → 0.2.2__tar.gz

comwatt_client-0.2.2/.gitignore

@@ -0,0 +1,160 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

comwatt_client-0.2.2/PKG-INFO

@@ -0,0 +1,99 @@
+Metadata-Version: 2.1
+Name: comwatt-client
+Version: 0.2.2
+Summary: Python Client for Comwatt API
+Home-page: https://github.com/MateoGreil/python-comwatt-client
+Author: Matéo Greil
+Author-email: contact@greil.fr
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Description-Content-Type: text/markdown
+Requires-Dist: requests
+
+# Comwatt Python Client
+
+## Overview
+The Comwatt Python Client is a Python library that provides a convenient way to interact with the Comwatt API. It allows you to authenticate users, retrieve authenticated user information, and access site and device data.
+
+Please note that the Comwatt client is exclusively for gen4 devices: it use `energy.comwatt.com/api`. **Versions below gen4 will not be compatible**. If you're looking for the `go.comwatt.com/api` go to [python-comwatt-client-legacy](https://github.com/MateoGreil/python-comwatt-client-legacy).
+
+## Features
+The client currently supports the following methods:
+
+- `authenticate(self, username, password)`: Authenticates a user with the provided username and password.
+- `get_authenticated_user(self)`: Retrieves information about the authenticated user.
+- `get_sites(self)`: Retrieves a list of sites associated with the authenticated user.
+- `get_site_networks_ts_time_ago(self, site_id, measure_kind = "VIRTUAL_QUANTITY", aggregation_level = "HOUR", aggregation_type = "SUM", time_ago_unit = "DAY", time_ago_value = 1)`: Retrieves the time series data for the networks of a specific site, based on the provided parameters.
+- `get_site_consumption_breakdown_time_ago(self, site_id, aggregation_level = "HOUR", time_ago_unit = "DAY", time_ago_value = 1)` Retrieves the consumption breakdown data for a specific site, based on the provided parameters.
+- `get_devices(self, site_id)`: Retrieves a list of devices for the specified site.
+- `get_device_ts_time_ago(self, device_id, measure_kind = "FLOW", aggregation_level = "HOUR", aggregation_type = "MAX", time_ago_unit = "DAY", time_ago_value = "1")`: Retrieves the time series data for a specific device, based on the provided parameters.
+- `get_device(self, device_id)`: Retrieves information about a specific device.
+- `put_device(self, device_id, payload)`: Updates a specific device with the provided payload.
+
+## Installation
+You can install the Comwatt Python Client using pip. Run the following command:
+
+```
+pip install comwatt-client
+```
+
+## Usage
+Here's a simple example of how to use the Comwatt Python Client:
+
+```python
+from comwatt.client import ComwattClient
+
+# Create a Comwatt client instance
+client = ComwattClient()
+
+# Authenticate the user
+client.authenticate('username', 'password')
+
+# Get information about the authenticated user
+user_info = client.get_authenticated_user()
+print(user_info)
+
+# Get a list of sites associated with the authenticated user
+sites = client.get_sites()
+print(sites)
+
+# Get time series data for the networks of a specific site
+networks_time_series_data = client.get_site_networks_ts_time_ago(sites[0]['id'])
+print(networks_time_series_data)
+
+# Get the consumption breakdown data for a specific site, based on the provided parameters.
+consumption_breakdown_data = client.get_site_consumption_breakdown_time_ago(sites[0]['id'])
+print(consumption_breakdown_data)
+
+# Get a list of devices for a specific site
+devices = client.get_devices(sites[0]['id'])
+print(devices)
+
+# Get time series data for a specific device
+time_series_data = client.get_device_ts_time_ago(devices[0]['id'])
+print(time_series_data)
+
+# Set the control mode of a specific device to MANUL
+device = client.get_device(devices[0]['id'])
+device['configuration']['controlMode'] = 'MANUAL'
+client.put_device(device['id'], device)
+
+# Switch the POWER_SWITCH capacity
+for feature in device['features']:
+    for capacity in feature['capacities']:
+        if capacity.get('capacity', {}).get('nature') == "POWER_SWITCH":
+            capacity_id = capacity['capacity']['id']
+client.switch_capacity(capacity_id, False)
+client.switch_capacity(capacity_id, True)
+
+```
+
+Make sure to replace `'username'`, `'password'` with the actual values for your Comwatt account.
+
+## Contributing
+Contributions to the Comwatt Python Client are welcome! If you find any issues or have suggestions for improvement, please open an issue or submit a pull request on the GitHub repository.

{comwatt-client-0.2 → comwatt_client-0.2.2}/README.md

@@ -2,7 +2,8 @@
 
 ## Overview
 The Comwatt Python Client is a Python library that provides a convenient way to interact with the Comwatt API. It allows you to authenticate users, retrieve authenticated user information, and access site and device data.
-Please note that the Comwatt client is exclusively for gen4 devices. Versions below gen4 will not be compatible.
+
+Please note that the Comwatt client is exclusively for gen4 devices: it use `energy.comwatt.com/api`. **Versions below gen4 will not be compatible**. If you're looking for the `go.comwatt.com/api` go to [python-comwatt-client-legacy](https://github.com/MateoGreil/python-comwatt-client-legacy).
 
 ## Features
 The client currently supports the following methods:
@@ -64,6 +65,15 @@ print(time_series_data)
 device = client.get_device(devices[0]['id'])
 device['configuration']['controlMode'] = 'MANUAL'
 client.put_device(device['id'], device)
+
+# Switch the POWER_SWITCH capacity
+for feature in device['features']:
+    for capacity in feature['capacities']:
+        if capacity.get('capacity', {}).get('nature') == "POWER_SWITCH":
+            capacity_id = capacity['capacity']['id']
+client.switch_capacity(capacity_id, False)
+client.switch_capacity(capacity_id, True)
+
 ```
 
 Make sure to replace `'username'`, `'password'` with the actual values for your Comwatt account.

{comwatt-client-0.2 → comwatt_client-0.2.2}/comwatt_client/client.py

@@ -2,6 +2,8 @@ import requests
 import json
 import hashlib
 
+# from deprecated import deprecated
+
 class ComwattClient:
     """
     A client for interacting with the Comwatt API.
@@ -227,6 +229,7 @@ class ComwattClient:
             raise Exception(f'Error retrieving sites: {response.status_code}')
 
 
+    # @deprecated
     def get_device_ts_time_ago(self, device_id,
             measure_kind = "FLOW",
             aggregation_level = "HOUR",
@@ -265,3 +268,23 @@ class ComwattClient:
             return response.json()
         else:
             raise Exception(f'Error retrieving aggregations: {response.status_code}')
+
+    def switch_capacity(self, capacity_id, enable):
+        """
+        Switch a specific capcaity to the enable value.
+
+        Args:
+            capacity_id (str): The ID of the capacity.
+            enable (bool): The target state.
+
+        Returns:
+            dict: A dictionary containing the response from the API.
+
+        """
+        url = f'{self.base_url}/capacities/{capacity_id}/switch?enable={enable}'
+
+        response = self.session.put(url)
+        if response.status_code == 200:
+            return response.json()
+        else:
+            raise Exception(f'Error retrieving sites: {response.status_code}')

comwatt_client-0.2.2/comwatt_client.egg-info/PKG-INFO

@@ -0,0 +1,99 @@
+Metadata-Version: 2.1
+Name: comwatt-client
+Version: 0.2.2
+Summary: Python Client for Comwatt API
+Home-page: https://github.com/MateoGreil/python-comwatt-client
+Author: Matéo Greil
+Author-email: contact@greil.fr
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Description-Content-Type: text/markdown
+Requires-Dist: requests
+
+# Comwatt Python Client
+
+## Overview
+The Comwatt Python Client is a Python library that provides a convenient way to interact with the Comwatt API. It allows you to authenticate users, retrieve authenticated user information, and access site and device data.
+
+Please note that the Comwatt client is exclusively for gen4 devices: it use `energy.comwatt.com/api`. **Versions below gen4 will not be compatible**. If you're looking for the `go.comwatt.com/api` go to [python-comwatt-client-legacy](https://github.com/MateoGreil/python-comwatt-client-legacy).
+
+## Features
+The client currently supports the following methods:
+
+- `authenticate(self, username, password)`: Authenticates a user with the provided username and password.
+- `get_authenticated_user(self)`: Retrieves information about the authenticated user.
+- `get_sites(self)`: Retrieves a list of sites associated with the authenticated user.
+- `get_site_networks_ts_time_ago(self, site_id, measure_kind = "VIRTUAL_QUANTITY", aggregation_level = "HOUR", aggregation_type = "SUM", time_ago_unit = "DAY", time_ago_value = 1)`: Retrieves the time series data for the networks of a specific site, based on the provided parameters.
+- `get_site_consumption_breakdown_time_ago(self, site_id, aggregation_level = "HOUR", time_ago_unit = "DAY", time_ago_value = 1)` Retrieves the consumption breakdown data for a specific site, based on the provided parameters.
+- `get_devices(self, site_id)`: Retrieves a list of devices for the specified site.
+- `get_device_ts_time_ago(self, device_id, measure_kind = "FLOW", aggregation_level = "HOUR", aggregation_type = "MAX", time_ago_unit = "DAY", time_ago_value = "1")`: Retrieves the time series data for a specific device, based on the provided parameters.
+- `get_device(self, device_id)`: Retrieves information about a specific device.
+- `put_device(self, device_id, payload)`: Updates a specific device with the provided payload.
+
+## Installation
+You can install the Comwatt Python Client using pip. Run the following command:
+
+```
+pip install comwatt-client
+```
+
+## Usage
+Here's a simple example of how to use the Comwatt Python Client:
+
+```python
+from comwatt.client import ComwattClient
+
+# Create a Comwatt client instance
+client = ComwattClient()
+
+# Authenticate the user
+client.authenticate('username', 'password')
+
+# Get information about the authenticated user
+user_info = client.get_authenticated_user()
+print(user_info)
+
+# Get a list of sites associated with the authenticated user
+sites = client.get_sites()
+print(sites)
+
+# Get time series data for the networks of a specific site
+networks_time_series_data = client.get_site_networks_ts_time_ago(sites[0]['id'])
+print(networks_time_series_data)
+
+# Get the consumption breakdown data for a specific site, based on the provided parameters.
+consumption_breakdown_data = client.get_site_consumption_breakdown_time_ago(sites[0]['id'])
+print(consumption_breakdown_data)
+
+# Get a list of devices for a specific site
+devices = client.get_devices(sites[0]['id'])
+print(devices)
+
+# Get time series data for a specific device
+time_series_data = client.get_device_ts_time_ago(devices[0]['id'])
+print(time_series_data)
+
+# Set the control mode of a specific device to MANUL
+device = client.get_device(devices[0]['id'])
+device['configuration']['controlMode'] = 'MANUAL'
+client.put_device(device['id'], device)
+
+# Switch the POWER_SWITCH capacity
+for feature in device['features']:
+    for capacity in feature['capacities']:
+        if capacity.get('capacity', {}).get('nature') == "POWER_SWITCH":
+            capacity_id = capacity['capacity']['id']
+client.switch_capacity(capacity_id, False)
+client.switch_capacity(capacity_id, True)
+
+```
+
+Make sure to replace `'username'`, `'password'` with the actual values for your Comwatt account.
+
+## Contributing
+Contributions to the Comwatt Python Client are welcome! If you find any issues or have suggestions for improvement, please open an issue or submit a pull request on the GitHub repository.

{comwatt-client-0.2 → comwatt_client-0.2.2}/comwatt_client.egg-info/SOURCES.txt

@@ -1,4 +1,6 @@
+.gitignore
 README.md
+requirements.txt
 setup.py
 comwatt_client/__init__.py
 comwatt_client/client.py

comwatt_client-0.2.2/requirements.txt

@@ -0,0 +1,2 @@
+requests==2.31.0
+deprecated==1.2.15

{comwatt-client-0.2 → comwatt_client-0.2.2}/setup.py

@@ -1,11 +1,17 @@
 from setuptools import setup, find_packages
 
+with open("README.md", 'r') as f:
+    long_description = f.read()
+
 setup(
     name='comwatt-client',
-    version='0.2',
+    version='0.2.2',
     author='Matéo Greil',
     author_email='contact@greil.fr',
     description='Python Client for Comwatt API',
+    long_description=long_description,
+    long_description_content_type='text/markdown',
+    url="https://github.com/MateoGreil/python-comwatt-client",
     packages=find_packages(),
     install_requires=[
         'requests',

comwatt-client-0.2/PKG-INFO

@@ -1,14 +0,0 @@
-Metadata-Version: 2.1
-Name: comwatt-client
-Version: 0.2
-Summary: Python Client for Comwatt API
-Author: Matéo Greil
-Author-email: contact@greil.fr
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Requires-Dist: requests

comwatt-client-0.2/comwatt_client.egg-info/PKG-INFO

@@ -1,14 +0,0 @@
-Metadata-Version: 2.1
-Name: comwatt-client
-Version: 0.2
-Summary: Python Client for Comwatt API
-Author: Matéo Greil
-Author-email: contact@greil.fr
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Requires-Dist: requests