juham-visualcrossing 0.1.2__tar.gz → 0.1.8__tar.gz

{juham_visualcrossing-0.1.2/docs/source → juham_visualcrossing-0.1.8}/LICENSE.rst

@@ -1,22 +1,22 @@
-MIT License
-===========
-
-Copyright (c) 2024, Juha Meskanen
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-
+MIT License
+===========
+
+Copyright (c) 2024, Juha Meskanen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+

{juham_visualcrossing-0.1.2 → juham_visualcrossing-0.1.8}/MANIFEST.in

@@ -1,11 +1,11 @@
-include docs/source/README.rst
-include docs/source/CHANGELOG.rst
-include docs/source/LICENSE.rst
-include docs/source/CONTRIBUTING.rst
-
-recursive-include tests *
-recursive-include docs/build/html *
-
-# files to be excluded
-global-exclude *~ \#*
-
+include docs/source/README.rst
+include docs/source/CHANGELOG.rst
+include docs/source/LICENSE.rst
+include docs/source/CONTRIBUTING.rst
+
+recursive-include tests *
+recursive-include docs/build/html *
+
+# files to be excluded
+global-exclude *~ \#*
+

{juham_visualcrossing-0.1.2 → juham_visualcrossing-0.1.8}/PKG-INFO

@@ -1,88 +1,87 @@
-Metadata-Version: 2.1
-Name: juham_visualcrossing
-Version: 0.1.2
-Summary: A Weather forecast  plugin extending `Juham` applications
-Author-email: J Meskanen <juham.api@gmail.com>
-Maintainer-email: "J. Meskanen" <juham.api@gmail.com>
-License: MIT License
-        ===========
-        
-        Copyright (c) 2024, Juha Meskanen
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy
-        of this software and associated documentation files (the "Software"), to deal
-        in the Software without restriction, including without limitation the rights
-        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-        copies of the Software, and to permit persons to whom the Software is
-        furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all
-        copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-        
-        
-Project-URL: Homepage, https://meskanen.com
-Project-URL: Bug Reports, https://meskanen.com
-Project-URL: Funding, https://meskanen.com
-Project-URL: Say Thanks!, http://meskanen.com
-Project-URL: Source, https://meskanen.com
-Keywords: object-oriented,plugin,framework
-Classifier: Development Status :: 2 - Pre-Alpha
-Classifier: Intended Audience :: Developers
-Classifier: Topic :: Software Development
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3.8
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-Requires-Dist: juham>=0.1.3
-Requires-Dist: pytz>=2024.1
-Requires-Dist: importlib-metadata
-Provides-Extra: dev
-Requires-Dist: check-manifest; extra == "dev"
-
-juham_visualcrossing
-====================
-
-`juham_visualcrossing` plugs VisualCrossing weather forecast service to Juham - Juha's Ultimate
-Home Automation Masterpiece application.
-
-
-
-Features
---------
-
-The main purpose is to acquire solar energy forecast, for optimizing energy management in
-homes with solar panels. 
-
-
-Installation
-------------
-
-The installation is two stage process
-
-1. To install:
-
-.. code-block:: python
-
-    pip install juham_visualcrossing
-
-
-2. Configure
-
-   VisualCrossing requires you to register and obtain web key, through which you can
-   access their forecast services. So sign in to visualcrossing.com to obtain the key,
-   and then add the web key to the '~/.[app]/config/VisualCrossing.json' configuration
-   file.
-
-
-
-License
--------
-
-This project is licensed under the MIT License - see the `LICENSE` file for details.
+Metadata-Version: 2.2
+Name: juham-visualcrossing
+Version: 0.1.8
+Summary: A Weather forecast  plugin extending `Juham` applications
+Author-email: J Meskanen <juham.api@gmail.com>
+Maintainer-email: "J. Meskanen" <juham.api@gmail.com>
+License: MIT License
+        ===========
+        
+        Copyright (c) 2024, Juha Meskanen
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        
+        
+Project-URL: Homepage, https://gitlab.com/juham/juham/juham-visualcrossing
+Project-URL: Bug Reports, https://gitlab.com/juham/juham/juham-visualcrossing
+Project-URL: Funding, https://meskanen.com
+Project-URL: Say Thanks!, http://meskanen.com
+Project-URL: Source, https://gitlab.com/juham/juham/juham-visualcrossing
+Keywords: object-oriented,plugin,framework
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.8
+Requires-Python: >=3.8
+Description-Content-Type: text/x-rst
+License-File: LICENSE.rst
+Requires-Dist: juham-core>=0.1.1
+Requires-Dist: pytz>=2024.1
+Provides-Extra: dev
+Requires-Dist: check-manifest; extra == "dev"
+
+VisualCrossing forecast plugin for Juham™
+=========================================
+
+Description
+-----------
+
+Adds forecast support to Juham™ home automation.
+
+.. image:: _static/images/visualcrossing.png
+   :alt: Solar and temperature forecasts
+   :width: 640px
+   :align: center  
+
+
+Project Status
+--------------
+
+**Current State**: **Alpha (Status 3)**  
+
+Please check out the `CHANGELOG <CHANGELOG.rst>`_ file for changes in this release.
+
+
+
+Getting Started
+---------------
+
+### Installation
+
+1. Install
+
+   .. code-block:: bash
+
+      pip install juham_visualcrossing
+
+
+2. Configure
+
+   - ``VisualCrossing.json``: Add your Visual Crossing API key for weather forecasts.
+

