juham-watermeter 0.0.4__tar.gz → 0.0.5__tar.gz

{juham_watermeter-0.0.4 → juham_watermeter-0.0.5}/CHANGELOG.rst

@@ -1,6 +1,12 @@
 Changelog
 =========
 
+[0.0.3] - Februrary 23, 2025
+----------------------------
+
+- Debug messages removed.
+
+
 [0.0.2] - January 11, 2025
 --------------------------
 

{juham_watermeter-0.0.4 → juham_watermeter-0.0.5}/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_watermeter-0.0.4 → juham_watermeter-0.0.5}/MANIFEST.in

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

{juham_watermeter-0.0.4/juham_watermeter.egg-info → juham_watermeter-0.0.5}/PKG-INFO

@@ -1,27 +1,27 @@
-Metadata-Version: 2.2
-Name: juham-watermeter
-Version: 0.0.4
-Summary: Built-in Test plugin
-Author-email: J Meskanen <juham.api@gmail.com>
-Maintainer-email: "J. Meskanen" <juham.api@gmail.com>
-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,watermeter,home automation
-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
-License-File: LICENSE.rst
-Requires-Dist: juham-automation>=0.0.2
-Requires-Dist: opencv-python-headless>=4.10.0
-Requires-Dist: numpy
-Requires-Dist: pytesseract>=0.3.13
-Requires-Dist: Pillow>=10.4.0
-Provides-Extra: dev
-Requires-Dist: check-manifest; extra == "dev"
+Metadata-Version: 2.2
+Name: juham-watermeter
+Version: 0.0.5
+Summary: Built-in Test plugin
+Author-email: J Meskanen <juham.api@gmail.com>
+Maintainer-email: "J. Meskanen" <juham.api@gmail.com>
+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,watermeter,home automation
+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
+License-File: LICENSE.rst
+Requires-Dist: juham-automation>=0.0.2
+Requires-Dist: opencv-python-headless>=4.10.0
+Requires-Dist: numpy
+Requires-Dist: pytesseract>=0.3.13
+Requires-Dist: Pillow>=10.4.0
+Provides-Extra: dev
+Requires-Dist: check-manifest; extra == "dev"

{juham_watermeter-0.0.4 → juham_watermeter-0.0.5}/README.rst

