refactored

Author: andgineer

.github/workflows/ci.yml

@@ -14,7 +14,7 @@ jobs:
 
     strategy:
       matrix:
-        python-version: [3.9, "3.10", 3.11]
+        python-version: ["3.10", 3.11, 3.12]
         platform: [ubuntu-latest, macos-latest, windows-latest]
     runs-on: ${{ matrix.platform }}
 
@@ -28,9 +28,9 @@ jobs:
       contents: write
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies

README.md

@@ -2,35 +2,17 @@
 [![Coverage](https://raw.githubusercontent.com/andgineer/ambientweather_livedata/python-coverage-comment-action-data/badge.svg)](https://htmlpreview.github.io/?https://github.com/andgineer/ambientweather_livedata/blob/python-coverage-comment-action-data/htmlcov/index.html)
 # Extract data from Ambient Weather stations
 
-Python3 library that extracts information from [Ambient Weather stations](https://www.ambientweather.com/).
+Python library that extracts information from [Ambient Weather stations](https://www.ambientweather.com/).
+
+So if you have an Ambient Weather station and you want to get the data from it, this library is for you.
 
 It collects sensor's data (temperature and humidity) from the [IPObserver](https://www.ambientweather.com/amobserverip.html) `LiveData` tab of the IPObserver web-page.
 You can get this page from the IPObserver - just open the IPObserver IP adddress in your web-brawser to see it.
 
 The library uses xpath and [lxml](http://lxml.de/).
 
-Example:
-
-        import ambientweather_livedata
-
-        inSensor, outSensor = ambientweather_livedata.get('http://10.0.0.176/LiveData.html')
-        print('Time: {}\n'.format(inSensor.time))
-        print('''Indoor\n{delimiter}\nTemperature: {temp}\nHumidity: {humidity}
-    Absolute preassure: {abs_press}\nRelative preassure: {rel_press}\nBattery status: {battery}\n'''.format(
-            delimiter='='*20,
-            temp=inSensor.temp,
-            humidity=inSensor.humidity,
-            abs_press=inSensor.abs_press,
-            rel_press=inSensor.rel_press,
-            battery=inSensor.battery
-        ))
-        print('''Outdoor\n{delimiter}\nTemperature: {temp}\nHumidity: {humidity}
-    Battery status: {battery}\n'''.format(
-            delimiter='='*20,
-            temp=inSensor.temp,
-            humidity=inSensor.humidity,
-            battery=inSensor.battery
-        ))
+[Example](src/example.py)
+
 
 ## Coverage report
 * [Codecov](https://app.codecov.io/gh/andgineer/ambientweather_livedata/tree/master/src)

activate.sh

@@ -4,7 +4,7 @@
 #
 
 VENV_FOLDER="venv"
-PYTHON="python3.11"
+PYTHON="python3.12"
 
 RED='\033[1;31m'
 GREEN='\033[1;32m'

src/ambientweather.py

@@ -1,61 +1,68 @@
 """Extract data from Ambient Weather stations."""
-from typing import List, Tuple
-
+from typing import Tuple
 from datetime import datetime
 import requests
 from lxml import html
 
-
 TITLE = "LiveData"  # HTML live data page title
 TIMEOUT = 5  # seconds
 
 
-class SensorData:
-    """Sensor data object"""
+class BaseSensorData:
+    """Base class for sensor data"""
+    def __init__(self):
+        self.time: datetime = None
+        self.temp: float = None
+        self.humidity: float = None
+        self.battery: str = None
 
-    time: datetime
-    temp: float
-    humidity: float
-    abs_press: float
-    rel_press: float
-    battery: List[str]  # ('Normal')
 
-    def parse(self, live_data_html: bytes) -> Tuple["SensorData", "SensorData"]:
-        """Extract sensor's data from html (LiveData.html from your ObserverIP).
+class IndoorSensorData(BaseSensorData):
+    """Indoor sensor data"""
+    def __init__(self):
+        super().__init__()
+        self.abs_press: float = None
+        self.rel_press: float = None
+
+
+class OutdoorSensorData(BaseSensorData):
+    """Outdoor sensor data"""
+    pass
 
-        Returns touple with (sensor1, sensor2 -> SensorData)
-        """
 
+class AmbientWeather:
+    """Class to handle Ambient Weather data retrieval and parsing"""
+
+    @staticmethod
+    def parse(live_data_html: bytes) -> Tuple[IndoorSensorData, OutdoorSensorData]:
+        """Extract sensor data from html (LiveData.html from your ObserverIP)."""
         tree = html.fromstring(live_data_html)
         title = tree.xpath("//title/text()")
         if title[0] != TITLE:
             raise ValueError(f"Wrong html page. Good one have to have title {TITLE}")
 
-        in_sensor = SensorData()
+        in_sensor = IndoorSensorData()
+        out_sensor = OutdoorSensorData()
+
         time_str = tree.xpath('//input[@name="CurrTime"]/@value')[0]
-        in_sensor.time = datetime.strptime(time_str, "%H:%M %m/%d/%Y")
+        in_sensor.time = out_sensor.time = datetime.strptime(time_str, "%H:%M %m/%d/%Y")
+
         in_sensor.temp = float(tree.xpath('//input[@name="inTemp"]/@value')[0])
         in_sensor.humidity = float(tree.xpath('//input[@name="inHumi"]/@value')[0])
         in_sensor.abs_press = float(tree.xpath('//input[@name="AbsPress"]/@value')[0])
         in_sensor.rel_press = float(tree.xpath('//input[@name="RelPress"]/@value')[0])
         in_sensor.battery = tree.xpath('//input[@name="inBattSta"]/@value')[0]
 
-        out_sensor = SensorData()
-        out_sensor.time = in_sensor.time
         out_sensor.temp = float(tree.xpath('//input[@name="outTemp"]/@value')[0])
         out_sensor.humidity = float(tree.xpath('//input[@name="outHumi"]/@value')[0])
-        out_sensor.abs_press = in_sensor.abs_press
-        out_sensor.rel_press = in_sensor.rel_press
         out_sensor.battery = tree.xpath('//input[@name="outBattSta2"]/@value')[0]
 
         return in_sensor, out_sensor
 
-    def get(self, url: str) -> Tuple["SensorData", "SensorData"]:
+    @staticmethod
+    def get(url: str) -> Tuple[IndoorSensorData, OutdoorSensorData]:
         """
         Load ObserverIP live data page from the URL and parse it
-
-        Returns touple with (sensor1, sensor2 -> SensorData)
         """
-
         page = requests.get(url, timeout=TIMEOUT).content
-        return self.parse(page)
+        return AmbientWeather.parse(page)

src/example.py

@@ -0,0 +1,26 @@
+"""Example script to demonstrate the usage of the AmbientWeather class."""
+from ambientweather import AmbientWeather
+
+
+def show_weather() -> None:
+    """Retrieve and display weather data from an Ambient Weather station."""
+    in_sensor, out_sensor = AmbientWeather.get('http://10.0.0.176/LiveData.html')
+    delimiter = '=' * 20
+
+    print(f'Time: {in_sensor.time}\n')
+
+    print(f"Indoor\n{delimiter}")
+    print(f"Temperature: {in_sensor.temp}")
+    print(f"Humidity: {in_sensor.humidity}")
+    print(f"Absolute pressure: {in_sensor.abs_press}")
+    print(f"Relative pressure: {in_sensor.rel_press}")
+    print(f"Battery status: {in_sensor.battery}\n")
+
+    print(f"Outdoor\n{delimiter}")
+    print(f"Temperature: {out_sensor.temp}")
+    print(f"Humidity: {out_sensor.humidity}")
+    print(f"Battery status: {out_sensor.battery}")
+
+
+if __name__ == '__main__':
+    show_weather()

tests/conftest.py

@@ -13,6 +13,7 @@ def _get_repo_root_dir() -> str:
 ROOT_DIR = _get_repo_root_dir()
 RESOURCES = Path(f"{ROOT_DIR}/tests/resources")
 
+
 @pytest.fixture(
     scope="function",
     params=[

tests/test_ambientweather.py

@@ -0,0 +1,16 @@
+from ambientweather import AmbientWeather
+from datetime import datetime
+
+
+def test_ambientweather_data(ambientweather_data: str):
+    in_sensor, out_sensor = AmbientWeather.parse(ambientweather_data.encode('utf-8'))
+
+    assert in_sensor.time == datetime.strptime('2017/10/06 13:55:00', '%Y/%m/%d %H:%M:%S')
+    assert in_sensor.temp == 21.9
+    assert in_sensor.humidity == 50.0
+    assert in_sensor.abs_press == 744.29
+    assert in_sensor.rel_press == 728.31
+    assert in_sensor.battery == 'Normal'
+    assert out_sensor.temp == 10.1
+    assert out_sensor.humidity == 71.0
+    assert out_sensor.battery == 'Normal'

tests/test_ambientweather_data.py

@@ -0,0 +1,40 @@
+import pytest
+from unittest.mock import patch
+import sys
+from io import StringIO
+
+from example import show_weather
+from ambientweather import AmbientWeather, IndoorSensorData, OutdoorSensorData
+
+
+def test_show_weather(ambientweather_data):
+    """Test the show_weather function from example.py."""
+    in_sensor, out_sensor = AmbientWeather.parse(ambientweather_data.encode('utf-8'))
+
+    # Mock the AmbientWeather.get method to return our parsed data
+    with patch('ambientweather.AmbientWeather.get', return_value=(in_sensor, out_sensor)):
+        # Capture stdout
+        captured_output = StringIO()
+        sys.stdout = captured_output
+
+        # Call the function
+        show_weather()
+
+        # Restore stdout
+        sys.stdout = sys.__stdout__
+
+    # Get the captured output
+    output = captured_output.getvalue()
+
+    # Assert that the output contains expected information
+    assert f"Time: {in_sensor.time}" in output
+    assert "Indoor" in output
+    assert f"Temperature: {in_sensor.temp}" in output
+    assert f"Humidity: {in_sensor.humidity}" in output
+    assert f"Absolute pressure: {in_sensor.abs_press}" in output
+    assert f"Relative pressure: {in_sensor.rel_press}" in output
+    assert f"Battery status: {in_sensor.battery}" in output
+    assert "Outdoor" in output
+    assert f"Temperature: {out_sensor.temp}" in output
+    assert f"Humidity: {out_sensor.humidity}" in output
+    assert f"Battery status: {out_sensor.battery}" in output