{juham_visualcrossing-0.1.2 → juham_visualcrossing-0.1.8}/README.rst

@@ -1,34 +1,39 @@
-VisualCrossing forecast plugin for Juham™
-=========================================
-
-Description
------------
-
-Adds forecast support to Juham™ home automation.
-
-
-Project Status
---------------
-
-**Current State**: **Pre-Alpha (Status 2)**  
-
-Please check out the `CHANGELOG <CHANGELOG.rst>`_ file for changes in this release.
-
-
-
-Getting Started
----------------
-
-### Installation
-
-1. Install
-
-   .. code-block:: bash
-
-      pip install juham_visualcrossing
-
-
-2. Configure
-
-   - ``VisualCrossing.json``: Add your Visual Crossing API key for weather forecasts.
-
+VisualCrossing forecast plugin for Juham™
+=========================================
+
+Description
+-----------
+
+Adds forecast support to Juham™ home automation.
+
+.. image:: _static/images/visualcrossing.png
+   :alt: Solar and temperature forecasts
+   :width: 640px
+   :align: center  
+
+
+Project Status
+--------------
+
+**Current State**: **Alpha (Status 3)**  
+
+Please check out the `CHANGELOG <CHANGELOG.rst>`_ file for changes in this release.
+
+
+
+Getting Started
+---------------
+
+### Installation
+
+1. Install
+
+   .. code-block:: bash
+
+      pip install juham_visualcrossing
+
+
+2. Configure
+
+   - ``VisualCrossing.json``: Add your Visual Crossing API key for weather forecasts.
+

juham_visualcrossing-0.1.8/juham_visualcrossing/__init__.py

@@ -0,0 +1,16 @@
+"""
+Description
+===========
+
+VisualCrossing weather forecast.
+
+"""
+
+from .visualcrossing import VisualCrossing, VisualCrossingThread
+from .visualcrossing_plugin import VisualCrossingPlugin
+
+__all__ = [
+    "VisualCrossing",
+    "VisualCrossingThread",
+    "VisualCrossingPlugin",
+]

{juham_visualcrossing-0.1.2 → juham_visualcrossing-0.1.8}/juham_visualcrossing/visualcrossing.py

