meteocatpy 0.0.11 → 0.0.13

package/filetree.txt

@@ -1,48 +1,48 @@
-└── .github/
-    └── workflows/
-        ├── release.yml
-├── .gitignore
-├── .gitlab-ci.yml
-├── .pre-commit-config.yaml
-├── .releaserc
-├── .releaserc.toml
-├── AUTHORS.md
-├── CHANGELOG.md
-├── LICENSE
-├── README.md
-├── filetree.py
-├── filetree.txt
-└── meteocatpy/
-    ├── README.md
-    ├── __init__.py
-    ├── const.py
-    ├── data.py
-    ├── exceptions.py
-    ├── forecast.py
-    ├── helpers.py
-    ├── py.typed
-    ├── stations.py
-    ├── symbols.py
-    ├── town.py
-    ├── townstations.py
-    ├── variables.py
-    ├── version.py
-├── package-lock.json
-├── package.json
-├── poetry.lock
-├── pyproject.toml
-├── releaserc.json
-├── requirements.test.txt
-├── setup.cfg
-├── setup.py
-└── tests/
-    ├── data_test.py
-    ├── import_test.py
-    ├── integration_test_complete.py
-    ├── integration_test_forecast.py
-    ├── integration_test_station_data.py
-    ├── integration_test_stations.py
-    ├── integration_test_symbols.py
-    ├── integration_test_town.py
-    ├── integration_test_town_stations.py
-    ├── integration_test_variables.py
+└── .github/
+    └── workflows/
+        ├── release.yml
+├── .gitignore
+├── .gitlab-ci.yml
+├── .pre-commit-config.yaml
+├── .releaserc
+├── .releaserc.toml
+├── AUTHORS.md
+├── CHANGELOG.md
+├── LICENSE
+├── README.md
+├── filetree.py
+├── filetree.txt
+└── meteocatpy/
+    ├── README.md
+    ├── __init__.py
+    ├── const.py
+    ├── data.py
+    ├── exceptions.py
+    ├── forecast.py
+    ├── helpers.py
+    ├── py.typed
+    ├── stations.py
+    ├── symbols.py
+    ├── town.py
+    ├── townstations.py
+    ├── variables.py
+    ├── version.py
+├── package-lock.json
+├── package.json
+├── poetry.lock
+├── pyproject.toml
+├── releaserc.json
+├── requirements.test.txt
+├── setup.cfg
+├── setup.py
+└── tests/
+    ├── data_test.py
+    ├── import_test.py
+    ├── integration_test_complete.py
+    ├── integration_test_forecast.py
+    ├── integration_test_station_data.py
+    ├── integration_test_stations.py
+    ├── integration_test_symbols.py
+    ├── integration_test_town.py
+    ├── integration_test_town_stations.py
+    ├── integration_test_variables.py

package/meteocatpy/README.md

