LCPDelta 2.2.2__tar.gz → 2.2.3__tar.gz

{lcpdelta-2.2.2/lcpdelta_python_package/src/LCPDelta.egg-info → lcpdelta-2.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: LCPDelta
-Version: 2.2.2
+Version: 2.2.3
 Summary: LCPDelta Python Package
 Author-email: LCP Delta <enact.helpdesk@lcp.uk.com>
 Project-URL: Homepage, https://portal.lcpdelta.com/

{lcpdelta-2.2.2 → lcpdelta-2.2.3/lcpdelta_python_package/src/LCPDelta.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: LCPDelta
-Version: 2.2.2
+Version: 2.2.3
 Summary: LCPDelta Python Package
 Author-email: LCP Delta <enact.helpdesk@lcp.uk.com>
 Project-URL: Homepage, https://portal.lcpdelta.com/

{lcpdelta-2.2.2 → lcpdelta-2.2.3}/lcpdelta_python_package/src/lcp_delta/common/api_endpoints.py

@@ -87,6 +87,8 @@ class EnactApiEndpoints:
     def PLANT_INFO_BY_FUEL(self): return f"{self._base_endpoints.MAIN_BASE_URL}/EnactAPI/Plant/Data/PlantInfoByFuelType"
     @property
     def PLANT_IDS(self): return f"{self._base_endpoints.MAIN_BASE_URL}/EnactAPI/Plant/Data/PlantList"
+    @property
+    def FUEL_LIST(self): return f"{self._base_endpoints.MAIN_BASE_URL}/EnactAPI/Plant/Data/FuelList"
 
     @property
     def HOF(self): return f"{self._base_endpoints.MAIN_BASE_URL}/EnactAPI/HistoryOfForecast/Data_V2"

{lcpdelta-2.2.2 → lcpdelta-2.2.3}/lcpdelta_python_package/src/lcp_delta/enact/api_helper.py

@@ -5,20 +5,22 @@ from typing import Union
 from lcp_delta.global_helpers import convert_datetime_to_iso
 from lcp_delta.common import APIHelperBase
 from lcp_delta.enact.helpers import get_month_name
-from lcp_delta.enact.services import ancillary_service
-from lcp_delta.enact.services import contract_evolution_service
-from lcp_delta.enact.services import bm_service
-from lcp_delta.enact.services import day_ahead_service
-from lcp_delta.enact.services import epex_service
-from lcp_delta.enact.services import hof_service
-from lcp_delta.enact.services import leaderboard_service
-from lcp_delta.enact.services import index_service
-from lcp_delta.enact.services import news_table_service
-from lcp_delta.enact.services import nordpool_service
-from lcp_delta.enact.services import plant_service
-from lcp_delta.enact.services import series_service
-from lcp_delta.enact.services import niv_evolution_service
-from lcp_delta.enact.services import carbon_calculator_service
+from lcp_delta.enact.services import (
+    ancillary_service,
+    bm_service,
+    carbon_calculator_service,
+    contract_evolution_service,
+    day_ahead_service,
+    epex_service,
+    hof_service,
+    index_service,
+    leaderboard_service,
+    news_table_service,
+    niv_evolution_service,
+    nordpool_service,
+    plant_service,
+    series_service,
+)
 
 class APIHelper(APIHelperBase):
     def _make_series_request(
@@ -689,6 +691,25 @@ class APIHelper(APIHelperBase):
         response = await self._post_request_async(self.endpoints.PLANT_IDS, request_body)
         return plant_service.process_country_fuel_response(response)
 
+    def get_list_of_fuels(self, dispatch_type : str | None = None) -> list[str]:
+        """Get a list of all the fuels, optionally supplying a dispatch type.
+
+        Args:
+            dispatch_type `str` (optional): The dispatch type. If no dispatch type is specified, all fuels are returned. Options are "Dispatchable", "Fixed", "Interconnector", "Wind", "Solar", "Hydro", "Storage" and "None".
+
+        Returns:
+            Response: The response object containing the plant data.
+        """
+        request_body = plant_service.generate_fuel_list_request(dispatch_type)
+        response = self._post_request(self.endpoints.FUEL_LIST, request_body)
+        return plant_service.process_fuel_list_response(response)
+
+    async def get_list_of_fuels_async(self, dispatch_type : str | None = None) -> list[str]:
+        """An asynchronous version of `get_list_of_fuels`."""
+        request_body = plant_service.generate_fuel_list_request(dispatch_type)
+        response = await self._post_request_async(self.endpoints.FUEL_LIST, request_body)
+        return plant_service.process_fuel_list_response(response)
+
     def get_history_of_forecast_for_given_date(
         self, series_id: str, date: datetime, country_id: str, option_id: str | None = None
     ) -> pd.DataFrame:

{lcpdelta-2.2.2 → lcpdelta-2.2.3}/lcpdelta_python_package/src/lcp_delta/enact/services/plant_service.py

@@ -7,6 +7,11 @@ def generate_fuel_request(fuel: str) -> dict:
 def generate_country_fuel_request(country_id: str, fuel_id: str) -> dict:
     return {"Country": country_id, "Fuel": fuel_id}
 
+def generate_fuel_list_request(dispatch_type: str | None = None) -> dict:
+    return {"DispatchType": dispatch_type}
 
 def process_country_fuel_response(response: dict) -> dict:
     return response["data"]
+
+def process_fuel_list_response(response: dict) -> list[str]:
+    return response["data"]

{lcpdelta-2.2.2 → lcpdelta-2.2.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "LCPDelta"
-version = "2.2.2"
+version = "2.2.3"
 authors = [
   { name="LCP Delta", email="enact.helpdesk@lcp.uk.com" },
 ]
@@ -52,7 +52,7 @@ dev = [
 [tool.ruff]
 src = ["lcpdelta_python_package/src"]
 line-length = 120
-target-version = "2.2.2"
+target-version = "2.2.3"
 
 [tool.ruff.lint.extend-per-file-ignores]
 "__init__.py" = ["E402", "F401"]