@@ -1,194 +1,194 @@
-from datetime import datetime, timedelta, timezone
-import json
-from typing import Any, Optional, cast
-from typing_extensions import override
-from masterpiece.mqtt import MqttMsg, Mqtt
-from juham.core import RCloud, RCloudThread
-
-
-class VisualCrossingThread(RCloudThread):
-    """Asynchronous thread for acquiring forecast from the VisualCrossing
-    site."""
-
-    # class attributes
-    _forecast_topic: str = ""
-    _base_url: str = ""
-    _api_key: str = ""
-    _location: str = ""
-    _interval: float = 12 * 3600
-
-    def __init__(self, client: Optional[Mqtt] = None):
-        """Construct with the given mqtt client. Acquires data from the visual
-        crossing web service and publishes the forecast data to
-        forecast_topic.
-
-        Args:
-            client (object, optional): MQTT client. Defaults to None.
-        """
-        super().__init__(client)
-        self.mqtt_client: Optional[Mqtt] = client
-
-    @override
-    def update_interval(self) -> float:
-        return self._interval
-
-    @override
-    def make_weburl(self) -> str:
-        if not self._api_key:
-            self.error("Uninitialized api_key {self.get_class_id()}: {self._api_key}")
-            return ""
-        else:
-            now = datetime.now()
-            end = now + timedelta(days=1)
-            start = now.strftime("%Y-%m-%d")
-            stop = end.strftime("%Y-%m-%d")
-            url = f"{self._base_url}{self._location}/{start}/{stop}?unitGroup=metric&contentType=json&include=hours&key={self._api_key}"
-            # self.debug(url)
-            return url
-
-    def init(
-        self, topic: str, base_url: str, interval: float, api_key: str, location: str
-    ) -> None:
-        """Initialize the  data acquisition thread
-
-        Args:
-            topic (str): mqtt topic to publish the acquired data
-            base_url (str): url of the web service
-            interval (float): update interval in seconds
-            api_key (str): api_key, as required by the web service
-            location (str): geographic location
-        """
-        self._forecast_topic = topic
-        self._base_url = base_url
-        self._interval = interval
-        self._api_key = api_key
-        self._location = location
-
-    @override
-    def process_data(self, data: Any) -> None:
-        self.info("VisualCrossing process_data()")
-        data = data.json()
-        forecast = []
-        self.info(f"VisualCrossing {data}")
-        for day in data["days"]:
-            for hour in day["hours"]:
-                ts = int(hour["datetimeEpoch"])
-                forecast.append(
-                    {
-                        "id": "visualcrossing",
-                        "ts": ts,
-                        "hour": datetime.fromtimestamp(ts, tz=timezone.utc).strftime(
-                            "%H"
-                        ),
-                        "day": datetime.fromtimestamp(ts, tz=timezone.utc).strftime(
-                            "%Y%m%d%H"
-                        ),
-                        "uvindex": hour["uvindex"],
-                        "solarradiation": hour["solarradiation"],
-                        "solarenergy": hour["solarenergy"],
-                        "cloudcover": hour["cloudcover"],
-                        "snow": hour["snow"],
-                        "snowdepth": hour["snowdepth"],
-                        "pressure": hour["pressure"],
-                        "temp": hour["temp"],
-                        "humidity": hour["humidity"],
-                        "windspeed": hour["windspeed"],
-                        "winddir": hour["winddir"],
-                        "dew": hour["dew"],
-                    }
-                )
-        msg = json.dumps(forecast)
-        self.publish(self._forecast_topic, msg, qos=1, retain=False)
-        self.info(f"VisualCrossing forecast published to {self._forecast_topic}")
-
-
-class VisualCrossing(RCloud):
-    """Constructs a data acquisition object for reading weather
-    forecasts from the VisualCrossing web service. Subscribes to the
-    forecast topic and writes hourly data such as solar energy, temperature,
-    and other attributes relevant to home automation into a time series
-    database.
-
-    Spawns an asynchronous thread to run queries at the specified
-    update_interval.
-    """
-
-    workerThreadId: str = VisualCrossingThread.get_class_id()
-    base_url: str = (
-        "https://weather.visualcrossing.com/VisualCrossingWebServices/rest/services/timeline/"
-    )
-    update_interval: float = 12 * 3600
-    api_key: str = "SE9W7EHP775N7NDNW8ANM2MZN"
-    location: str = "lahti,finland"
-
-    def __init__(self, name="visualcrossing") -> None:
-        """Constructs VisualCrossing automation object for acquiring and publishing
-        forecast data.
-
-        Args:
-            name (str, optional): name of the object. Defaults to "visualcrossing".
-        """
-        super().__init__(name)
-        self.worker: Optional[VisualCrossingThread] = None
-        self.forecast_topic: str = self.make_topic_name("forecast")
-        self.debug(f"VisualCrossing with name {name} created")
-
-    @override
-    def on_connect(self, client: object, userdata: Any, flags: int, rc: int) -> None:
-        super().on_connect(client, userdata, flags, rc)
-        if rc == 0:
-            self.subscribe(self.forecast_topic)
-            self.debug(f"VisualCrossing subscribed to topic {self.forecast_topic}")
-
-    @override
-    def on_message(self, client: object, userdata: Any, msg: MqttMsg) -> None:
-        if msg.topic == self.forecast_topic:
-            em = json.loads(msg.payload.decode())
-            self.on_forecast(em)
-        else:
-            super().on_message(client, userdata, msg)
-
-    def on_forecast(self, em: dict) -> None:
-        """Handle weather forecast data.
-
-        Args:
-            em (dict): forecast
-        """
-        # self.debug(f"VisualCrossing: got mqtt message {em}")
-
-    @override
-    def run(self) -> None:
-        # create, initialize and start the asynchronous thread for acquiring forecast
-
-        self.worker = cast(
-            VisualCrossingThread, self.instantiate(VisualCrossing.workerThreadId)
-        )
-        self.worker.init(
-            self.forecast_topic,
-            self.base_url,
-            self.update_interval,
-            self.api_key,
-            self.location,
-        )
-        self.debug(
-            f"VisualCrossing run: {self.base_url}, {self.update_interval}s, location is {self.location}"
-        )
-        super().run()
-
-    @override
-    def to_dict(self) -> dict:
-        data = super().to_dict()
-        data["_visualcrossing"] = {
-            "topic": self.forecast_topic,
-            "url": self.base_url,
-            "api_key": self.api_key,
-            "interval": self.update_interval,
-        }
-        return data
-
-    @override
-    def from_dict(self, data) -> None:
-        super().from_dict(data)
-        if "_visualcrossing" in data:
-            for key, value in data["_visualcrossing"].items():
-                setattr(self, key, value)
+from datetime import datetime, timedelta, timezone
+import json
+from typing_extensions import override
+from typing import Any, Optional, cast
+from masterpiece.mqtt import MqttMsg, Mqtt
+from juham_core import JuhamThread, JuhamCloudThread
+
+
+class VisualCrossingThread(JuhamCloudThread):
+    """Asynchronous thread for acquiring forecast from the VisualCrossing
+    site."""
+
+    # class attributes
+    _forecast_topic: str = ""
+    _base_url: str = ""
+    _api_key: str = ""
+    _location: str = ""
+    _interval: float = 12 * 3600
+
+    def __init__(self, client: Optional[Mqtt] = None):
+        """Construct with the given mqtt client. Acquires data from the visual
+        crossing web service and publishes the forecast data to
+        forecast_topic.
+
+        Args:
+            client (object, optional): MQTT client. Defaults to None.
+        """
+        super().__init__(client)
+        self.mqtt_client: Optional[Mqtt] = client
+
+    @override
+    def update_interval(self) -> float:
+        return self._interval
+
+    @override
+    def make_weburl(self) -> str:
+        if not self._api_key:
+            self.error("Uninitialized api_key {self.get_class_id()}: {self._api_key}")
+            return ""
+        else:
+            now = datetime.now()
+            end = now + timedelta(days=1)
+            start = now.strftime("%Y-%m-%d")
+            stop = end.strftime("%Y-%m-%d")
+            url = f"{self._base_url}{self._location}/{start}/{stop}?unitGroup=metric&contentType=json&include=hours&key={self._api_key}"
+            # self.debug(url)
+            return url
+
+    def init(
+        self, topic: str, base_url: str, interval: float, api_key: str, location: str
+    ) -> None:
+        """Initialize the  data acquisition thread
+
+        Args:
+            topic (str): mqtt topic to publish the acquired data
+            base_url (str): url of the web service
+            interval (float): update interval in seconds
+            api_key (str): api_key, as required by the web service
+            location (str): geographic location
+        """
+        self._forecast_topic = topic
+        self._base_url = base_url
+        self._interval = interval
+        self._api_key = api_key
+        self._location = location
+
+    @override
+    def process_data(self, data: Any) -> None:
+        self.info("VisualCrossing process_data()")
+        data = data.json()
+        forecast = []
+        self.info(f"VisualCrossing {data}")
+        for day in data["days"]:
+            for hour in day["hours"]:
+                ts = int(hour["datetimeEpoch"])
+                forecast.append(
+                    {
+                        "id": "visualcrossing",
+                        "ts": ts,
+                        "hour": datetime.fromtimestamp(ts, tz=timezone.utc).strftime(
+                            "%H"
+                        ),
+                        "day": datetime.fromtimestamp(ts, tz=timezone.utc).strftime(
+                            "%Y%m%d%H"
+                        ),
+                        "uvindex": hour["uvindex"],
+                        "solarradiation": hour["solarradiation"],
+                        "solarenergy": hour["solarenergy"],
+                        "cloudcover": hour["cloudcover"],
+                        "snow": hour["snow"],
+                        "snowdepth": hour["snowdepth"],
+                        "pressure": hour["pressure"],
+                        "temp": hour["temp"],
+                        "humidity": hour["humidity"],
+                        "windspeed": hour["windspeed"],
+                        "winddir": hour["winddir"],
+                        "dew": hour["dew"],
+                    }
+                )
+        msg = json.dumps(forecast)
+        self.publish(self._forecast_topic, msg, qos=1, retain=True)
+        self.info(f"VisualCrossing forecast published to {self._forecast_topic}")
+
+
+class VisualCrossing(JuhamThread):
+    """Constructs a data acquisition object for reading weather
+    forecasts from the VisualCrossing web service. Subscribes to the
+    forecast topic and writes hourly data such as solar energy, temperature,
+    and other attributes relevant to home automation into a time series
+    database.
+
+    Spawns an asynchronous thread to run queries at the specified
+    update_interval.
+    """
+
+    workerThreadId: str = VisualCrossingThread.get_class_id()
+    base_url: str = (
+        "https://weather.visualcrossing.com/VisualCrossingWebServices/rest/services/timeline/"
+    )
+    update_interval: float = 12 * 3600
+    api_key: str = "SE9W7EHP775N7NDNW8ANM2MZN"
+    location: str = "lahti,finland"
+
+    def __init__(self, name="visualcrossing") -> None:
+        """Constructs VisualCrossing automation object for acquiring and publishing
+        forecast data.
+
+        Args:
+            name (str, optional): name of the object. Defaults to "visualcrossing".
+        """
+        super().__init__(name)
+        self.worker: Optional[VisualCrossingThread] = None
+        self.forecast_topic: str = self.make_topic_name("forecast")
+        self.debug(f"VisualCrossing with name {name} created")
+
+    @override
+    def on_connect(self, client: object, userdata: Any, flags: int, rc: int) -> None:
+        super().on_connect(client, userdata, flags, rc)
+        if rc == 0:
+            self.subscribe(self.forecast_topic)
+            self.debug(f"VisualCrossing subscribed to topic {self.forecast_topic}")
+
+    @override
+    def on_message(self, client: object, userdata: Any, msg: MqttMsg) -> None:
+        if msg.topic == self.forecast_topic:
+            em = json.loads(msg.payload.decode())
+            self.on_forecast(em)
+        else:
+            super().on_message(client, userdata, msg)
+
+    def on_forecast(self, em: dict) -> None:
+        """Handle weather forecast data.
+
+        Args:
+            em (dict): forecast
+        """
+        # self.debug(f"VisualCrossing: got mqtt message {em}")
+
+    @override
+    def run(self) -> None:
+        # create, initialize and start the asynchronous thread for acquiring forecast
+
+        self.worker = cast(
+            VisualCrossingThread, self.instantiate(VisualCrossing.workerThreadId)
+        )
+        self.worker.init(
+            self.forecast_topic,
+            self.base_url,
+            self.update_interval,
+            self.api_key,
+            self.location,
+        )
+        self.debug(
+            f"VisualCrossing run: {self.base_url}, {self.update_interval}s, location is {self.location}"
+        )
+        super().run()
+
+    @override
+    def to_dict(self) -> dict:
+        data = super().to_dict()
+        data["_visualcrossing"] = {
+            "topic": self.forecast_topic,
+            "url": self.base_url,
+            "api_key": self.api_key,
+            "interval": self.update_interval,
+        }
+        return data
+
+    @override
+    def from_dict(self, data) -> None:
+        super().from_dict(data)
+        if "_visualcrossing" in data:
+            for key, value in data["_visualcrossing"].items():
+                setattr(self, key, value)

