pybraendstofpriser 2.2.0__tar.gz → 2.3.0__tar.gz

pybraendstofpriser-2.3.0/PKG-INFO

@@ -0,0 +1,53 @@
+Metadata-Version: 2.4
+Name: pybraendstofpriser
+Version: 2.3.0
+Summary: Library for fetching fuel prices from Fuelprices.dk API
+License: GPL-3.0-only
+License-File: LICENSE
+Author: Malene Trab
+Author-email: malene@trab.dk
+Requires-Python: >=3.11,<4.0
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Requires-Dist: aiohttp (>=3.13.2,<4.0.0)
+Description-Content-Type: text/markdown
+
+![Buy Me A Coffee](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)
+
+## pybraendstofpriser
+
+This is a PyPI module for fetching fuel prices from Fuelprices.dk API, primarily developed for use with [Home Assistant](https://home-assistant.io), but I try to keep it as widely usable as possible.
+
+The API requires an API key to be used - see [https://fuelprices.dk](https://fuelprices.dk) for more information.
+
+### Fetch prices for multiple stations
+
+```python
+from pybraendstofpriser import Braendstofpriser
+
+client = Braendstofpriser("your-api-key")
+stations = await client.get_prices_bulk([1234, 4321])
+
+for item in stations:
+    print(item["station"]["name"], item["prices"])
+```
+
+`get_prices_bulk` returns an `Flist` of station records with `company`, `station`,
+`prices`, `price_units`, and `price_kinds`, preserving the API's values (including
+prices as strings). It requests all current products for each station.
+
+Up to 1,000 distinct station IDs are fetched in one HTTP request with a page size
+of 1,000. Larger selections are split into groups of at most 1,000 IDs; any further
+pages are fetched automatically. Duplicate IDs are requested once, and an empty
+selection makes no requests. Result order follows the API within each group.
+
+The API omits unknown, inactive, stale, and unpriced stations. HTTP errors are
+raised to the caller, including errors on later groups or pages; partial results
+are not returned. The existing `get_prices` method remains available for fetching
+a single station.
+

pybraendstofpriser-2.3.0/README.md

@@ -0,0 +1,33 @@
+![Buy Me A Coffee](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)
+
+## pybraendstofpriser
+
+This is a PyPI module for fetching fuel prices from Fuelprices.dk API, primarily developed for use with [Home Assistant](https://home-assistant.io), but I try to keep it as widely usable as possible.
+
+The API requires an API key to be used - see [https://fuelprices.dk](https://fuelprices.dk) for more information.
+
+### Fetch prices for multiple stations
+
+```python
+from pybraendstofpriser import Braendstofpriser
+
+client = Braendstofpriser("your-api-key")
+stations = await client.get_prices_bulk([1234, 4321])
+
+for item in stations:
+    print(item["station"]["name"], item["prices"])
+```
+
+`get_prices_bulk` returns an `Flist` of station records with `company`, `station`,
+`prices`, `price_units`, and `price_kinds`, preserving the API's values (including
+prices as strings). It requests all current products for each station.
+
+Up to 1,000 distinct station IDs are fetched in one HTTP request with a page size
+of 1,000. Larger selections are split into groups of at most 1,000 IDs; any further
+pages are fetched automatically. Duplicate IDs are requested once, and an empty
+selection makes no requests. Result order follows the API within each group.
+
+The API omits unknown, inactive, stale, and unpriced stations. HTTP errors are
+raised to the caller, including errors on later groups or pages; partial results
+are not returned. The existing `get_prices` method remains available for fetching
+a single station.

{pybraendstofpriser-2.2.0 → pybraendstofpriser-2.3.0}/pybraendstofpriser/__init__.py

@@ -5,16 +5,17 @@ from __future__ import annotations
 import logging
 import sys
 from collections import namedtuple
-
-from .exceptions import StationNotFoundError
+from collections.abc import Sequence
 
 from .conn import Connector, Endpoint
+from .exceptions import StationNotFoundError
 
 if sys.version_info < (3, 11, 0):
     sys.exit("The pybraendstofpriser module requires Python 3.11.0 or later")
 
 _LOGGER = logging.getLogger(__name__)
 Company = namedtuple("Company", "module namespace products name")
+_BULK_STATION_LIMIT = 1000
 
 
 class Flist(list):
@@ -74,3 +75,32 @@ class Braendstofpriser:
         args = {"station_id": station_id}
 
         return await self.conn.fetch_data(Endpoint.PRICES, args)
+
+    async def get_prices_bulk(self, station_ids: Sequence[int]) -> Flist[dict]:
+        """Get all current products for the requested stations.
+
+        Split IDs into groups of at most 1000 and fetch all pages per group.
+        Return the API records unchanged; raise on any failed request.
+        """
+        unique_ids = list(dict.fromkeys(station_ids))
+        stations = Flist()
+        for start in range(0, len(unique_ids), _BULK_STATION_LIMIT):
+            batch = unique_ids[start : start + _BULK_STATION_LIMIT]
+            page = 1
+            while True:
+                data = await self.conn.fetch_data(
+                    Endpoint.STATIONS_BULK,
+                    {
+                        "station_ids": ",".join(
+                            str(station_id) for station_id in batch
+                        ),
+                        "page": page,
+                        "page_size": _BULK_STATION_LIMIT,
+                    },
+                )
+                stations.extend(data["items"])
+                if page >= data["total_pages"]:
+                    break
+                page += 1
+
+        return stations

{pybraendstofpriser-2.2.0 → pybraendstofpriser-2.3.0}/pybraendstofpriser/conn.py

@@ -1,8 +1,10 @@
 """Connector module for communicating with fuel price services."""
 
 from __future__ import annotations
+
 from typing import Optional
 from wsgiref import headers
+
 import aiohttp
 
 from .const import API_ENDPOINT, API_TIMEOUT
@@ -13,6 +15,7 @@ class Endpoint:
 
     PRICES = "/prices"
     STATIONS = "/stations"
+    STATIONS_BULK = "/stations/bulk"
     COMPANIES = "/companies"
 
 

{pybraendstofpriser-2.2.0 → pybraendstofpriser-2.3.0}/pyproject.toml

@@ -1,9 +1,9 @@
 [tool.poetry]
 name = "pybraendstofpriser"
-version = "2.2.0"
+version = "2.3.0"
 description = "Library for fetching fuel prices from Fuelprices.dk API"
 authors = ["Malene Trab <malene@trab.dk>"]
-license = "MIT"
+license = "GPL-3.0-only"
 readme = "README.md"
 
 [tool.poetry.dependencies]

pybraendstofpriser-2.2.0/PKG-INFO

@@ -1,25 +0,0 @@
-Metadata-Version: 2.4
-Name: pybraendstofpriser
-Version: 2.2.0
-Summary: Library for fetching fuel prices from Fuelprices.dk API
-License: MIT
-License-File: LICENSE
-Author: Malene Trab
-Author-email: malene@trab.dk
-Requires-Python: >=3.11,<4.0
-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
-Classifier: Programming Language :: Python :: 3.14
-Requires-Dist: aiohttp (>=3.13.2,<4.0.0)
-Description-Content-Type: text/markdown
-
-![Buy Me A Coffee](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)
-
-## pybraendstofpriser
-
-This is a PyPI module for fetching fuel prices from Fuelprices.dk API, primarily developed for use with [Home Assistant](https://home-assistant.io), but I try to keep it as widely usable as possible.
-
-The API requires an API key to be used - see [https://fuelprices.dk](https://fuelprices.dk) for more information.

pybraendstofpriser-2.2.0/README.md

@@ -1,7 +0,0 @@
-![Buy Me A Coffee](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)
-
-## pybraendstofpriser
-
-This is a PyPI module for fetching fuel prices from Fuelprices.dk API, primarily developed for use with [Home Assistant](https://home-assistant.io), but I try to keep it as widely usable as possible.
-
-The API requires an API key to be used - see [https://fuelprices.dk](https://fuelprices.dk) for more information.