pyopenweathermap 0.2.0__tar.gz → 0.2.2__tar.gz

{pyopenweathermap-0.2.0 → pyopenweathermap-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: pyopenweathermap
-Version: 0.2.0
+Version: 0.2.2
 Summary: lib for OpenWeatherMap for Home Assistant
 License: MIT
 Keywords: homeassistant,owm,openweathermap
@@ -11,7 +11,10 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: aiohttp (>=3.9.5,<4.0.0)
+Project-URL: Homepage, https://github.com/freekode/pyopenweathermap
+Project-URL: Repository, https://github.com/freekode/pyopenweathermap
 Description-Content-Type: text/markdown
 
 # pyopenweathermap

{pyopenweathermap-0.2.0 → pyopenweathermap-0.2.2}/pyproject.toml

@@ -1,10 +1,12 @@
 [tool.poetry]
 name = "pyopenweathermap"
-version = "0.2.0"
+version = "0.2.2"
 description = "lib for OpenWeatherMap for Home Assistant"
 authors = ["Evgeny <iam@freekode.org>"]
 license = "MIT"
 readme = "README.md"
+homepage = "https://github.com/freekode/pyopenweathermap"
+repository = "https://github.com/freekode/pyopenweathermap"
 keywords = ["homeassistant", "owm", "openweathermap"]
 packages = [
     { include = "pyopenweathermap", from = "src" },

{pyopenweathermap-0.2.0 → pyopenweathermap-0.2.2}/src/pyopenweathermap/__init__.py

@@ -6,5 +6,6 @@ from .exception import (
 from .client.owm_abstract_client import OWMClient
 from .client.owm_client_factory import create_owm_client
 from .weather import (
-    CurrentWeather, HourlyWeatherForecast, DailyWeatherForecast, WeatherReport, DailyTemperature, WeatherCondition
+    CurrentWeather, MinutelyWeatherForecast, HourlyWeatherForecast, DailyWeatherForecast, WeatherReport, DailyTemperature, WeatherCondition
 )
+from .air_pollution import CurrentAirPollution, AirPollutionReport

pyopenweathermap-0.2.2/src/pyopenweathermap/air_pollution.py

@@ -0,0 +1,21 @@
+import decimal
+from dataclasses import dataclass
+from datetime import datetime
+
+@dataclass
+class CurrentAirPollution:
+    date_time: datetime
+    aqi: int
+    co: decimal.Decimal
+    no: decimal.Decimal
+    no2: decimal.Decimal
+    o3: decimal.Decimal
+    so2: decimal.Decimal
+    pm2_5: decimal.Decimal
+    pm10: decimal.Decimal
+    nh3: decimal.Decimal
+
+@dataclass
+class AirPollutionReport:
+    current: CurrentAirPollution | None
+    hourly_forecast: list[CurrentAirPollution]

pyopenweathermap-0.2.2/src/pyopenweathermap/client/air_pollution_client.py

@@ -0,0 +1,42 @@
+from .owm_abstract_client import OWMClient
+from ..data_converter import DataConverter
+from ..exception import UnauthorizedError
+from ..weather import WeatherReport
+from ..air_pollution import AirPollutionReport
+
+CURRENT_AIR_POLLUTION_API_URL = 'https://api.openweathermap.org/data/2.5/air_pollution'
+FORECAST_API_URL = 'https://api.openweathermap.org/data/2.5/air_pollution/forecast'
+
+class OWMAirPollutionClient(OWMClient):
+    def __init__(self, api_key):
+        super().__init__()
+        self.api_key = api_key
+
+    async def get_air_pollution(self, lat, lon) -> AirPollutionReport:
+        url = self._get_url(lat, lon, 'current')
+        current_json = await self.http_client.request(url)
+        current = DataConverter.air_pollution_current(current_json)
+
+        url = self._get_url(lat, lon, 'forecast')
+        forecast_json = await self.http_client.request(url)
+        hourly = [DataConverter.air_pollution_hourly(item) for item in forecast_json['list']]
+
+        return AirPollutionReport(current, hourly)
+
+    async def get_weather(self, lat, lon) -> WeatherReport:
+        raise NotImplementedError('Air Pollution client does not have get_weather()')
+
+    async def validate_key(self) -> bool:
+        url = self._get_url(50.06, 14.44, 'api_type')
+        try:
+            await self.http_client.request(url)
+            return True
+        except UnauthorizedError:
+            return False
+
+    def _get_url(self, lat, lon, api_type):
+        url = CURRENT_AIR_POLLUTION_API_URL if api_type == 'current' else FORECAST_API_URL
+        return (f"{url}?"
+                f"lat={lat}&"
+                f"lon={lon}&"
+                f"appid={self.api_key}")

{pyopenweathermap-0.2.0 → pyopenweathermap-0.2.2}/src/pyopenweathermap/client/free_client.py

@@ -2,6 +2,7 @@ from .owm_abstract_client import OWMClient
 from ..data_converter import DataConverter
 from ..exception import UnauthorizedError
 from ..weather import WeatherReport
+from ..air_pollution import AirPollutionReport
 
 CURRENT_WEATHER_API_URL = 'https://api.openweathermap.org/data/2.5/weather'
 FORECAST_API_URL = 'https://api.openweathermap.org/data/2.5/forecast'
@@ -26,6 +27,9 @@ class OWMFreeClient(OWMClient):
             hourly = [DataConverter.free_to_hourly_weather_forecast(item) for item in json_response['list']]
         return WeatherReport(current,[], hourly, [])
 
+    async def get_air_pollution(self, lat, lon) -> AirPollutionReport:
+        raise NotImplementedError('free client does not have get_air_pollution()')
+
     async def validate_key(self) -> bool:
         url = self._get_url(50.06, 14.44)
         try:

{pyopenweathermap-0.2.0 → pyopenweathermap-0.2.2}/src/pyopenweathermap/client/onecall_client.py

@@ -2,9 +2,9 @@ from .owm_abstract_client import OWMClient
 from ..data_converter import DataConverter
 from ..exception import UnauthorizedError
 from ..weather import WeatherReport
+from ..air_pollution import AirPollutionReport
 
-V30_API_URL = 'https://api.openweathermap.org/data/3.0/onecall'
-V25_API_URL = 'https://api.openweathermap.org/data/2.5/onecall'
+API_URL = 'https://api.openweathermap.org/data/3.0/onecall'
 
 
 class OWMOneCallClient(OWMClient):
@@ -19,7 +19,7 @@ class OWMOneCallClient(OWMClient):
         url = self._get_url(lat, lon)
         json_response = await self.http_client.request(url)
 
-        current, hourly, daily = None, [], []
+        current, minutely, hourly, daily = None, [], [], []
         if json_response.get('current') is not None:
             current = DataConverter.onecall_to_current_weather(json_response['current'])
         if json_response.get('minutely') is not None:
@@ -31,6 +31,9 @@ class OWMOneCallClient(OWMClient):
 
         return WeatherReport(current, minutely, hourly, daily)
 
+    async def get_air_pollution(self, lat, lon) -> AirPollutionReport:
+        raise NotImplementedError('free client does not have get_air_pollution()')
+
     async def validate_key(self) -> bool:
         url = (f"{self._get_url(50.06, 14.44)}"
               f"&exclude=current,minutely,hourly,daily,alerts)")
@@ -41,8 +44,7 @@ class OWMOneCallClient(OWMClient):
             return False
 
     def _get_url(self, lat, lon):
-        url = V30_API_URL if self.api_version == 'v3.0' else V25_API_URL 
-        return (f"{url}?"
+        return (f"{API_URL}?"
                 f"lat={lat}&"
                 f"lon={lon}&"
                 f"appid={self.api_key}&"

{pyopenweathermap-0.2.0 → pyopenweathermap-0.2.2}/src/pyopenweathermap/client/owm_abstract_client.py

@@ -1,5 +1,6 @@
 from abc import ABC, abstractmethod
 from ..weather import WeatherReport
+from ..air_pollution import AirPollutionReport
 from ..http_client import HttpClient
 
 
@@ -13,6 +14,10 @@ class OWMClient(ABC):
     async def get_weather(self, lat, lon) -> WeatherReport:
         pass
 
+    @abstractmethod
+    async def get_air_pollution(self, lat, lon) -> AirPollutionReport:
+        pass
+
     @abstractmethod
     async def validate_key(self) -> bool:
         pass

{pyopenweathermap-0.2.0 → pyopenweathermap-0.2.2}/src/pyopenweathermap/client/owm_client_factory.py

@@ -2,15 +2,18 @@ import logging
 
 from .free_client import OWMFreeClient
 from .onecall_client import OWMOneCallClient
+from .air_pollution_client import OWMAirPollutionClient
 
 
 def create_owm_client(api_key, api_type, units="metric", lang='en'):
     logger = logging.getLogger(__name__)
     
     logger.info('Initializing OWMClient with api type: ' + str(api_type))
-    if api_type == 'v3.0' or api_type == 'v2.5':
+    if api_type == 'v3.0':
         return OWMOneCallClient(api_key, api_type, units, lang)
     if api_type == 'current' or api_type == 'forecast':
         return OWMFreeClient(api_key, api_type, units, lang)
+    if api_type == 'air_pollution':
+        return OWMAirPollutionClient(api_key)
     else:
         raise Exception('Unsupported API type ' + str(api_type))

{pyopenweathermap-0.2.0 → pyopenweathermap-0.2.2}/src/pyopenweathermap/data_converter.py

@@ -1,6 +1,7 @@
 from datetime import UTC, datetime
 
 from .weather import CurrentWeather, WeatherCondition, MinutelyWeatherForecast, HourlyWeatherForecast, DailyWeatherForecast, DailyTemperature
+from .air_pollution import CurrentAirPollution
 
 
 class DataConverter:
@@ -72,7 +73,40 @@ class DataConverter:
             snow=json.get('snow', 0),
             condition=DataConverter._to_weather_condition(json['weather'][0]),
         )
-        
+
+    @staticmethod
+    def air_pollution_current(json):
+        data = json['list'][0]
+        components = data['components']
+        return CurrentAirPollution(
+            date_time=datetime.fromtimestamp(data["dt"], tz=UTC),
+            aqi=data['main']['aqi'],
+            co=components['co'],
+            no=components['no'],
+            no2=components['no2'],
+            o3=components['o3'],
+            so2=components['so2'],
+            pm2_5=components['pm2_5'],
+            pm10=components['pm10'],
+            nh3=components['nh3'],
+        )
+
+    @staticmethod
+    def air_pollution_hourly(json):
+        components = json['components']
+        return CurrentAirPollution(
+            date_time=datetime.fromtimestamp(json["dt"], tz=UTC),
+            aqi=json['main']['aqi'],
+            co=components['co'],
+            no=components['no'],
+            no2=components['no2'],
+            o3=components['o3'],
+            so2=components['so2'],
+            pm2_5=components['pm2_5'],
+            pm10=components['pm10'],
+            nh3=components['nh3'],
+        )
+
     @staticmethod
     def free_to_current_weather(json):
         return CurrentWeather(