juham_visualcrossing-0.1.8/juham_visualcrossing/visualcrossing_plugin.py

@@ -0,0 +1,18 @@
+from ast import Str
+from typing_extensions import override
+from masterpiece import Plugin, Composite
+from .visualcrossing import VisualCrossing
+
+
+class VisualCrossingPlugin(Plugin):
+    """Plugin class, for installing a visualcrossing specific features into the host application."""
+
+    def __init__(self, name: str = "visual_crossing") -> None:
+        """Create visualcrossing weather service."""
+        super().__init__(name)
+
+    @override
+    def install(self, app: Composite) -> None:
+        # Create and insert a VisualCrossing classes into the host application.
+        obj = VisualCrossing()
+        app.add(obj)

{juham_visualcrossing-0.1.2 → juham_visualcrossing-0.1.8}/juham_visualcrossing.egg-info/PKG-INFO

@@ -1,88 +1,87 @@
-Metadata-Version: 2.1
-Name: juham_visualcrossing
-Version: 0.1.2
-Summary: A Weather forecast  plugin extending `Juham` applications
-Author-email: J Meskanen <juham.api@gmail.com>
-Maintainer-email: "J. Meskanen" <juham.api@gmail.com>
-License: MIT License
-        ===========
-        
-        Copyright (c) 2024, Juha Meskanen
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy
-        of this software and associated documentation files (the "Software"), to deal
-        in the Software without restriction, including without limitation the rights
-        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-        copies of the Software, and to permit persons to whom the Software is
-        furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all
-        copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-        
-        
-Project-URL: Homepage, https://meskanen.com
-Project-URL: Bug Reports, https://meskanen.com
-Project-URL: Funding, https://meskanen.com
-Project-URL: Say Thanks!, http://meskanen.com
-Project-URL: Source, https://meskanen.com
-Keywords: object-oriented,plugin,framework
-Classifier: Development Status :: 2 - Pre-Alpha
-Classifier: Intended Audience :: Developers
-Classifier: Topic :: Software Development
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3.8
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-Requires-Dist: juham>=0.1.3
-Requires-Dist: pytz>=2024.1
-Requires-Dist: importlib-metadata
-Provides-Extra: dev
-Requires-Dist: check-manifest; extra == "dev"
-
-juham_visualcrossing
-====================
-
-`juham_visualcrossing` plugs VisualCrossing weather forecast service to Juham - Juha's Ultimate
-Home Automation Masterpiece application.
-
-
-
-Features
---------
-
-The main purpose is to acquire solar energy forecast, for optimizing energy management in
-homes with solar panels. 
-
-
-Installation
-------------
-
-The installation is two stage process
-
-1. To install:
-
-.. code-block:: python
-
-    pip install juham_visualcrossing
-
-
-2. Configure
-
-   VisualCrossing requires you to register and obtain web key, through which you can
-   access their forecast services. So sign in to visualcrossing.com to obtain the key,
-   and then add the web key to the '~/.[app]/config/VisualCrossing.json' configuration
-   file.
-
-
-
-License
--------
-
-This project is licensed under the MIT License - see the `LICENSE` file for details.
+Metadata-Version: 2.2
+Name: juham-visualcrossing
+Version: 0.1.8
+Summary: A Weather forecast  plugin extending `Juham` applications
+Author-email: J Meskanen <juham.api@gmail.com>
+Maintainer-email: "J. Meskanen" <juham.api@gmail.com>
+License: MIT License
+        ===========
+        
+        Copyright (c) 2024, Juha Meskanen
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        
+        
+Project-URL: Homepage, https://gitlab.com/juham/juham/juham-visualcrossing
+Project-URL: Bug Reports, https://gitlab.com/juham/juham/juham-visualcrossing
+Project-URL: Funding, https://meskanen.com
+Project-URL: Say Thanks!, http://meskanen.com
+Project-URL: Source, https://gitlab.com/juham/juham/juham-visualcrossing
+Keywords: object-oriented,plugin,framework
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.8
+Requires-Python: >=3.8
+Description-Content-Type: text/x-rst
+License-File: LICENSE.rst
+Requires-Dist: juham-core>=0.1.1
+Requires-Dist: pytz>=2024.1
+Provides-Extra: dev
+Requires-Dist: check-manifest; extra == "dev"
+
+VisualCrossing forecast plugin for Juham™
+=========================================
+
+Description
+-----------
+
+Adds forecast support to Juham™ home automation.
+
+.. image:: _static/images/visualcrossing.png
+   :alt: Solar and temperature forecasts
+   :width: 640px
+   :align: center  
+
+
+Project Status
+--------------
+
+**Current State**: **Alpha (Status 3)**  
+
+Please check out the `CHANGELOG <CHANGELOG.rst>`_ file for changes in this release.
+
+
+
+Getting Started
+---------------
+
+### Installation
+
+1. Install
+
+   .. code-block:: bash
+
+      pip install juham_visualcrossing
+
+
+2. Configure
+
+   - ``VisualCrossing.json``: Add your Visual Crossing API key for weather forecasts.
+

