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

juham_watermeter-0.0.6/PKG-INFO

@@ -0,0 +1,131 @@
+Metadata-Version: 2.2
+Name: juham-watermeter
+Version: 0.0.6
+Summary: Web-camera based watermeter for Juham
+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
+Project-URL: Bug Reports, https://gitlab.com/juham/juham
+Project-URL: Funding, https://meskanen.com
+Project-URL: Say Thanks!, http://meskanen.com
+Project-URL: Source, https://gitlab.com/juham/juham
+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-core>=0.1.1
+Requires-Dist: numpy
+Requires-Dist: Pillow>=10.4.0
+Requires-Dist: opencv-python-headless>=4.10.0
+Requires-Dist: pytesseract>=0.3.13
+Provides-Extra: dev
+Requires-Dist: check-manifest; extra == "dev"
+
+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:
+
+* 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.  
+  
+* 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.
+
+
+.. 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
+---------------
+
+To install:
+
+   .. code-block:: bash
+
+      pip install juham-watermeter
+
+Which installs everything needed for reading water meters with the simple image comparison based solution.
+
+
+If you want to play with the Tesseract OCR and OpenCV solution for reading and interpreting water meter digits,
+please read on.
+
+
+Installing Tesseract OCR to read the digits:
+
+.. 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.
+
+
+### Note about OpenCV and contributors
+
+The Python coverage failed with the No source for code: 'juham_watermeter\config-3.py'
+error, when all the other Python projects with precisely identical structures worked fine.
+Traced down the bug to opencv package, and added a .coveragerc file with the following content:
+
+  .. code-block:: bash
+
+    [run]
+    omit = 
+      config.py
+      config-3.py
+
+as a solution. This will of course blow up sooner or later, when some OpenCV developer decides
+to rename those files.
+

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

@@ -8,10 +8,6 @@ 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,
@@ -19,6 +15,10 @@ This package includes two different water meter implementations:
   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.  
   
+* 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.
+
 
 .. image:: _static/images/watermeter_diff.png
    :alt: Web camera based water meter leak detector based on comparison of subsequent images
@@ -29,36 +29,20 @@ This package includes two different water meter implementations:
 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
+To install:
 
-This will of course blow up sooner or later, when some Python developer decides to rename those files.
+   .. code-block:: bash
 
+      pip install juham-watermeter
 
+Which installs everything needed for reading water meters with the simple image comparison based solution.
 
 
-### Installation
+If you want to play with the Tesseract OCR and OpenCV solution for reading and interpreting water meter digits,
+please read on.
 
-1. Prerequisities
 
-In order to use the first solution you need Tesseract OCR to read the digits. To install Tesseract:
+Installing Tesseract OCR to read the digits:
 
 .. code-block:: bash
 
@@ -70,10 +54,27 @@ If you are on Windows, visit the Tesseract GitHub repository, or Download a prec
 
    .. code-block:: bash
 
-      pip install juham_watermeter
+      pip install juham-watermeter
 
 
 2. Configure
 
 To adjust update interval and other attributes edit `WaterMeter.json` configuration file.
 
+
+### Note about OpenCV and contributors
+
+The Python coverage failed with the No source for code: 'juham_watermeter\config-3.py'
+error, when all the other Python projects with precisely identical structures worked fine.
+Traced down the bug to opencv package, and added a .coveragerc file with the following content:
+
+  .. code-block:: bash
+
+    [run]
+    omit = 
+      config.py
+      config-3.py
+
+as a solution. This will of course blow up sooner or later, when some OpenCV developer decides
+to rename those files.
+

{juham_watermeter-0.0.5 → juham_watermeter-0.0.6}/juham_watermeter/__init__.py

