env-canada 0.7.2__tar.gz → 0.9.0__tar.gz

{env_canada-0.7.2 → env_canada-0.9.0}/LICENSE

@@ -16,4 +16,4 @@ 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
-SOFTWARE
+SOFTWARE

{env_canada-0.7.2/env_canada.egg-info → env_canada-0.9.0}/PKG-INFO

@@ -1,34 +1,72 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: env_canada
-Version: 0.7.2
+Version: 0.9.0
 Summary: A package to access meteorological data from Environment Canada
-Home-page: https://github.com/michaeldavie/env_canada
-Author: Michael Davie
-Author-email: michael.davie@gmail.com
-License: MIT
+Author-email: Michael Davie <michael.davie@gmail.com>
+Maintainer-email: Michael Davie <michael.davie@gmail.com>
+License: Copyright (c) 2018 The Python Packaging Authority
+        
+        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
+        SOFTWARE
+        
+Project-URL: Homepage, https://github.com/michaeldavie/env_canada
+Project-URL: Documentation, https://github.com/michaeldavie/env_canada
+Project-URL: Repository, https://github.com/michaeldavie/env_canada
+Project-URL: Issues, https://github.com/michaeldavie/env_canada/issues
+Project-URL: Changelog, https://github.com/michaeldavie/env_canada/blob/master/CHANGELOG.md
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: aiohttp>=3.9.0
-Requires-Dist: defusedxml
-Requires-Dist: geopy
+Requires-Dist: geopy>=2.4.1
 Requires-Dist: imageio>=2.28.0
-Requires-Dist: lxml
+Requires-Dist: lxml>=5.3.0
 Requires-Dist: numpy>=1.22.2
-Requires-Dist: pandas>=1.3.0
+Requires-Dist: pandas>=2.2.3
 Requires-Dist: Pillow>=10.0.1