{juham_visualcrossing-0.1.2 → juham_visualcrossing-0.1.8}/juham_visualcrossing.egg-info/SOURCES.txt

@@ -1,15 +1,11 @@
+LICENSE.rst
 MANIFEST.in
 README.rst
 pyproject.toml
-docs/source/LICENSE.rst
-docs/source/README.rst
-docs/source/CHANGELOG.rst
-docs/source/CONTRIBUTING.rst
-docs/source/LICENSE.rst
-docs/source/README.rst
 juham_visualcrossing/__init__.py
 juham_visualcrossing/py.typed
 juham_visualcrossing/visualcrossing.py
+juham_visualcrossing/visualcrossing_plugin.py
 juham_visualcrossing.egg-info/PKG-INFO
 juham_visualcrossing.egg-info/SOURCES.txt
 juham_visualcrossing.egg-info/dependency_links.txt
@@ -17,6 +13,4 @@ juham_visualcrossing.egg-info/entry_points.txt
 juham_visualcrossing.egg-info/requires.txt
 juham_visualcrossing.egg-info/top_level.txt
 tests/__init__.py
-tests/test_visualcrossing.py
-tests/__pycache__/__init__.cpython-312.pyc
-tests/__pycache__/test_visualcrossing.cpython-312.pyc
+tests/test_visualcrossing.py

