Add User-Agent (#8)

* Add User-Agent

* Replace setup.py by pyproject.toml for dynamic package versioning.

* update user-agent

* Enhance tests to verify User-Agent header is set correctly in requests

* update workflows

* Update coverage publishing step to specify GitHub service

---------

Co-authored-by: Adrian <adrian@morenomartinez.com>

Author: sheaur

.github/workflows/build_test.yml

@@ -22,20 +22,21 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install setuptools coveralls
+          pip install coveralls
           pip install -r test-requirements.txt
       - name: Lint with flake8
         run: |
           # stop the build if there are Python syntax errors or undefined names
           flake8 meteoclimatic --count --max-complexity=10 --max-line-length=127 --statistics
       - name: Install
         run: |
-          python setup.py install
+          pip install -e .
       - name: Test with pytest
         run: |
           pytest --cov=meteoclimatic/ -v tests/
       - name: Publish Coverage
         env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
         run: |
-          coveralls
+          coveralls --service=github

.github/workflows/publish.yml

@@ -22,9 +22,9 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install setuptools wheel twine
+          pip install build
       - name: Build
         run: |
-          python setup.py sdist bdist_wheel
+          python -m build
       - name: Publish package to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1

meteoclimatic/__init__.py

@@ -1,3 +1,5 @@
+__version__ = "0.1.1"
+
 from meteoclimatic.weather import Weather, Condition  # noqa: F401
 from meteoclimatic.station import Station  # noqa: F401
 from meteoclimatic.observation import Observation  # noqa: F401

meteoclimatic/client.py

@@ -1,9 +1,10 @@
-from urllib.request import urlopen
+from urllib.request import Request, urlopen
 from urllib.error import HTTPError
 from bs4 import BeautifulSoup
 
 from meteoclimatic.exceptions import MeteoclimaticError, StationNotFound
 from meteoclimatic import Observation
+from meteoclimatic import __version__
 
 
 class MeteoclimaticClient(object):
@@ -16,14 +17,18 @@ class MeteoclimaticClient(object):
     def weather_at_station(self, station_code):
         url = self._base_url.format(station_code=station_code)
 
+        req = Request(url, headers={"User-Agent": f"pymeteoclimatic/{__version__}"})
+
         try:
-            parse_xml_url = urlopen(url)
+            parse_xml_url = urlopen(req)
         except HTTPError as exc:
-            raise MeteoclimaticError("Error fetching station data [status_code=%d]" %
-                  (exc.getcode(), )) from exc
+            raise MeteoclimaticError(
+                "Error fetching station data [status_code=%d]" % (exc.getcode(),)
+            ) from exc
 
         xml_page = parse_xml_url.read()
         parse_xml_url.close()
+
         soup_page = BeautifulSoup(xml_page, "xml")
         items = soup_page.findAll("item")
 

pyproject.toml

@@ -0,0 +1,45 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pymeteoclimatic"
+dynamic = ["version"]
+description = "A Python wrapper around the Meteoclimatic service"
+readme = "README.md"
+requires-python = ">=3.8"
+license = {text = "MIT"}
+authors = [
+    {name = "Adrián Moreno", email = "adrian@morenomartinez.com"}
+]
+keywords = ["meteoclimatic", "client", "library", "api", "weather"]
+classifiers = [
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries",
+]
+dependencies = [
+    "lxml>=4.5",
+    "beautifulsoup4>=4.9",
+]
+
+[project.urls]
+Homepage = "https://github.com/adrianmo/pymeteoclimatic"
+Repository = "https://github.com/adrianmo/pymeteoclimatic"
+
+[tool.setuptools.packages.find]
+include = ["meteoclimatic*"]
+
+[tool.setuptools.dynamic]
+version = {attr = "meteoclimatic.__version__"}

setup.py

@@ -1,9 +1,11 @@
 import os
 import unittest
 from urllib.error import HTTPError
+from urllib.request import Request
 from meteoclimatic.exceptions import StationNotFound, MeteoclimaticError
 from meteoclimatic import MeteoclimaticClient
-from unittest.mock import patch
+from meteoclimatic import __version__
+from unittest.mock import patch, MagicMock
 
 
 class TestMeteoclimaticClient(unittest.TestCase):
@@ -19,8 +21,14 @@ def test_get_station_info_ok(self, mock_urlopen):
 
         res = self.client.weather_at_station("ESCAT4300000043206B")
 
-        mock_urlopen.assert_called_with(
-            "https://www.meteoclimatic.net/feed/rss/ESCAT4300000043206B")
+        # Verify urlopen was called with a Request object
+        self.assertEqual(mock_urlopen.call_count, 1)
+        called_request = mock_urlopen.call_args[0][0]
+        self.assertIsInstance(called_request, Request)
+        self.assertEqual(called_request.full_url, 
+                        "https://www.meteoclimatic.net/feed/rss/ESCAT4300000043206B")
+        self.assertEqual(called_request.get_header("User-agent"), 
+                        f"pymeteoclimatic/{__version__}")
         self.assertEqual(res.station.code, "ESCAT4300000043206B")
 
     @patch('meteoclimatic.client.urlopen', autospec=True)
@@ -41,3 +49,21 @@ def test_get_station_info_404(self, mock_urlopen):
             self.client.weather_at_station("ESCAT4300000043206B")
         self.assertEqual(str(
             error.exception), "Error fetching station data [status_code=404]")
+
+    @patch('meteoclimatic.client.urlopen', autospec=True)
+    def test_user_agent_header_is_set(self, mock_urlopen):
+        """Test that the User-Agent header is correctly set with version"""
+        mock_response = MagicMock()
+        mock_response.read.return_value = open(os.path.join(
+            os.path.dirname(__file__), "feeds", "full_station.xml")).read()
+        mock_urlopen.return_value = mock_response
+
+        self.client.weather_at_station("ESCAT4300000043206B")
+
+        # Verify the Request object has the correct User-Agent
+        called_request = mock_urlopen.call_args[0][0]
+        self.assertIsInstance(called_request, Request)
+        user_agent = called_request.get_header("User-agent")
+        self.assertEqual(user_agent, f"pymeteoclimatic/{__version__}")
+        # Verify it follows the expected format
+        self.assertTrue(user_agent.startswith("pymeteoclimatic/"))