@@ -1,62 +1,62 @@
-# Meteocat Python Package for Meteocat Home Assistant Integration
-
-[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
-[![Python version compatibility](https://img.shields.io/pypi/pyversions/meteocatpy)](https://pypi.org/project/meteocatpy)
-[![pipeline status](https://gitlab.com/figorr/meteocatpy/badges/master/pipeline.svg)](https://gitlab.com/figorr/meteocatpy/commits/master)
-
-
-`meteocatpy` is a Python package to interact with the Meteocat API. Allows you to obtain meteorological data and lists of municipalities from the Meteocat API.
-
-**NOTE:** Meteocat API requires to use an API_KEY, you should ask to (https://apidocs.meteocat.gencat.cat/documentacio/acces-ciutada-i-administracio/)
-
-# Installation
-
-You can install the package from PyPI using `pip`:
-```bash
-pip install meteocatpy
-```
-
-```bash
-from meteocatpy.town import MeteocatTown
-
-# Replace 'tu_api_key' with your actual API key
-API_KEY = "tu_api_key"
-town_client = MeteocatTown(API_KEY)
-
-# Get a list of municipalities (asynchronous call)
-municipios_data = await town_client.get_municipis()
-print(municipis)
-```
-
-# Credits
-
-This is a personal project.
-
-Authors:
-- Figorr
-
-# Contributing
-
-If you would like to contribute to this project, please open an issue or create a pull request. I'd be happy to review your contributions!
-
-1.  [Check for open features/bugs](https://gitlab.com/figorr/meteocatpy/issues)
-    or [initiate a discussion on one](https://gitlab.com/figorr/meteocatpy/issues/new).
-2.  [Fork the repository](https://gitlab.com/figorr/meteocatpy/forks/new).
-3.  Install the dev environment: `make init`.
-4.  Enter the virtual environment: `pipenv shell`
-5.  Code your new feature or bug fix.
-6.  Write a test that covers your new functionality.
-7.  Update `README.md` with any new documentation.
-8.  Run tests and ensure 100% code coverage for your contribution: `make coverage`
-9.  Ensure you have no linting errors: `make lint`
-10. Ensure you have typed your code correctly: `make typing`
-11. Add yourself to `AUTHORS.md`.
-12. Submit a pull request!
-
-# License
-
-[Apache-2.0](LICENSE). By providing a contribution, you agree the contribution is licensed under Apache-2.0.
-
-# API Reference
-
+# Meteocat Python Package for Meteocat Home Assistant Integration
+
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Python version compatibility](https://img.shields.io/pypi/pyversions/meteocatpy)](https://pypi.org/project/meteocatpy)
+[![pipeline status](https://gitlab.com/figorr/meteocatpy/badges/master/pipeline.svg)](https://gitlab.com/figorr/meteocatpy/commits/master)
+
+
+`meteocatpy` is a Python package to interact with the Meteocat API. Allows you to obtain meteorological data and lists of municipalities from the Meteocat API.
+
+**NOTE:** Meteocat API requires to use an API_KEY, you should ask to (https://apidocs.meteocat.gencat.cat/documentacio/acces-ciutada-i-administracio/)
+
+# Installation
+
+You can install the package from PyPI using `pip`:
+```bash
+pip install meteocatpy
+```
+
+```bash
+from meteocatpy.town import MeteocatTown
+
+# Replace 'tu_api_key' with your actual API key
+API_KEY = "tu_api_key"
+town_client = MeteocatTown(API_KEY)
+
+# Get a list of municipalities (asynchronous call)
+municipios_data = await town_client.get_municipis()
+print(municipis)
+```
+
+# Credits
+
+This is a personal project.
+
+Authors:
+- Figorr
+
+# Contributing
+
+If you would like to contribute to this project, please open an issue or create a pull request. I'd be happy to review your contributions!
+
+1.  [Check for open features/bugs](https://gitlab.com/figorr/meteocatpy/issues)
+    or [initiate a discussion on one](https://gitlab.com/figorr/meteocatpy/issues/new).
+2.  [Fork the repository](https://gitlab.com/figorr/meteocatpy/forks/new).
+3.  Install the dev environment: `make init`.
+4.  Enter the virtual environment: `pipenv shell`
+5.  Code your new feature or bug fix.
+6.  Write a test that covers your new functionality.
+7.  Update `README.md` with any new documentation.
+8.  Run tests and ensure 100% code coverage for your contribution: `make coverage`
+9.  Ensure you have no linting errors: `make lint`
+10. Ensure you have typed your code correctly: `make typing`
+11. Add yourself to `AUTHORS.md`.
+12. Submit a pull request!
+
+# License
+
+[Apache-2.0](LICENSE). By providing a contribution, you agree the contribution is licensed under Apache-2.0.
+
+# API Reference
+
 [See the docs 📚](https://apidocs.meteocat.gencat.cat/section/informacio-general/).

package/meteocatpy/__init__.py

@@ -1,27 +1,27 @@
-"""METEOCAT API.
-
-Python Package to collect data from Meteocat API and interact with Meteocat Home Assistant Integration
-SPDX-License-Identifier: Apache-2.0
-
-For more details about this API, please refer to the documentation at
-https://gitlab.com/figorr/meteocatpy
-"""
-
-# meteocatpy/__init__.py
-from .town import MeteocatTown
-from .forecast import MeteocatForecast
-from .symbols import MeteocatSymbols
-from .stations import MeteocatStations
-from .townstations import MeteocatTownStations
-from .data import MeteocatStationData
-from .variables import MeteocatVariables
-
-__all__ = [
-    "MeteocatTown", 
-    "MeteocatForecast", 
-    "MeteocatSymbols", 
-    "MeteocatStations", 
-    "MeteocatTownStations", 
-    "MeteocatStationData", 
-    "MeteocatVariables"
-]
+"""METEOCAT API.
+
+Python Package to collect data from Meteocat API and interact with Meteocat Home Assistant Integration
+SPDX-License-Identifier: Apache-2.0
+
+For more details about this API, please refer to the documentation at
+https://gitlab.com/figorr/meteocatpy
+"""
+
+# meteocatpy/__init__.py
+from .town import MeteocatTown
+from .forecast import MeteocatForecast
+from .symbols import MeteocatSymbols
+from .stations import MeteocatStations
+from .townstations import MeteocatTownStations
+from .data import MeteocatStationData
+from .variables import MeteocatVariables
+
+__all__ = [
+    "MeteocatTown", 
+    "MeteocatForecast", 
+    "MeteocatSymbols", 
+    "MeteocatStations", 
+    "MeteocatTownStations", 
+    "MeteocatStationData", 
+    "MeteocatVariables"
+]

package/meteocatpy/const.py

@@ -1,10 +1,10 @@
-"""meteocatpy constants."""
-BASE_URL = "https://api.meteo.cat"
-MUNICIPIS_LIST_URL = "/referencia/v1/municipis"
-MUNICIPIS_HORA_URL = "/pronostic/v1/municipalHoraria/{codi}"
-MUNICIPIS_DIA_URL = "/pronostic/v1/municipal/{codi}"
-SYMBOLS_URL = "/referencia/v1/simbols"
-STATIONS_LIST_URL = "/xema/v1/estacions/metadades"
-STATIONS_MUNICIPI_URL = "/xema/v1/representatives/metadades/municipis/{codi_municipi}/variables/{codi_variable}"
-VARIABLES_URL = "/xema/v1/variables/mesurades/metadades"
-STATION_DATA_URL = "/xema/v1/estacions/mesurades/{codiEstacio}/{any}/{mes}/{dia}"
+"""meteocatpy constants."""
+BASE_URL = "https://api.meteo.cat"
+MUNICIPIS_LIST_URL = "/referencia/v1/municipis"
+MUNICIPIS_HORA_URL = "/pronostic/v1/municipalHoraria/{codi}"
+MUNICIPIS_DIA_URL = "/pronostic/v1/municipal/{codi}"
+SYMBOLS_URL = "/referencia/v1/simbols"
+STATIONS_LIST_URL = "/xema/v1/estacions/metadades"
+STATIONS_MUNICIPI_URL = "/xema/v1/representatives/metadades/municipis/{codi_municipi}/variables/{codi_variable}"
+VARIABLES_URL = "/xema/v1/variables/mesurades/metadades"
+STATION_DATA_URL = "/xema/v1/estacions/mesurades/{codiEstacio}/{any}/{mes}/{dia}"

package/meteocatpy/data.py

@@ -1,93 +1,93 @@
-import aiohttp
-import logging
-from datetime import datetime
-from .variables import MeteocatVariables
-from .const import BASE_URL, STATION_DATA_URL
-from .exceptions import (
-    BadRequestError,
-    ForbiddenError,
-    TooManyRequestsError,
-    InternalServerError,
-    UnknownAPIError,
-)
-
-_LOGGER = logging.getLogger(__name__)
-
-class MeteocatStationData:
-    """Clase para interactuar con los datos de estaciones de la API de Meteocat."""
-
-    def __init__(self, api_key: str):
-        """
-        Inicializa la clase MeteocatStationData.
-
-        Args:
-            api_key (str): Clave de API para autenticar las solicitudes.
-        """
-        self.api_key = api_key
-        self.headers = {
-            "Content-Type": "application/json",
-            "X-Api-Key": self.api_key,
-        }
-        self.variables = MeteocatVariables(api_key)
-    
-    @staticmethod
-    def get_current_date():
-        """
-        Obtiene la fecha actual en formato numérico.
-
-        Returns:
-            tuple: Año (YYYY), mes (MM), día (DD) como enteros.
-        """
-        now = datetime.now()
-        return now.year, now.month, now.day
-
-    async def get_station_data(self, station_id: str):
-        """
-        Obtiene los datos meteorológicos de una estación desde la API de Meteocat.
-
-        Args:
-            station_id (str): Código de la estación.
-
-        Returns:
-            dict: Datos meteorológicos de la estación.
-        """
-        any, mes, dia = self.get_current_date()  # Calcula la fecha actual
-        url = f"{BASE_URL}{STATION_DATA_URL}".format(
-            codiEstacio=station_id, any=any, mes=f"{mes:02d}", dia=f"{dia:02d}"
-        )
-    
-        async with aiohttp.ClientSession() as session:
-            try:
-                async with session.get(url, headers=self.headers) as response:
-                    if response.status == 200:
-                        return await response.json()
-
-                    # Gestionar errores según el código de estado
-                    if response.status == 400:
-                        raise BadRequestError(await response.json())
-                    elif response.status == 403:
-                        error_data = await response.json()
-                        if error_data.get("message") == "Forbidden":
-                            raise ForbiddenError(error_data)
-                        elif error_data.get("message") == "Missing Authentication Token":
-                            raise ForbiddenError(error_data)
-                    elif response.status == 429:
-                        raise TooManyRequestsError(await response.json())
-                    elif response.status == 500:
-                        raise InternalServerError(await response.json())
-                    else:
-                        raise UnknownAPIError(
-                            f"Unexpected error {response.status}: {await response.text()}"
-                        )
-
-            except aiohttp.ClientError as e:
-                raise UnknownAPIError(
-                    message=f"Error al conectar con la API de Meteocat: {str(e)}",
-                    status_code=0,
-                )
-
-            except Exception as ex:
-                raise UnknownAPIError(
-                    message=f"Error inesperado: {str(ex)}",
-                    status_code=0,
-                )
+import aiohttp
+import logging
+from datetime import datetime
+from .variables import MeteocatVariables
+from .const import BASE_URL, STATION_DATA_URL
+from .exceptions import (
+    BadRequestError,
+    ForbiddenError,
+    TooManyRequestsError,
+    InternalServerError,
+    UnknownAPIError,
+)
+
+_LOGGER = logging.getLogger(__name__)
+
+class MeteocatStationData:
+    """Clase para interactuar con los datos de estaciones de la API de Meteocat."""
+
+    def __init__(self, api_key: str):
+        """
+        Inicializa la clase MeteocatStationData.
+
+        Args:
+            api_key (str): Clave de API para autenticar las solicitudes.
+        """
+        self.api_key = api_key
+        self.headers = {
+            "Content-Type": "application/json",
+            "X-Api-Key": self.api_key,
+        }
+        self.variables = MeteocatVariables(api_key)
+    
+    @staticmethod
+    def get_current_date():
+        """
+        Obtiene la fecha actual en formato numérico.
+
+        Returns:
+            tuple: Año (YYYY), mes (MM), día (DD) como enteros.
+        """
+        now = datetime.now()
+        return now.year, now.month, now.day
+
+    async def get_station_data(self, station_id: str):
+        """
+        Obtiene los datos meteorológicos de una estación desde la API de Meteocat.
+
+        Args:
+            station_id (str): Código de la estación.
+
+        Returns:
+            dict: Datos meteorológicos de la estación.
+        """
+        any, mes, dia = self.get_current_date()  # Calcula la fecha actual
+        url = f"{BASE_URL}{STATION_DATA_URL}".format(
+            codiEstacio=station_id, any=any, mes=f"{mes:02d}", dia=f"{dia:02d}"
+        )
+    
+        async with aiohttp.ClientSession() as session:
+            try:
+                async with session.get(url, headers=self.headers) as response:
+                    if response.status == 200:
+                        return await response.json()
+
+                    # Gestionar errores según el código de estado
+                    if response.status == 400:
+                        raise BadRequestError(await response.json())
+                    elif response.status == 403:
+                        error_data = await response.json()
+                        if error_data.get("message") == "Forbidden":
+                            raise ForbiddenError(error_data)
+                        elif error_data.get("message") == "Missing Authentication Token":
+                            raise ForbiddenError(error_data)
+                    elif response.status == 429:
+                        raise TooManyRequestsError(await response.json())
+                    elif response.status == 500:
+                        raise InternalServerError(await response.json())
+                    else:
+                        raise UnknownAPIError(
+                            f"Unexpected error {response.status}: {await response.text()}"
+                        )
+
+            except aiohttp.ClientError as e:
+                raise UnknownAPIError(
+                    message=f"Error al conectar con la API de Meteocat: {str(e)}",
+                    status_code=0,
+                )
+
+            except Exception as ex:
+                raise UnknownAPIError(
+                    message=f"Error inesperado: {str(ex)}",
+                    status_code=0,
+                )

package/meteocatpy/exceptions.py

@@ -1,35 +1,35 @@
-"""METEOCAT API exceptions."""
-
-from __future__ import annotations
-
-class MeteocatAPIError(Exception):
-    """Clase base para todos los errores de la API de Meteocat."""
-    def __init__(self, message: str, status_code: int, aws_info: dict = None):
-        super().__init__(message)
-        self.status_code = status_code
-        self.aws_info = aws_info
-
-class BadRequestError(MeteocatAPIError):
-    """Error 400: Bad request."""
-    def __init__(self, message: str, aws_info: dict = None):
-        super().__init__(message, 400, aws_info)
-
-class ForbiddenError(MeteocatAPIError):
-    """Error 403: Forbidden."""
-    def __init__(self, message: str, aws_info: dict = None):
-        super().__init__(message, 403, aws_info)
-
-class TooManyRequestsError(MeteocatAPIError):
-    """Error 429: Too many requests."""
-    def __init__(self, message: str, aws_info: dict = None):
-        super().__init__(message, 429, aws_info)
-
-class InternalServerError(MeteocatAPIError):
-    """Error 500: Internal server error."""
-    def __init__(self, message: str, aws_info: dict = None):
-        super().__init__(message, 500, aws_info)
-
-class UnknownAPIError(MeteocatAPIError):
-    """Error desconocido de la API."""
-    def __init__(self, message: str, status_code: int, aws_info: dict = None):
-        super().__init__(message, status_code, aws_info)
+"""METEOCAT API exceptions."""
+
+from __future__ import annotations
+
+class MeteocatAPIError(Exception):
+    """Clase base para todos los errores de la API de Meteocat."""
+    def __init__(self, message: str, status_code: int, aws_info: dict = None):
+        super().__init__(message)
+        self.status_code = status_code
+        self.aws_info = aws_info
+
+class BadRequestError(MeteocatAPIError):
+    """Error 400: Bad request."""
+    def __init__(self, message: str, aws_info: dict = None):
+        super().__init__(message, 400, aws_info)
+
+class ForbiddenError(MeteocatAPIError):
+    """Error 403: Forbidden."""
+    def __init__(self, message: str, aws_info: dict = None):
+        super().__init__(message, 403, aws_info)
+
+class TooManyRequestsError(MeteocatAPIError):
+    """Error 429: Too many requests."""
+    def __init__(self, message: str, aws_info: dict = None):
+        super().__init__(message, 429, aws_info)
+
+class InternalServerError(MeteocatAPIError):
+    """Error 500: Internal server error."""
+    def __init__(self, message: str, aws_info: dict = None):
+        super().__init__(message, 500, aws_info)
+
+class UnknownAPIError(MeteocatAPIError):
+    """Error desconocido de la API."""
+    def __init__(self, message: str, status_code: int, aws_info: dict = None):
+        super().__init__(message, status_code, aws_info)