juham_visualcrossing-0.1.8/juham_visualcrossing.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[juham.plugins]
+visualcrossing_plugin = juham_visualcrossing:VisualCrossingPlugin

{juham_visualcrossing-0.1.2 → juham_visualcrossing-0.1.8}/juham_visualcrossing.egg-info/requires.txt

@@ -1,6 +1,5 @@
-juham>=0.1.3
+juham-core>=0.1.1
 pytz>=2024.1
-importlib-metadata
 
 [dev]
 check-manifest

{juham_visualcrossing-0.1.2 → juham_visualcrossing-0.1.8}/pyproject.toml

@@ -1,57 +1,58 @@
-
-[build-system]
-requires = ["setuptools"]
-build-backend = "setuptools.build_meta"
-
-
-[project]
-name = "juham_visualcrossing"
-version = "0.1.2"
-description = "A Weather forecast  plugin extending `Juham` applications"
-readme = {file = "docs/source/README.rst", content-type = "text/markdown"}
-requires-python = ">=3.8"
-license = {file = "docs/source/LICENSE.rst", content-type = "text/markdown"}
-keywords = ["object-oriented", "plugin", "framework"]
-authors = [
-  {name = "J Meskanen", email = "juham.api@gmail.com" }
-]
-maintainers = [
-  {name = "J. Meskanen", email = "juham.api@gmail.com" }
-]
-
-classifiers = [
-  "Development Status :: 2 - Pre-Alpha",
-  "Intended Audience :: Developers",
-  "Topic :: Software Development",
-  "License :: OSI Approved :: MIT License",
-  "Programming Language :: Python :: 3.8",
-]
-
-dependencies = [
-  "juham >= 0.1.3",
-  "pytz >= 2024.1",
-  "importlib-metadata"
-]
-
-
-[project.optional-dependencies]
-dev = ["check-manifest"]
-
-
-[project.entry-points."juham.plugins"]
-visualcrossing_plugin = "juham_visualcrossing:VisualCrossing"
-
-
-
-[project.urls]
-"Homepage" = "https://meskanen.com"
-"Bug Reports" = "https://meskanen.com"
-"Funding" = "https://meskanen.com"
-"Say Thanks!" = "http://meskanen.com"
-"Source" = "https://meskanen.com"
-
-
-
-[tool.mypy]
-files = ["juham_visualcrossing"]
-ignore_missing_imports = true
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+
+[tool.setuptools]
+include-package-data = true
+packages = ["juham_visualcrossing"]
+
+[project]
+name = "juham-visualcrossing"
+version = "0.1.8"
+requires-python = ">=3.8"
+description = "A Weather forecast  plugin extending `Juham` applications"
+readme = {file = "README.rst", content-type = "text/x-rst"}
+license = {file = "LICENSE.rst", content-type = "text/x-rst"}
+keywords = ["object-oriented", "plugin", "framework"]
+authors = [
+  {name = "J Meskanen", email = "juham.api@gmail.com" }
+]
+maintainers = [
+  {name = "J. Meskanen", email = "juham.api@gmail.com" }
+]
+
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Developers",
+  "Topic :: Software Development",
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python :: 3.8",
+]
+
+dependencies = [
+  "juham-core >= 0.1.1",
+  "pytz >= 2024.1",
+]
+
+
+[project.optional-dependencies]
+dev = ["check-manifest"]
+
+
+[project.entry-points."juham.plugins"]
+visualcrossing_plugin = "juham_visualcrossing:VisualCrossingPlugin"
+
+
+[project.urls]
+"Homepage" = "https://gitlab.com/juham/juham/juham-visualcrossing"
+"Bug Reports" = "https://gitlab.com/juham/juham/juham-visualcrossing"
+"Funding" = "https://meskanen.com"
+"Say Thanks!" = "http://meskanen.com"
+"Source" = "https://gitlab.com/juham/juham/juham-visualcrossing"
+
+
+[tool.mypy]
+files = ["juham_visualcrossing"]
+ignore_missing_imports = true

