juham-visualcrossing 0.0.1__tar.gz

juham_visualcrossing-0.0.1/MANIFEST.in

@@ -0,0 +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 *~ \#*
+

juham_visualcrossing-0.0.1/PKG-INFO

@@ -0,0 +1,88 @@
+Metadata-Version: 2.1
+Name: juham_visualcrossing
+Version: 0.0.1
+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 :: 1 - Planning
+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.0.7
+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.

juham_visualcrossing-0.0.1/docs/source/CHANGELOG.rst

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

juham_visualcrossing-0.0.1/docs/source/CONTRIBUTING.rst

@@ -0,0 +1,56 @@
+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.0.1/docs/source/LICENSE.rst

@@ -0,0 +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
+

juham_visualcrossing-0.0.1/docs/source/README.rst

@@ -0,0 +1,40 @@
+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.0.1/juham_visualcrossing/__init__.py

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

juham_visualcrossing-0.0.1/juham_visualcrossing/visualcrossing.py

@@ -0,0 +1,180 @@
+from datetime import datetime, timedelta, timezone
+import json
+
+from typing import Any
+from juham.base import Base
+from juham.web import RCloud, RCloudThread
+
+
+class VisualCrossingThread(RCloudThread):
+    """Asynchronous thread for acquiring forecast from the VisualCrossing
+    site."""
+
+    # class attributes
+    _forecast_topic = ""
+    _base_url = ""
+    _api_key = ""
+    _location = ""
+    _interval: float = 12 * 3600
+
+    def __init__(self, client=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 = client
+
+    def update_interval(self) -> float:
+        return self._interval
+
+    # @override
+    def make_url(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):
+        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 = VisualCrossingThread.get_class_id()
+    forecast_topic = Base.mqtt_root_topic + "/forecast"
+    base_url = "https://weather.visualcrossing.com/VisualCrossingWebServices/rest/services/timeline/"
+    update_interval = 12 * 3600
+    api_key = "SE9W7EHP775N7NDNW8ANM2MZN"
+    location = "lahti,finland"
+
+    def __init__(self, name="visualcrossing"):
+        super().__init__(name)
+        self.debug(f"VisualCrossing created")
+
+    def on_connect(self, client, userdata, flags, rc):
+        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}")
+
+    def on_message(self, client, userdata, msg):
+        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):
+        # create, initialize and start the asynchronous thread for acquiring forecast
+        self.worker = Base.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(): base_url is {self.base_url}")
+        self.debug(f"VisualCrossing.run(): interval is {self.update_interval}")
+        self.debug(f"VisualCrossing.run(): api_key is {self.api_key}")
+        self.debug(f"VisualCrossing.run(): location is {self.location}")
+        super().run()
+
+    # @override
+    def to_dict(self):
+        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):
+        super().from_dict(data)
+        if "_visualcrossing" in data:
+            for key, value in data["_visualcrossing"].items():
+                setattr(self, key, value)

juham_visualcrossing-0.0.1/juham_visualcrossing.egg-info/PKG-INFO

@@ -0,0 +1,88 @@
+Metadata-Version: 2.1
+Name: juham_visualcrossing
+Version: 0.0.1
+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 :: 1 - Planning
+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.0.7
+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.

juham_visualcrossing-0.0.1/juham_visualcrossing.egg-info/SOURCES.txt

@@ -0,0 +1,20 @@
+MANIFEST.in
+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/visualcrossing.py
+juham_visualcrossing.egg-info/PKG-INFO
+juham_visualcrossing.egg-info/SOURCES.txt
+juham_visualcrossing.egg-info/dependency_links.txt
+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

juham_visualcrossing-0.0.1/juham_visualcrossing.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

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

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

juham_visualcrossing-0.0.1/juham_visualcrossing.egg-info/requires.txt

@@ -0,0 +1,6 @@
+juham>=0.0.7
+pytz>=2024.1
+importlib-metadata
+
+[dev]
+check-manifest

juham_visualcrossing-0.0.1/juham_visualcrossing.egg-info/top_level.txt

@@ -0,0 +1 @@
+juham_visualcrossing

juham_visualcrossing-0.0.1/pyproject.toml

@@ -0,0 +1,57 @@
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+
+[project]
+name = "juham_visualcrossing"
+version = "0.0.1"
+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 :: 1 - Planning",
+  "Intended Audience :: Developers",
+  "Topic :: Software Development",
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python :: 3.8",
+]
+
+dependencies = [
+  "juham >= 0.0.7",
+  "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

juham_visualcrossing-0.0.1/setup.cfg

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

juham_visualcrossing-0.0.1/tests/test_visualcrossing.py

@@ -0,0 +1,16 @@
+import unittest
+
+from juham_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()