@@ -1,54 +1,79 @@
-Watermeter plugin for Juham™
-=============================
-
-Description
------------
-
-A web camera and AI-based water meter solution for Juham™ home automation.
-
-This package includes two different water meter implementations:
-
-* Tesseract OCR and OpenCV solution for reading and interpreting water meter digits.
-  This class requires further work to be truly useful. My Raspberry Pi didn't have enough disk
-  space, so I decided to set this aside for now.
-
-* A simple class that compares subsequent images to measure differences. The greater the difference between images,
-  the more the arrows and digits on the water meter have changed, indicating water consumption.
-  This solution also uploads the images to a specified FTP site when water consumption is detected,
-  allowing homeowners to inspect the water meter visually. While this solution doesn’t provide exact water
-  consumption readings, it is highly reliable for detecting leaks. Just ensure that spiders or other potentially moving
-  objects don't obstruct the camera's view of the water meter.  
-  
-
-.. image:: _static/images/watermeter_diff.png
-   :alt: Web camera based water meter leak detector based on comparison of subsequent images
-   :width: 640px
-   :align: center  
-
-
-Getting Started
----------------
-
-### Installation
-
-1. Prerequisities
-
-In order to use the first solution you need Tesseract OCR to read the digits. To install Tesseract:
-
-.. code-block:: bash
-
-      sudo apt install tesseract-ocr
-
-If you are on Windows, visit the Tesseract GitHub repository, or Download a precompiled Windows binary from UB Mannheim.
-
-2. Install 
-
-   .. code-block:: bash
-
-      pip install juham_watermeter
-
-
-2. Configure
-
-To adjust update interval and other attributes edit `WaterMeter.json` configuration file.
-
+Watermeter plugin for Juham™
+=============================
+
+Description
+-----------
+
+A web camera and AI-based water meter solution for Juham™ home automation.
+
+This package includes two different water meter implementations:
+
+* Tesseract OCR and OpenCV solution for reading and interpreting water meter digits.
+  This class requires further work to be truly useful. My Raspberry Pi didn't have enough disk
+  space, so I decided to set this aside for now.
+
+* A simple class that compares subsequent images to measure differences. The greater the difference between images,
+  the more the arrows and digits on the water meter have changed, indicating water consumption.
+  This solution also uploads the images to a specified FTP site when water consumption is detected,
+  allowing homeowners to inspect the water meter visually. While this solution doesn’t provide exact water
+  consumption readings, it is highly reliable for detecting leaks. Just ensure that spiders or other potentially moving
+  objects don't obstruct the camera's view of the water meter.  
+  
+
+.. image:: _static/images/watermeter_diff.png
+   :alt: Web camera based water meter leak detector based on comparison of subsequent images
+   :width: 640px
+   :align: center  
+
+
+Getting Started
+---------------
+
+### Note about Python - a Professional Ecosystem
+
+I'm affraid I have wasted more time solving all sorts of build, documentation, testing, and god-knows-what
+issues with Python ecosystem than I’ve spent actually writing Python code. Most recently,
+I wasted an entire day trying to figure out why coverage failed with the following error:
+
+  .. code-block:: bash
+
+      'No source for code: 'juham_watermeter\config-3.py'.
+
+error, when all the other Python projects with precisely identical structures worked fine.
+The solution was to add a .coveragerc file with the following content:
+
+  .. code-block:: bash
+
+    [run]
+    omit = 
+      config.py
+      config-3.py
+
+This will of course blow up sooner or later, when some Python developer decides to rename those files.
+
+
+
+
+### Installation
+
+1. Prerequisities
+
+In order to use the first solution you need Tesseract OCR to read the digits. To install Tesseract:
+
+.. code-block:: bash
+
+      sudo apt install tesseract-ocr
+
+If you are on Windows, visit the Tesseract GitHub repository, or Download a precompiled Windows binary from UB Mannheim.
+
+2. Install 
+
+   .. code-block:: bash
+
+      pip install juham_watermeter
+
+
+2. Configure
+
+To adjust update interval and other attributes edit `WaterMeter.json` configuration file.
+

juham_watermeter-0.0.5/docs/build/html/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: c5f6fb335ec5ac3ac8ac7f5ce8d6088b
+tags: 645f666f9bcd5a90fca523b33c5a78b7

juham_watermeter-0.0.5/docs/build/html/_sources/index.rst.txt

@@ -0,0 +1,47 @@
+Watermeter plugin for Juham
+===========================
+
+.. image:: _static/juham.png
+    :alt: Juham - Juha's Ultimate Home Automation Masterpiece
+    :width: 400px
+    :height: 300px
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   juham_watermeter/index
+
+.. include:: ../../README.rst
+
+.. include:: ../../LICENSE.rst
+
+.. include:: ../../CHANGELOG.rst
+
+
+
+Classes
+-------
+
+.. inheritance-diagram::
+   juham_watermeter.WaterMeterImgDiff
+   juham_watermeter.WaterMeterOCR
+   juham_watermeter.WebCamera
+   juham_watermeter.LeakDetector
+   juham_core.Juham
+   masterpiece.composite.Composite
+   masterpiece.application.Application
+   masterpiece.plugin.Plugin
+   masterpiece.plugmaster.PlugMaster
+   masterpiece.argmaestro.ArgMaestro
+   masterpiece.log.Log
+   :parts: 1
+
+
+
+Index
+=====
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

juham_watermeter-0.0.5/docs/build/html/_sources/juham_watermeter/index.rst.txt

@@ -0,0 +1,11 @@
+Juham Watermeter
+================
+
+Adds watermeter capability to Juham applications
+
+.. automodule:: juham_watermeter
+   :members:
+   :inherited-members:
+   :undoc-members:
+   :show-inheritance:
+