{juham_visualcrossing-0.1.2 → juham_visualcrossing-0.1.8}/setup.cfg

@@ -1,4 +1,4 @@
-[egg_info]
-tag_build = 
-tag_date = 0
-
+[egg_info]
+tag_build = 
+tag_date = 0
+

{juham_visualcrossing-0.1.2 → juham_visualcrossing-0.1.8}/tests/test_visualcrossing.py

@@ -1,16 +1,16 @@
-import unittest
-
-from juham_visualcrossing.visualcrossing import VisualCrossing
-
-
-class TestVisualCrossing(unittest.TestCase):
-    """Unit tests for `VisualCrossing` weather forecast masterpiece."""
-
-    def test_get_classid(self):
-        """Assert that the meta-class driven class initialization works."""
-        classid = VisualCrossing.get_class_id()
-        self.assertEqual("VisualCrossing", classid)
-
-
-if __name__ == "__main__":
-    unittest.main()
+import unittest
+
+from juham_visualcrossing.visualcrossing import VisualCrossing
+
+
+class TestVisualCrossing(unittest.TestCase):
+    """Unit tests for `VisualCrossing` weather forecast masterpiece."""
+
+    def test_get_classid(self):
+        """Assert that the meta-class driven class initialization works."""
+        classid = VisualCrossing.get_class_id()
+        self.assertEqual("VisualCrossing", classid)
+
+
+if __name__ == "__main__":
+    unittest.main()

