Merge pull request #643 from andrewshaodev/feature/12-hour-time

Feature/12 hour time

Author: Der-Henning

config.sample.ini

@@ -37,6 +37,9 @@ MetricsPort = 8000
 ## Set localization for ${{pickupdate}}
 Locale = en_US
 
+## Time format for pickup dates: "24h" for 24-hour format (default), "12h" for 12-hour format with AM/PM
+TimeFormat = 24h
+
 ## Disable to not show activity spinner in console
 Activity = True
 

pyproject.toml

@@ -41,7 +41,7 @@ repository = "https://github.com/Der-Henning/tgtg"
 [tool.poetry]
 packages = [{ include = "tgtg_scanner" }]
 requires-poetry = '>=2.0.0,<3.0.0'
-version = "1.23.1"
+version = "1.23.2"
 
 [tool.poetry.group.build.dependencies]
 pyinstaller = "^6.3.0"

tests/test_item.py

@@ -23,3 +23,24 @@ def test_item(tgtg_item: dict, monkeypatch: pytest.MonkeyPatch):
     assert item.store_name == tgtg_item.get("store", {}).get("store_name", "-")
     assert item.item_logo == tgtg_item.get("item", {}).get("logo_picture", {}).get("current_url", "-")
     assert item.item_cover == tgtg_item.get("item", {}).get("cover_picture", {}).get("current_url", "-")
+
+
+def test_item_pickupdate_24h_format(tgtg_item: dict):
+    """Test pickup date formatting with 24-hour time format."""
+    item = Item(tgtg_item, time_format="24h")
+    pickupdate = item.pickupdate
+    # The pickup time should be formatted as 24-hour with colon separator (e.g., "19:00 - 19:30")
+    # Check that it contains the colon format and doesn't contain AM/PM
+    assert ":" in pickupdate
+    assert " - " in pickupdate
+    assert "AM" not in pickupdate
+    assert "PM" not in pickupdate
+
+
+def test_item_pickupdate_12h_format(tgtg_item: dict):
+    """Test pickup date formatting with 12-hour time format."""
+    item = Item(tgtg_item, time_format="12h")
+    pickupdate = item.pickupdate
+    # The pickup time should be formatted as 12-hour with AM/PM (e.g., "07:00 PM - 07:30 PM")
+    assert "PM" in pickupdate or "AM" in pickupdate
+    assert ":" in pickupdate

tgtg_scanner/models/config.py

@@ -533,6 +533,7 @@ class Config(BaseConfig):
     schedule_cron: Cron = field(default_factory=Cron)
     debug: bool = False
     locale: str = "en_US"
+    time_format: str = "24h"
     metrics: bool = False
     metrics_port: int = 8000
     disable_tests: bool = False
@@ -611,6 +612,7 @@ def _read_ini(self, parser: configparser.ConfigParser):
         self._ini_get_cron(parser, "MAIN", "ScheduleCron", "schedule_cron")
         self._ini_get_boolean(parser, "MAIN", "Debug", "debug")
         self._ini_get(parser, "MAIN", "Locale", "locale")
+        self._ini_get(parser, "MAIN", "TimeFormat", "time_format")
         self._ini_get_boolean(parser, "MAIN", "Metrics", "metrics")
         self._ini_get_int(parser, "MAIN", "MetricsPort", "metrics_port")
         self._ini_get_boolean(parser, "MAIN", "DisableTests", "disable_tests")
@@ -624,6 +626,7 @@ def _read_env(self):
         self._env_get_cron("SCHEDULE_CRON", "schedule_cron")
         self._env_get_boolean("DEBUG", "debug")
         self._env_get("LOCALE", "locale")
+        self._env_get("TIME_FORMAT", "time_format")
         self._env_get_boolean("METRICS", "metrics")
         self._env_get_int("METRICS_PORT", "metrics_port")
         self._env_get_boolean("DISABLE_TESTS", "disable_tests")

tgtg_scanner/models/item.py

@@ -52,7 +52,7 @@ class Item:
     returns well formated data for notifications.
     """
 
-    def __init__(self, data: dict, location: Union[Location, None] = None, locale: str = "en_US"):
+    def __init__(self, data: dict, location: Union[Location, None] = None, locale: str = "en_US", time_format: str = "24h"):
         self.items_available: int = data.get("items_available", 0)
         self.display_name: str = data.get("display_name", "-")
         self.favorite: str = "Yes" if data.get("favorite", False) else "No"
@@ -88,6 +88,7 @@ def __init__(self, data: dict, location: Union[Location, None] = None, locale: s
         self.scanned_on: str = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
         self.location = location
         self.locale = locale
+        self.time_format = time_format
 
     @property
     def rating(self) -> str:
@@ -171,7 +172,15 @@ def pickupdate(self) -> str:
         now = datetime.datetime.now()
         pfr = self._datetimeparse(self.pickup_interval_start)
         pto = self._datetimeparse(self.pickup_interval_end)
-        prange = f"{pfr.hour:02d}:{pfr.minute:02d} - {pto.hour:02d}:{pto.minute:02d}"
+
+        # Format time based on time_format setting
+        if self.time_format == "12h":
+            # 12-hour format with AM/PM
+            prange = f"{pfr.strftime('%I:%M %p')} - {pto.strftime('%I:%M %p')}"
+        else:
+            # Default 24-hour format
+            prange = f"{pfr.hour:02d}:{pfr.minute:02d} - {pto.hour:02d}:{pto.minute:02d}"
+
         tomorrow = now + datetime.timedelta(days=1)
         if now.date() == pfr.date():
             return f"{humanize.naturalday(now)}, {prange}"

tgtg_scanner/scanner.py

@@ -76,7 +76,7 @@ def _get_test_item(self) -> Item:
             return items[0]
         items = sorted(
             [
-                Item(item, self.location, self.config.locale)
+                Item(item, self.location, self.config.locale, self.config.time_format)
                 for item in self.tgtg_client.get_items(favorites_only=False, latitude=53.5511, longitude=9.9937, radius=50)
             ],
             key=lambda x: x.items_available,
@@ -95,7 +95,7 @@ def _job(self) -> None:
             try:
                 if item_id != "":
                     item_dict = self.tgtg_client.get_item(item_id)
-                    items.append(Item(item_dict, self.location, self.config.locale))
+                    items.append(Item(item_dict, self.location, self.config.locale, self.config.time_format))
             except TgtgAPIError as err:
                 log.error(err)
         items += self._get_favorites()
@@ -127,7 +127,7 @@ def _get_favorites(self) -> list[Item]:
         except TgtgAPIError as err:
             log.error(err)
             return []
-        return [Item(item, self.location, self.config.locale) for item in items]
+        return [Item(item, self.location, self.config.locale, self.config.time_format) for item in items]
 
     def _check_item(self, item: Item) -> None:
         """Checks if the available item amount raised from zero to something

tgtg_scanner/tgtg/tgtg_client.py

@@ -24,7 +24,7 @@
 
 log = logging.getLogger("tgtg")
 BASE_URL = "https://apptoogoodtogo.com/api/"
-API_ITEM_ENDPOINT = "item/v8/"
+API_ITEM_ENDPOINT = "item/v9/"
 FAVORITE_ITEM_ENDPOINT = "user/favorite/v1/{}/update"
 AUTH_BY_EMAIL_ENDPOINT = "auth/v5/authByEmail"
 AUTH_POLLING_ENDPOINT = "auth/v5/authByRequestPollingId"