@@ -7,14 +7,14 @@ Web-camera based watermeter classes with leak detector
 """
 
 from .webcamera import WebCamera
-from .watermeter_ocr import WaterMeterOCR
+#from .watermeter_ocr import WaterMeterOCR
 from .watermeter_imgdiff import WaterMeterImgDiff
 from .watermeter_ts import WaterMeterTs
 from .leakdetector import LeakDetector
 
 __all__ = [
     "WebCamera",
-    "WaterMeterOCR",
+#    "WaterMeterOCR",
     "WaterMeterImgDiff",
     "WaterMeterTs",
     "LeakDetector",

juham_watermeter-0.0.6/juham_watermeter.egg-info/PKG-INFO

@@ -0,0 +1,131 @@
+Metadata-Version: 2.2
+Name: juham-watermeter
+Version: 0.0.6
+Summary: Web-camera based watermeter for Juham
+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
+Project-URL: Bug Reports, https://gitlab.com/juham/juham
+Project-URL: Funding, https://meskanen.com
+Project-URL: Say Thanks!, http://meskanen.com
+Project-URL: Source, https://gitlab.com/juham/juham
+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-core>=0.1.1
+Requires-Dist: numpy
+Requires-Dist: Pillow>=10.4.0
+Requires-Dist: opencv-python-headless>=4.10.0
+Requires-Dist: pytesseract>=0.3.13
+Provides-Extra: dev
+Requires-Dist: check-manifest; extra == "dev"
+
+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:
+
+* 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.  
+  
+* 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.
+
+
+.. 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
+---------------
+
+To install:
+
+   .. code-block:: bash
+
+      pip install juham-watermeter
+
+Which installs everything needed for reading water meters with the simple image comparison based solution.
+
+
+If you want to play with the Tesseract OCR and OpenCV solution for reading and interpreting water meter digits,
+please read on.
+
+
+Installing Tesseract OCR to read the digits:
+
+.. 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.
+
+
+### Note about OpenCV and contributors
+
+The Python coverage failed with the No source for code: 'juham_watermeter\config-3.py'
+error, when all the other Python projects with precisely identical structures worked fine.
+Traced down the bug to opencv package, and added a .coveragerc file with the following content:
+
+  .. code-block:: bash
+
+    [run]
+    omit = 
+      config.py
+      config-3.py
+
+as a solution. This will of course blow up sooner or later, when some OpenCV developer decides
+to rename those files.
+

juham_watermeter-0.0.6/juham_watermeter.egg-info/SOURCES.txt

@@ -0,0 +1,20 @@
+CHANGELOG.rst
+LICENSE.rst
+MANIFEST.in
+README.rst
+pyproject.toml
+juham_watermeter/__init__.py
+juham_watermeter/leakdetector.py
+juham_watermeter/py.typed
+juham_watermeter/watermeter_imgdiff.py
+juham_watermeter/watermeter_ocr.py
+juham_watermeter/watermeter_ts.py
+juham_watermeter/webcamera.py
+juham_watermeter.egg-info/PKG-INFO
+juham_watermeter.egg-info/SOURCES.txt
+juham_watermeter.egg-info/dependency_links.txt
+juham_watermeter.egg-info/entry_points.txt
+juham_watermeter.egg-info/requires.txt
+juham_watermeter.egg-info/top_level.txt
+tests/__init__.py
+tests/test_watermeter.py

{juham_watermeter-0.0.5 → juham_watermeter-0.0.6}/juham_watermeter.egg-info/requires.txt

@@ -1,8 +1,8 @@
-juham-automation>=0.0.2
-opencv-python-headless>=4.10.0
+juham-core>=0.1.1
 numpy
-pytesseract>=0.3.13
 Pillow>=10.4.0
+opencv-python-headless>=4.10.0
+pytesseract>=0.3.13
 
 [dev]
 check-manifest

{juham_watermeter-0.0.5 → juham_watermeter-0.0.6}/pyproject.toml

@@ -3,14 +3,18 @@
 requires = ["setuptools"]
 build-backend = "setuptools.build_meta"
 
+[tool.setuptools]
+include-package-data = true
+packages = ["juham_watermeter"]
+
 
 [project]
 name = "juham-watermeter"
-version = "0.0.5"
-description = "Built-in Test plugin"
-readme = {file = "docs/source/README.rst", content-type = "text/markdown"}
+version = "0.0.6"
+description = "Web-camera based watermeter for Juham"
+readme = {file = "README.rst", content-type = "text/markdown"}
 requires-python = ">=3.8"
-license = {file = "docs/source/LICENSE.rst", content-type = "text/markdown"}
+license = {file = "LICENSE.rst", content-type = "text/markdown"}
 keywords = ["object-oriented", "plugin", "framework", "watermeter", "home automation"]
 authors = [
   {name = "J Meskanen", email = "juham.api@gmail.com" }
@@ -28,11 +32,11 @@ classifiers = [
 ]
 
 dependencies = [
-  "juham-automation >= 0.0.2",
-  "opencv-python-headless >= 4.10.0",
+  "juham-core >= 0.1.1",
   "numpy",
+  "Pillow >= 10.4.0",
+  "opencv-python-headless >= 4.10.0",
   "pytesseract >= 0.3.13",
-  "Pillow >= 10.4.0"
 ]
 
 [project.optional-dependencies]
@@ -49,11 +53,11 @@ leakdetector_plugin = "juham_watermeter:LeakDetector"
 
 
 [project.urls]
-"Homepage" = "https://meskanen.com"
-"Bug Reports" = "https://meskanen.com"
+"Homepage" = "https://gitlab.com/juham/juham"
+"Bug Reports" = "https://gitlab.com/juham/juham"
 "Funding" = "https://meskanen.com"
 "Say Thanks!" = "http://meskanen.com"
-"Source" = "https://meskanen.com"
+"Source" = "https://gitlab.com/juham/juham"
 
 
 

juham_watermeter-0.0.5/PKG-INFO

@@ -1,27 +0,0 @@
-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.5/docs/build/html/.buildinfo

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

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

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