juham_visualcrossing-0.1.2/docs/source/CHANGELOG.rst

@@ -1,8 +0,0 @@
-Changelog
-=========
-
-[0.0.1] - August 4, 2024
-------------------------
-
-### Initial release
-

juham_visualcrossing-0.1.2/docs/source/CONTRIBUTING.rst

@@ -1,56 +0,0 @@
-Contributing
-============
-
-
-Thank You!
-----------
-
-Thank you in advance for your forthcoming contributions, whether they are bug fixes,
-documentation improvements, entirely new features, or simply feedback. Your efforts
-will be highly appreciated and will help turn this project from its current mission
-state into an actual masterpiece.
-
-
-Design Patterns
----------------
-
-Please read the developer documentation and understand the few design patterns before contributing.
-This will help ensure that your contributions align with the project's design and goals.
-.. todo:: (okay, the documentation is currently lacking many essential chapters, add.)
-
-
-Code Formatting
----------------
-
-To help maintain consistent code formatting across different developers, we use 'black' python formatter, by Microsoft.
-
-Strange, the formatter doesn't seem to format that much, it doesn't organize imports,
-doesn't adjust docstring lenghts
-.. todo:: most likely I don't know how to use it properly, read the docs.
-
-
-Building and Packaging
-----------------------
-
-Despite my attempts to fall in love with Eclipse, VSCode and other IDEs, I still find Makefile and Emacs the best
-tools for many of my workflows.
-So there is a Makefile in the root folder. For those old dogs who are like me
-::
-
-    make help
-
-To create python package out of the 'pyproj.toml':
-::
-
-    make build
-
-To install using 'venv':
-::
-
-    make install
-
-
-More Stuff
-----------
-.. todo:: add more stuff, later.
-

juham_visualcrossing-0.1.2/docs/source/README.rst

@@ -1,40 +0,0 @@
-juham_visualcrossing
-====================
-
-`juham_visualcrossing` plugs VisualCrossing weather forecast service to Juham - Juha's Ultimate
-Home Automation Masterpiece application.
-
-
-
-Features
---------
-
-The main purpose is to acquire solar energy forecast, for optimizing energy management in
-homes with solar panels. 
-
-
-Installation
-------------
-
-The installation is two stage process
-
-1. To install:
-
-.. code-block:: python
-
-    pip install juham_visualcrossing
-
-
-2. Configure
-
-   VisualCrossing requires you to register and obtain web key, through which you can
-   access their forecast services. So sign in to visualcrossing.com to obtain the key,
-   and then add the web key to the '~/.[app]/config/VisualCrossing.json' configuration
-   file.
-
-
-
-License
--------
-
-This project is licensed under the MIT License - see the `LICENSE` file for details.

juham_visualcrossing-0.1.2/juham_visualcrossing/__init__.py

@@ -1,13 +0,0 @@
-"""
-Description
-===========
-
-VisualCrossing weather forecast.
-
-"""
-
-from .visualcrossing import VisualCrossing
-
-__all__ = [
-    "VisualCrossing",
-]

juham_visualcrossing-0.1.2/juham_visualcrossing.egg-info/entry_points.txt

@@ -1,2 +0,0 @@
-[juham.plugins]
-visualcrossing_plugin = juham_visualcrossing:VisualCrossing