-Requires-Dist: python-dateutil
-Requires-Dist: voluptuous
+Requires-Dist: python-dateutil>=2.9
+Requires-Dist: voluptuous>=0.15.2
+Dynamic: license-file
 
 # Environment Canada (env_canada)
 
 [![PyPI version](https://badge.fury.io/py/env-canada.svg)](https://badge.fury.io/py/env-canada)
-[![Snyk rating](https://snyk-widget.herokuapp.com/badge/pip/env-canada/badge.svg)](https://snyk.io/vuln/pip:env-canada@0.7.2?utm_source=badge)
+[![Snyk rating](https://snyk-widget.herokuapp.com/badge/pip/env-canada/badge.svg)](https://snyk.io/vuln/pip:env-canada@0.8.0?utm_source=badge)
+[![Python Lint and Test](../..//actions/workflows/python-app.yml/badge.svg)](../../actions/workflows/python-app.yml)
 
 This package provides access to various data sources published by [Environment and Climate Change Canada](https://www.canada.ca/en/environment-climate-change.html).
 
+> [!IMPORTANT]
+> If you're using the library in a Jupyter notebook, replace `asyncio.run(...)` with `await ...` in the examples below. For example:
+>
+> ```python
+> asyncio.run(ec_en.update())
+> ```
+>
+> becomes
+>
+> ```python
+> await ec_en.update()
+> ```
+
 ## Weather Observations and Forecasts
 
 `ECWeather` provides current conditions and forecasts. It automatically determines which weather station to use based on latitude/longitude provided. It is also possible to specify a specific station code of the form `AB/s0000123` based on those listed in [this CSV file](https://dd.weather.gc.ca/citypage_weather/docs/site_list_towns_en.csv). For example:
@@ -39,7 +77,7 @@ import asyncio
 from env_canada import ECWeather
 
 ec_en = ECWeather(coordinates=(50, -100))
-ec_fr = ECWeather(station_id='ON/s0000430', language='french')
+ec_fr = ECWeather(station_id="ON/s0000430", language="french")
 
 asyncio.run(ec_en.update())
 
@@ -120,7 +158,7 @@ from env_canada import ECHistorical
 from env_canada.ec_historical import get_historical_stations
 
 # search for stations, response contains station_ids
-coordinates = [53.916944, -122.749444] # [lat, long]
+coordinates = [53.916944, -122.749444]  # [lat, long]
 
 # coordinates: [lat, long]
 # radius: km
@@ -136,8 +174,12 @@ ec_fr_csv = ECHistorical(station_id=31688, year=2020, language="french", format=
 # timeframe argument can be passed to change the granularity
 # timeframe=1 hourly (need to create of for every month in that case, use ECHistoricalRange to handle it automatically)
 # timeframe=2 daily (default)
-ec_en_xml = ECHistorical(station_id=31688, year=2020, month=1, language="english", format="xml", timeframe=1)
-ec_en_csv = ECHistorical(station_id=31688, year=2020, month=1, language="english", format="csv", timeframe=1)
+ec_en_xml = ECHistorical(
+    station_id=31688, year=2020, month=1, language="english", format="xml", timeframe=1
+)
+ec_en_csv = ECHistorical(
+    station_id=31688, year=2020, month=1, language="english", format="csv", timeframe=1
+)
 
 asyncio.run(ec_en_xml.update())
 asyncio.run(ec_en_csv.update())
@@ -150,8 +192,8 @@ ec_en_xml.station_data
 
 # csv-generated responses return csv-like station data
 import pandas as pd
-df = pd.read_csv(ec_en_csv.station_data)
 
+df = pd.read_csv(ec_en_csv.station_data)
 ```
 
 `ECHistoricalRange` provides historical weather data within a specific range and handles the update by itself.
@@ -170,21 +212,29 @@ from env_canada import ECHistoricalRange
 from env_canada.ec_historical import get_historical_stations
 from datetime import datetime
 
-coordinates = ['48.508333', '-68.467667']
+coordinates = ["48.508333", "-68.467667"]
 
-stations = pd.DataFrame(asyncio.run(get_historical_stations(coordinates, start_year=2022,
-                                                end_year=2022, radius=200, limit=100))).T
+stations = pd.DataFrame(
+    asyncio.run(
+        get_historical_stations(
+            coordinates, start_year=2022, end_year=2022, radius=200, limit=100
+        )
+    )
+).T
 
-ec = ECHistoricalRange(station_id=int(stations.iloc[0,2]), timeframe="daily",
-                        daterange=(datetime(2022, 7, 1, 12, 12), datetime(2022, 8, 1, 12, 12)))
+ec = ECHistoricalRange(
+    station_id=int(stations.iloc[0, 2]),
+    timeframe="daily",
+    daterange=(datetime(2022, 7, 1, 12, 12), datetime(2022, 8, 1, 12, 12)),
+)
 
 ec.get_data()
 
-#yield an XML formated str.
+# yield an XML formated str.
 # For more options, use ec.to_xml(*arg, **kwargs) with pandas options
 ec.xml
 
-#yield an CSV formated str.
+# yield an CSV formated str.
 # For more options, use ec.to_csv(*arg, **kwargs) with pandas options
 ec.csv
 ```

{env_canada-0.7.2 → env_canada-0.9.0}/README.md

@@ -1,10 +1,24 @@
 # Environment Canada (env_canada)
 
 [![PyPI version](https://badge.fury.io/py/env-canada.svg)](https://badge.fury.io/py/env-canada)
-[![Snyk rating](https://snyk-widget.herokuapp.com/badge/pip/env-canada/badge.svg)](https://snyk.io/vuln/pip:env-canada@0.7.2?utm_source=badge)
+[![Snyk rating](https://snyk-widget.herokuapp.com/badge/pip/env-canada/badge.svg)](https://snyk.io/vuln/pip:env-canada@0.8.0?utm_source=badge)
+[![Python Lint and Test](../..//actions/workflows/python-app.yml/badge.svg)](../../actions/workflows/python-app.yml)
 
 This package provides access to various data sources published by [Environment and Climate Change Canada](https://www.canada.ca/en/environment-climate-change.html).
 
+> [!IMPORTANT]
+> If you're using the library in a Jupyter notebook, replace `asyncio.run(...)` with `await ...` in the examples below. For example:
+>
+> ```python
+> asyncio.run(ec_en.update())
+> ```
+>
+> becomes
+>
+> ```python
+> await ec_en.update()
+> ```
+
 ## Weather Observations and Forecasts
 
 `ECWeather` provides current conditions and forecasts. It automatically determines which weather station to use based on latitude/longitude provided. It is also possible to specify a specific station code of the form `AB/s0000123` based on those listed in [this CSV file](https://dd.weather.gc.ca/citypage_weather/docs/site_list_towns_en.csv). For example:
@@ -15,7 +29,7 @@ import asyncio
 from env_canada import ECWeather
 
 ec_en = ECWeather(coordinates=(50, -100))
-ec_fr = ECWeather(station_id='ON/s0000430', language='french')
+ec_fr = ECWeather(station_id="ON/s0000430", language="french")
 
 asyncio.run(ec_en.update())
 
@@ -96,7 +110,7 @@ from env_canada import ECHistorical
 from env_canada.ec_historical import get_historical_stations
 
 # search for stations, response contains station_ids
-coordinates = [53.916944, -122.749444] # [lat, long]
+coordinates = [53.916944, -122.749444]  # [lat, long]
 
 # coordinates: [lat, long]
 # radius: km
@@ -112,8 +126,12 @@ ec_fr_csv = ECHistorical(station_id=31688, year=2020, language="french", format=
 # timeframe argument can be passed to change the granularity
 # timeframe=1 hourly (need to create of for every month in that case, use ECHistoricalRange to handle it automatically)
 # timeframe=2 daily (default)
-ec_en_xml = ECHistorical(station_id=31688, year=2020, month=1, language="english", format="xml", timeframe=1)
-ec_en_csv = ECHistorical(station_id=31688, year=2020, month=1, language="english", format="csv", timeframe=1)
+ec_en_xml = ECHistorical(
+    station_id=31688, year=2020, month=1, language="english", format="xml", timeframe=1
+)
+ec_en_csv = ECHistorical(
+    station_id=31688, year=2020, month=1, language="english", format="csv", timeframe=1
+)
 
 asyncio.run(ec_en_xml.update())
 asyncio.run(ec_en_csv.update())
@@ -126,8 +144,8 @@ ec_en_xml.station_data
 
 # csv-generated responses return csv-like station data
 import pandas as pd
-df = pd.read_csv(ec_en_csv.station_data)
 
+df = pd.read_csv(ec_en_csv.station_data)
 ```
 
 `ECHistoricalRange` provides historical weather data within a specific range and handles the update by itself.
@@ -146,21 +164,29 @@ from env_canada import ECHistoricalRange
 from env_canada.ec_historical import get_historical_stations
 from datetime import datetime
 
-coordinates = ['48.508333', '-68.467667']
+coordinates = ["48.508333", "-68.467667"]
 
-stations = pd.DataFrame(asyncio.run(get_historical_stations(coordinates, start_year=2022,
-                                                end_year=2022, radius=200, limit=100))).T
+stations = pd.DataFrame(
+    asyncio.run(
+        get_historical_stations(
+            coordinates, start_year=2022, end_year=2022, radius=200, limit=100
+        )
+    )
+).T
 
-ec = ECHistoricalRange(station_id=int(stations.iloc[0,2]), timeframe="daily",
-                        daterange=(datetime(2022, 7, 1, 12, 12), datetime(2022, 8, 1, 12, 12)))
+ec = ECHistoricalRange(
+    station_id=int(stations.iloc[0, 2]),
+    timeframe="daily",
+    daterange=(datetime(2022, 7, 1, 12, 12), datetime(2022, 8, 1, 12, 12)),
+)
 
 ec.get_data()
 
-#yield an XML formated str.
+# yield an XML formated str.
 # For more options, use ec.to_xml(*arg, **kwargs) with pandas options
 ec.xml
 
-#yield an CSV formated str.
+# yield an CSV formated str.
 # For more options, use ec.to_csv(*arg, **kwargs) with pandas options
 ec.csv
 ```

env_canada-0.9.0/env_canada/__init__.py

@@ -0,0 +1,15 @@
+__all__ = [
+    "ECAirQuality",
+    "ECHistorical",
+    "ECHistoricalRange",
+    "ECHydro",
+    "ECRadar",
+    "ECWeather",
+    "ECWeatherUpdateFailed",
+]
+
+from .ec_aqhi import ECAirQuality
+from .ec_historical import ECHistorical, ECHistoricalRange
+from .ec_hydro import ECHydro
+from .ec_radar import ECRadar
+from .ec_weather import ECWeather, ECWeatherUpdateFailed

env_canada-0.9.0/env_canada/constants.py

@@ -0,0 +1 @@
+USER_AGENT = "env_canada/0.8.0"

{env_canada-0.7.2 → env_canada-0.9.0}/env_canada/ec_aqhi.py

@@ -1,10 +1,10 @@
-from datetime import datetime, timezone
 import logging
+from datetime import datetime, timezone
 
+import voluptuous as vol
 from aiohttp import ClientSession
-import defusedxml.ElementTree as et
 from geopy import distance
-import voluptuous as vol
+from lxml import etree as et
 
 from .constants import USER_AGENT
 
@@ -43,7 +43,7 @@ async def get_aqhi_regions(language):
         )
         result = await response.read()
 
-    site_xml = result.decode("utf-8")
+    site_xml = result
     xml_object = et.fromstring(site_xml)
 
     for zone in xml_object.findall("./EC_administrativeZone"):
@@ -83,7 +83,7 @@ async def find_closest_region(language, lat, lon):
     return min(region_list, key=site_distance)
 
 
-class ECAirQuality(object):
+class ECAirQuality:
     """Get air quality data from Environment Canada."""
 
     def __init__(self, **kwargs):
@@ -152,7 +152,7 @@ class ECAirQuality(object):
                 return None
 
             result = await response.read()
-            aqhi_xml = result.decode("ISO-8859-1")
+            aqhi_xml = result
             return et.fromstring(aqhi_xml)
 
     async def update(self):

{env_canada-0.7.2 → env_canada-0.9.0}/env_canada/ec_cache.py

@@ -1,8 +1,9 @@
 from datetime import datetime
+from typing import Any, ClassVar
 
 
 class Cache:
-    _cache = {}
+    _cache: ClassVar[dict[str, tuple[datetime, Any]]] = {}
 
     @classmethod
     def add(cls, cache_key, item, cache_time):

{env_canada-0.7.2 → env_canada-0.9.0}/env_canada/ec_historical.py

@@ -1,26 +1,28 @@
+import asyncio
 import copy
 import csv
+import logging
 from datetime import datetime
-from dateutil.relativedelta import relativedelta
 from io import StringIO
-import logging
-import xml.etree.ElementTree as et
-import pandas as pd
-import asyncio
 
-from aiohttp import ClientSession
-from dateutil import parser, tz
-import defusedxml.ElementTree as et
 import lxml.html
+import pandas as pd
 import voluptuous as vol
+from aiohttp import ClientSession
+from dateutil import parser, tz
+from dateutil.relativedelta import relativedelta
+from lxml import etree as et
 
 from .constants import USER_AGENT
 
-
 STATIONS_URL = "https://climate.weather.gc.ca/historical_data/search_historic_data_stations_{}.html"
 
 WEATHER_URL = "https://climate.weather.gc.ca/climate_data/bulk_data_{}.html"
 
+_TODAY = datetime.today().date()
+_ONE_YEAR_AGO = _TODAY - relativedelta(years=1, months=1, day=1)
+_YEAR = datetime.today().year
+
 LOG = logging.getLogger(__name__)
 
 __all__ = ["ECHistorical"]
@@ -126,7 +128,7 @@ async def get_historical_stations(
     coordinates,
     radius=25,
     start_year=1840,
-    end_year=datetime.today().year,
+    end_year=_YEAR,
     limit=25,
     language="english",
     timeframe=2,
@@ -204,8 +206,7 @@ async def get_historical_stations(
         return stations
 
 
-class ECHistorical(object):
-
+class ECHistorical:
     """Get historical weather data from Environment Canada."""
 
     def __init__(self, **kwargs):
@@ -353,30 +354,30 @@ def flip_daterange(f):
     return wrapper
 
 
-class ECHistoricalRange(object):
+class ECHistoricalRange:
     """Get historical weather data from Environment Canada in the given range for the given station.
 
-    options are daily or hourly data
+        options are daily or hourly data
 
-    Example:
-        import pandas as pd
-        import asyncio
-        from env_canada import ECHistoricalRange, get_historical_stations
-        from datetime import datetime
+        Example:
+            import pandas as pd
+            import asyncio
+            from env_canada import ECHistoricalRange, get_historical_stations
+            from datetime import datetime
 
-        coordinates = ['48.508333', '-68.467667']
+            coordinates = ['48.508333', '-68.467667']
 
-        stations = pd.DataFrame(asyncio.run(get_historical_stations(coordinates, start_year=2022,
-                                                        end_year=2022, radius=200, limit=100))).T
+            stations = pd.DataFrame(asyncio.run(get_historical_stations(coordinates, start_year=2022,
+                                                            end_year=2022, radius=200, limit=100))).T
 
-        ec = ECHistoricalRange(station_id=int(stations.iloc[0,2]), timeframe="hourly",
-                                daterange=(datetime(2022, 7, 1, 12, 12), datetime(2022, 8, 1, 12, 12)))
+            ec = ECHistoricalRange(station_id=int(stations.iloc[0,2]), timeframe="hourly",
+                                    daterange=(datetime(2022, 7, 1, 12, 12), datetime(2022, 8, 1, 12, 12)))
 
-        ec.get_data()
+            ec.get_data()
 
-        ec.xml #yield an XML formatted str. For more options, use ec.to_xml(*arg, **kwargs) with pandas options
-
-        ec.csv #yield an CSV formatted str. For more options, use ec.to_csv(*arg, **kwargs) with pandas options
+            ec.xml #yield an XML formatted str. For more options, use ec.to_xml(*arg, **kwargs) with pandas options
+    =
+            ec.csv #yield an CSV formatted str. For more options, use ec.to_csv(*arg, **kwargs) with pandas options
     """
 
     @flip_daterange
@@ -384,8 +385,8 @@ class ECHistoricalRange(object):
         self,
         station_id,
         daterange=(
-            datetime.today().date() - relativedelta(years=1, months=1, day=1),
-            datetime.today().date(),
+            _ONE_YEAR_AGO,
+            _TODAY,
         ),
         language="english",
         timeframe="daily",
@@ -409,7 +410,14 @@ class ECHistoricalRange(object):
         self.months = self.monthlist(daterange=daterange)
         self.language = language
         _tf = {"hourly": 1, "daily": 2, "monthly": 3}
-        self.timeframe = _tf[timeframe]
+        timeframe_int = _tf[timeframe]
+        if timeframe_int == 2:
+            # prune the months list so it only has unique years. if daily is selected.
+            years = set()
+            for year, _ in self.months:
+                years.add(year)
+            self.months = [(year, 1) for year in years]
+        self.timeframe = timeframe_int
 
     def get_data(self):
         """
@@ -419,7 +427,6 @@ class ECHistoricalRange(object):
         """
         if not self.df.empty:
             self.df = pd.DataFrame()
-
         ec = [
             ECHistorical(
                 station_id=self.station_id,
@@ -437,7 +444,7 @@ class ECHistoricalRange(object):
             self.df = pd.concat((self.df, pd.read_csv(data.station_data)))
 
         self.df = self.df.set_index(
-            self.df.filter(regex="Date/*", axis=1).columns.values[0]
+            self.df.filter(regex="Date/*", axis=1).columns.to_numpy()[0]
         )
         self.df.index = pd.to_datetime(self.df.index)
 
@@ -477,7 +484,10 @@ class ECHistoricalRange(object):
     @flip_daterange
     def monthlist(self, daterange):
         startdate, stopdate = daterange
-        total_months = lambda dt: dt.month + 12 * dt.year
+
+        def total_months(dt):
+            return dt.month + 12 * dt.year
+
         mlist = []
         for tot_m in range(total_months(startdate) - 1, total_months(stopdate)):
             y, m = divmod(tot_m, 12)

{env_canada-0.7.2 → env_canada-0.9.0}/env_canada/ec_hydro.py

@@ -1,10 +1,10 @@
 import csv
 import io
 
+import voluptuous as vol
 from aiohttp import ClientSession
 from dateutil.parser import isoparse
 from geopy import distance
-import voluptuous as vol
 
 from .constants import USER_AGENT
 
@@ -54,8 +54,7 @@ async def closest_site(lat, lon):
     return closest
 
 
-class ECHydro(object):
-
+class ECHydro:
     """Get hydrometric data from Environment Canada."""
 
     def __init__(self, **kwargs):

{env_canada-0.7.2 → env_canada-0.9.0}/env_canada/ec_radar.py

@@ -1,16 +1,16 @@
 import asyncio
-from datetime import date, timedelta
 import logging
 import math
 import os
+from datetime import date, timedelta
 from io import BytesIO
 from typing import cast
 
 import dateutil.parser
-import defusedxml.ElementTree as et
 import voluptuous as vol
 from aiohttp import ClientSession
 from aiohttp.client_exceptions import ClientConnectorError
+from lxml import etree as et
 from PIL import Image, ImageDraw, ImageFont
 
 from .constants import USER_AGENT
@@ -114,7 +114,7 @@ async def _get_resource(url, params, bytes=True):
         return await response.text()
 
 
-class ECRadar(object):
+class ECRadar:
     def __init__(self, **kwargs):
         """Initialize the radar object."""
 
@@ -195,7 +195,7 @@ class ECRadar(object):
                 return Cache.add("basemap", base_bytes, timedelta(days=7))
 
             except ClientConnectorError as e:
-                logging.warning("Map from %s could not be retrieved: %s" % map_url, e)
+                logging.warning("Map from %s could not be retrieved: %s", map_url, e)
 
     async def _get_legend(self):
         """Fetch legend image."""
@@ -226,7 +226,7 @@ class ECRadar(object):
         if not (capabilities_xml := Cache.get(capabilities_cache_key)):
             capabilities_params["layer"] = precip_layers[self._precip_type_actual]
             capabilities_xml = await _get_resource(
-                geomet_url, capabilities_params, bytes=False
+                geomet_url, capabilities_params, bytes=True
             )
             Cache.add(capabilities_cache_key, capabilities_xml, timedelta(minutes=5))
 
@@ -236,9 +236,9 @@ class ECRadar(object):
         )
         if dimension_string is not None:
             if dimension_string := dimension_string.text:
-                start, end = [
+                start, end = (
                     dateutil.parser.isoparse(t) for t in dimension_string.split("/")[:2]
-                ]
+                )
                 self.timestamp = end.isoformat()
                 return (start, end)
         return None