gshock-api 2.0.32__tar.gz → 2.0.35__tar.gz

{gshock_api-2.0.32 → gshock_api-2.0.35}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: gshock_api
-Version: 2.0.32
-Summary: Pythgon API for GShock Watches using BLE
-Home-page: https://github.com/pyscaffold/pyscaffold/
+Version: 2.0.35
+Summary: Python API for GShock Watches using BLE
+Home-page: https://github.com/izivkov/gshock_api/
 Author: Ivo Zivkov
 Author-email: Ivo Zivkov <izivkov@gmail.com>
 License-Expression: MIT
@@ -17,6 +17,7 @@ Requires-Dist: pydantic>=2.0.0
 Requires-Dist: types-requests
 Requires-Dist: python-dotenv
 Requires-Dist: typing-extensions>=4.12
+Requires-Dist: twine>=6.2.0
 Provides-Extra: dev
 Requires-Dist: basedpyright>=1.31.7; extra == "dev"
 Requires-Dist: ruff; extra == "dev"
@@ -109,14 +110,14 @@ It is recommended that you create a virtual environment to run the tests:
 
    .. code-block:: sh
 
-      python3 src/examples/api_tests.py [--multi-watch]
+      uv run src/examples/api_tests.py
 
-The optional **`--multi-watch`** parameter forces the library to scan for watches every time it tries to connect to a watch. If not provided, 
-the library will try to connect to the last connected watch only. If you have multiple watches, you should use this parameter.
-      
-The optional **`--multi-watch`** parameter forces the library to scan for watches every time it tries to connect to a watch. If not provided, 
-the library will try to connect to the last connected watch only. If you have multiple watches, you should use this parameter.
+or activate `venv`` first and then run using python:
 
+   .. code-block:: sh
+      
+      source .venv/bin/activate
+      python src/examples/api_tests.py
 
 Installing the library for your project:
 ========================================
@@ -127,7 +128,7 @@ Installing the library for your project:
 
 See `this project <https://github.com/izivkov/GShockTimeServer>`_ using this library to run a time server for G-Shock watches.
 
-See also `this blog <https://digitalsober.wordpress.com/2025/05/05/g-shock-watch-integration-with-sxmo/>`_ for using the library in the `SXMO <https://sxmo.org/>`_ mobile environment.
+See also `this blog <https://digitalsober.wordpress.com/2024/05/05/g-shock-watch-integration-with-sxmo/>`_ for using the library in the `SXMO <https://sxmo.org/>`_ mobile environment.
 
 Troubleshooting:
 ================

{gshock_api-2.0.32 → gshock_api-2.0.35}/README.rst

@@ -81,14 +81,14 @@ It is recommended that you create a virtual environment to run the tests:
 
    .. code-block:: sh
 
-      python3 src/examples/api_tests.py [--multi-watch]
+      uv run src/examples/api_tests.py
 
-The optional **`--multi-watch`** parameter forces the library to scan for watches every time it tries to connect to a watch. If not provided, 
-the library will try to connect to the last connected watch only. If you have multiple watches, you should use this parameter.
-      
-The optional **`--multi-watch`** parameter forces the library to scan for watches every time it tries to connect to a watch. If not provided, 
-the library will try to connect to the last connected watch only. If you have multiple watches, you should use this parameter.
+or activate `venv`` first and then run using python:
 
+   .. code-block:: sh
+      
+      source .venv/bin/activate
+      python src/examples/api_tests.py
 
 Installing the library for your project:
 ========================================
@@ -99,7 +99,7 @@ Installing the library for your project:
 
 See `this project <https://github.com/izivkov/GShockTimeServer>`_ using this library to run a time server for G-Shock watches.
 
-See also `this blog <https://digitalsober.wordpress.com/2025/05/05/g-shock-watch-integration-with-sxmo/>`_ for using the library in the `SXMO <https://sxmo.org/>`_ mobile environment.
+See also `this blog <https://digitalsober.wordpress.com/2024/05/05/g-shock-watch-integration-with-sxmo/>`_ for using the library in the `SXMO <https://sxmo.org/>`_ mobile environment.
 
 Troubleshooting:
 ================

{gshock_api-2.0.32 → gshock_api-2.0.35}/pyproject.toml

@@ -11,8 +11,8 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "gshock_api"  # Change to your project name
-version = "2.0.32"
-description = "Pythgon API for GShock Watches using BLE"
+version = "2.0.35"
+description = "Python API for GShock Watches using BLE"
 authors = [{ name = "Ivo Zivkov", email = "izivkov@gmail.com" }]
 
 license = "MIT"
@@ -25,6 +25,7 @@ dependencies = [
     "types-requests",
     "python-dotenv",
     "typing-extensions>=4.12",
+    "twine>=6.2.0",
 ]
 classifiers = [
   "Development Status :: 4 - Beta",

{gshock_api-2.0.32 → gshock_api-2.0.35}/setup.cfg

@@ -6,10 +6,11 @@ author_email = izivkov@gmail.com
 license = MIT
 license_files = LICENSE.txt
 long_description = file: README.rst
-long_description_content_type = text/x-rst; charset=UTF-8
-url = https://github.com/pyscaffold/pyscaffold/
+long_description_content_type = text/x-rst
+url = https://github.com/izivkov/gshock_api/
 project_urls = 
-	Documentation = https://pyscaffold.org/
+	Documentation = https://github.com/izivkov/gshock_api/
+	Source = https://github.com/izivkov/gshock_api/
 platforms = any
 classifiers = 
 	Development Status :: 4 - Beta
@@ -63,7 +64,7 @@ exclude =
 
 [pyscaffold]
 version = 4.4
-package = gshocktimeserver
+package = gshock_api
 
 [egg_info]
 tag_build = 

{gshock_api-2.0.32 → gshock_api-2.0.35}/setup.py

@@ -2,7 +2,7 @@ from setuptools import find_packages, setup
 
 setup(
     name="gshock_api",
-    version="2.0.31",
+    version="2.0.35",
     package_dir={"": "src"},
     packages=find_packages(where="src"),
     install_requires=[

{gshock_api-2.0.32 → gshock_api-2.0.35}/src/examples/api_tests.py

@@ -2,9 +2,9 @@ import asyncio
 from collections.abc import Sequence
 from datetime import datetime
 import json
+from pprint import pformat
 import sys
 import time
-from typing import Optional
 
 import pytz
 
@@ -58,7 +58,7 @@ async def run_api_tests(argv: Sequence[str]) -> None:  # noqa: PLR0915
         await api.set_time(time.time() + 10 * 60)
 
         alarms = await api.get_alarms()
-        logger.info(f"alarms: {alarms}")
+        logger.info(f"alarms: {pformat(alarms)}")
 
         alarms[3]["enabled"] = True
         alarms[3]["hour"] = 7
@@ -79,7 +79,7 @@ async def run_api_tests(argv: Sequence[str]) -> None:  # noqa: PLR0915
         logger.info(f"condition: {condition}")
 
         settings_local = await api.get_basic_settings()
-        logger.info(f"settings: {settings_local}")
+        logger.info(f"settings: {pformat(settings_local)}")
 
         settings_local["button_tone"] = True
         settings_local["language"] = "Russian"
@@ -111,11 +111,11 @@ async def run_api_tests(argv: Sequence[str]) -> None:  # noqa: PLR0915
             + """}}"""
         )
         Event().create_event(json.loads(event_json_str))
-        logger.info(f"Created event: {event_json_str}")
+        logger.info(f"Created event: {pformat(json.loads(event_json_str))}")
 
         reminders = await api.get_reminders()
         for reminder in reminders:
-            logger.info(f"reminder: {reminder}")
+            logger.info (f"reminder: {pformat(reminder)}")
 
         reminders[3]["title"] = "Test Event"
 
@@ -204,11 +204,10 @@ async def app_notifications(api: GshockAPI) -> None:
     await api.send_app_notification(email_notification2)
 
 
-def convert_time_string_to_epoch(time_string: str) -> Optional[float]:
+def convert_time_string_to_epoch(time_string: str) -> float | None:
     try:
         time_object = datetime.strptime(time_string, "%H:%M:%S")
-        timestamp = time_object.timestamp()
-        return timestamp
+        return time_object.timestamp()
     except ValueError:
         logger.info("Invalid time format. Please use the format HH:MM:SS.")
         return None

{gshock_api-2.0.32 → gshock_api-2.0.35}/src/gshock_api/cancelable_result.py

@@ -37,4 +37,4 @@ class CancelableResult(Generic[T]):  # noqa: UP046
 
     def set_result(self, value: T) -> None:
         if not self._future.done():
-            self._future.set_result(value)
+            self._future.set_result(value)

{gshock_api-2.0.32 → gshock_api-2.0.35}/src/gshock_api/connection.py

@@ -100,8 +100,7 @@ class Connection:
     def is_service_supported(self, handle: int) -> bool:
         """Checks if a characteristic UUID mapped to a handle is present in the discovered characteristics."""
         uuid: str | None = self.handles_map.get(handle)
-        
-        return uuid not in self.characteristics_map
+        return uuid is not None and uuid in self.characteristics_map
 
     async def write(self, handle: int, data: bytes) -> None:
         """Writes data to a characteristic identified by its handle."""
@@ -118,13 +117,14 @@ class Connection:
                     )
                 return
 
-            responseType: bool = handle == 0x0E  # noqa: N806, PLR2004
+            # 0x0E is CASIO_ALL_FEATURES_CHARACTERISTIC_UUID (requires response)
+            response_type: bool = handle == 0x0E
             
             cmd_data: bytes = to_casio_cmd(data)
 
             if self.client:
                 await self.client.write_gatt_char(
-                    uuid, cmd_data, response=responseType
+                    uuid, cmd_data, response=response_type
                 )
 
         except Exception as e:
@@ -155,6 +155,6 @@ class Connection:
         return handles_map
 
     # Replaced Any with TypeVar T
-    async def sendMessage(self, message: T) -> None:  # noqa: N802
+    async def send_message(self, message: T) -> None:
         """Sends a message to the watch using the message dispatcher."""
         await message_dispatcher.MessageDispatcher.send_to_watch(message)

{gshock_api-2.0.32 → gshock_api-2.0.35}/src/gshock_api/event.py

@@ -1,7 +1,7 @@
 from __future__ import annotations  # Enables forward references like 'Event'
 
 from dataclasses import dataclass
-from datetime import date, datetime, tzinfo
+from datetime import datetime
 import json
 import types
 from typing import TYPE_CHECKING, Final, TypeVar
@@ -10,6 +10,7 @@ if TYPE_CHECKING:
     from collections.abc import (  # Using Mapping for dict types where object values are complex
         Mapping,
     )
+    from datetime import date, tzinfo
 
 # Define a Type Variable T for generic message objects
 T = TypeVar("T") 

{gshock_api-2.0.32 → gshock_api-2.0.35}/src/gshock_api/gshock_api.py

@@ -54,23 +54,23 @@ class GshockAPI:
         result: WatchButton = await message_dispatcher.ButtonPressedIO.request(self.connection)
         return result
 
-    async def get_world_cities(self, cityNumber: int) -> str:  # noqa: N803
+    async def get_world_cities(self, city_number: int) -> str:
         """Get the name for a particular World City set on the watch."""
-        return await self._get_world_cities(cityNumber)
+        return await self._get_world_cities(city_number)
 
-    async def _get_world_cities(self, key: int) -> str:
+    async def _get_world_cities(self, city_number: int) -> str:
         # Assuming WorldCitiesIO.request returns a string
-        result: str = await message_dispatcher.WorldCitiesIO.request(self.connection, key)
+        result: str = await message_dispatcher.WorldCitiesIO.request(self.connection, city_number)
         return result
 
-    async def get_dst_for_world_cities(self, cityNumber: int) -> str:  # noqa: N803
+    async def get_dst_for_world_cities(self, city_number: int) -> str:
         """Get the **Daylight Saving Time** for a particular World City set on the watch."""
-        return await self._get_dst_for_world_cities(cityNumber)
+        return await self._get_dst_for_world_cities(city_number)
 
-    async def _get_dst_for_world_cities(self, key: int) -> str:
+    async def _get_dst_for_world_cities(self, city_number: int) -> str:
         # Assuming DstForWorldCitiesIO.request returns a string
         result: str = await message_dispatcher.DstForWorldCitiesIO.request(
-            self.connection, key
+            self.connection, city_number
         )
         return result
 
@@ -124,38 +124,16 @@ class GshockAPI:
             await self.read_and_write(function, state)
 
     async def read_write_dst_for_world_cities(self) -> None:
-        # Use dict instead of generic Map/Any
-        array_of_get_dst_for_world_cities: list[dict[str, RequestFunction | int]] = [  # noqa: F821 # type: ignore
-            {"function": self.get_dst_for_world_cities, "city_number": 0},
-            {"function": self.get_dst_for_world_cities, "city_number": 1},
-            {"function": self.get_dst_for_world_cities, "city_number": 2},
-            {"function": self.get_dst_for_world_cities, "city_number": 3},
-            {"function": self.get_dst_for_world_cities, "city_number": 4},
-            {"function": self.get_dst_for_world_cities, "city_number": 5},
-        ]
+        fn = self.get_dst_for_world_cities
 
-        # Type inference for item and its keys
-        for item in array_of_get_dst_for_world_cities[: watch_info.worldCitiesCount]:
-            function: RequestFunction = item["function"] # type: ignore[assignment]  # noqa: F821
-            city_number: int = item["city_number"] # type: ignore[assignment]
-            await self.read_and_write(function, city_number)
+        for city_number in range(watch_info.worldCitiesCount):
+            await self.read_and_write(fn, city_number)
 
     async def read_write_world_cities(self) -> None:
-        # Use dict instead of generic Map/Any
-        array_of_world_cities: list[dict[str, RequestFunction | int]] = [  # noqa: F821 # type: ignore
-            {"function": self.get_world_cities, "city_number": 0},
-            {"function": self.get_world_cities, "city_number": 1},
-            {"function": self.get_world_cities, "city_number": 2},
-            {"function": self.get_world_cities, "city_number": 3},
-            {"function": self.get_world_cities, "city_number": 4},
-            {"function": self.get_world_cities, "city_number": 5},
-        ]
+        fn = self.get_world_cities
 
-        # Type inference for item and its keys
-        for item in array_of_world_cities[: watch_info.worldCitiesCount]:
-            function: RequestFunction = item["function"]  # noqa: F821 # type: ignore
-            city_number: int = item["city_number"] # type: ignore[assignment]
-            await self.read_and_write(function, city_number)
+        for city_number in range(watch_info.worldCitiesCount):
+            await self.read_and_write(fn, city_number)
 
     # current_time is unknown type, using object | None
     async def set_time(
@@ -191,8 +169,8 @@ class GshockAPI:
         # Assuming T objects are JSON serializable
         alarms_str: str = json.dumps(alarms)
         set_action_cmd: str = f'{{"action":"SET_ALARMS", "value":{alarms_str} }}'
-        # connection.sendMessage expects T, which must be convertible to a watch message
-        await self.connection.sendMessage(set_action_cmd)
+        # connection.send_message expects T, which must be convertible to a watch message
+        await self.connection.send_message(set_action_cmd)
 
     async def get_timer(self) -> int:
         """Get Timer value in seconds."""
@@ -203,10 +181,10 @@ class GshockAPI:
         result: int = await message_dispatcher.TimerIO.request(self.connection)
         return result
 
-    async def set_timer(self, timerValue: int) -> None:  # noqa: N803
+    async def set_timer(self, timer_value: int) -> None:
         """Set Timer value in seconds."""
-        message: str = f'{{"action": "SET_TIMER", "value": {timerValue} }}'
-        await self.connection.sendMessage(message)
+        message: str = f'{{"action": "SET_TIMER", "value": {timer_value} }}'
+        await self.connection.send_message(message)
 
     # Watch condition request returns an unknown object (object)
     async def get_watch_condition(self) -> object:
@@ -224,7 +202,7 @@ class GshockAPI:
     ) -> None:
         """Sets auto-tame adjustment for the watch"""
         message: str = f"""{{"action": "SET_TIME_ADJUSTMENT", "timeAdjustment": "{time_adjustement}", "minutesAfterHour": "{minutes_after_hour}" }}"""
-        await self.connection.sendMessage(message)
+        await self.connection.send_message(message)
 
     # SettingsIO returns a list of unknown Setting objects (list[T])
     async def get_basic_settings(self) -> list[T]:
@@ -237,20 +215,11 @@ class GshockAPI:
         """Set settings to the watch."""
         setting_json: str = json.dumps(settings)
         message: str = f'{{"action": "SET_SETTINGS", "value": {setting_json} }}'
-        await self.connection.sendMessage(message)
+        await self.connection.send_message(message)
 
     # get_reminders returns a list of unknown Event objects (list[T])
     async def get_reminders(self) -> list[T]:
-        """Gets the current reminders (events) from the watch."""
-        reminders: list[T] = [] # type: ignore[assignment]
-
-        reminders.append(await self.get_event_from_watch(1)) # type: ignore[arg-type]
-        reminders.append(await self.get_event_from_watch(2)) # type: ignore[arg-type]
-        reminders.append(await self.get_event_from_watch(3)) # type: ignore[arg-type]
-        reminders.append(await self.get_event_from_watch(4)) # type: ignore[arg-type]
-        reminders.append(await self.get_event_from_watch(5)) # type: ignore[arg-type]
-
-        return reminders
+        return [await self.get_event_from_watch(i) for i in range(1, 6)]
 
     # get_event_from_watch returns an unknown Event object (T)
     async def get_event_from_watch(self, event_number: int) -> T:
@@ -284,7 +253,7 @@ class GshockAPI:
         events_as_json: list[Mapping[str, object]] = to_json(events)
         enabled: list[Mapping[str, object]] = get_enabled_events(events_as_json)
 
-        await self.connection.sendMessage(
+        await self.connection.send_message(
             f"""{{"action": "SET_REMINDERS", "value": {json.dumps(enabled)}}}"""
         )
 

{gshock_api-2.0.32 → gshock_api-2.0.35}/src/gshock_api/iolib/alarms_io.py

@@ -45,12 +45,13 @@ class AlarmsIO:
         AlarmsIO.connection = connection
         alarms_inst_typed.clear()
         await AlarmsIO._get_alarms(connection)
-        assert AlarmsIO.result is not None  # noqa: S101
+        if AlarmsIO.result is None:
+            raise RuntimeError("AlarmsIO.result must not be None after _get_alarms")
         return AlarmsIO.result
 
     @staticmethod
     async def _get_alarms(connection: ConnectionProtocol) -> CancelableResult[list[dict[str, object]]]:
-        await connection.sendMessage('{ "action": "GET_ALARMS"}')
+        await connection.send_message('{ "action": "GET_ALARMS"}')
         AlarmsIO.result = CancelableResult[list[dict[str, object]]]()
         return await AlarmsIO.result.get_result()
 

{gshock_api-2.0.32 → gshock_api-2.0.35}/src/gshock_api/iolib/events_io.py

@@ -1,5 +1,5 @@
 import json
-from typing import List, TypedDict  # noqa: UP035
+from typing import TypedDict
 
 from gshock_api.cancelable_result import CancelableResult
 from gshock_api.casio_constants import CasioConstants
@@ -45,7 +45,7 @@ class ReminderTimeDict(TypedDict):
     repeat_period: str
     start_date: DateDict
     end_date: DateDict
-    days_of_week: List[str]
+    days_of_week: list[str]
 
 
 class EventsIO:

{gshock_api-2.0.32 → gshock_api-2.0.35}/src/gshock_api/iolib/time_io.py

@@ -27,7 +27,7 @@ class TimeIO:
                 "offset": offset,  # must always be an integer
             },
         }
-        await connection.sendMessage(json.dumps(message))
+        await connection.send_message(json.dumps(message))
 
     @staticmethod
     async def send_to_watch_set(message: str) -> None:

{gshock_api-2.0.32 → gshock_api-2.0.35}/src/gshock_api/iolib/world_cities_io.py

@@ -10,9 +10,9 @@ class WorldCitiesIO:
     connection: ConnectionProtocol | None = None
 
     @staticmethod
-    async def request(connection: ConnectionProtocol, cityNumber: int) -> CancelableResult[bytes]:
+    async def request(connection: ConnectionProtocol, city_number: int) -> CancelableResult[bytes]:
         WorldCitiesIO.connection = connection
-        key = f"1f0{cityNumber}"
+        key = f"1f0{city_number}"
         await connection.request(key)
 
         WorldCitiesIO.result = CancelableResult[bytes]()

gshock_api-2.0.35/src/gshock_api/logger.py

@@ -0,0 +1,46 @@
+import logging
+from typing import Final
+
+LogLevel: Final[int] = int
+
+_logger: logging.Logger = logging.getLogger(__name__)
+
+
+class Logger:
+    """
+    A simple wrapper around the standard Python logging module for consistent configuration.
+    """
+    DEFAULT_LOG_LEVEL: Final[LogLevel] = logging.INFO
+
+    def __init__(self, log_level: LogLevel = DEFAULT_LOG_LEVEL) -> None:
+        self.log_level = log_level
+
+        logging.basicConfig(
+            level=self.log_level,
+            handlers=[logging.StreamHandler()],
+            format="%(asctime)-15s %(name)-15s %(levelname)s: %(message)s",
+        )
+
+    def _join(self, *args: object) -> str:
+        """Join args like print() does."""
+        return " ".join(str(a) for a in args)
+
+    # Logging methods -----------
+
+    def error(self, *args: object) -> None:
+        _logger.error(self._join(*args))
+
+    def info(self, *args: object) -> None:
+        _logger.info(self._join(*args))
+
+    def debug(self, *args: object) -> None:
+        _logger.debug(self._join(*args))
+
+    def warn(self, *args: object) -> None:
+        _logger.warning(self._join(*args))
+
+    def warning(self, *args: object) -> None:
+        _logger.warning(self._join(*args))
+
+
+logger: Logger = Logger()

{gshock_api-2.0.32 → gshock_api-2.0.35}/src/gshock_api/scanner.py

@@ -24,10 +24,10 @@ MAX_SCAN_RETRIES: Final[int] = 60
 # --- Type Aliases ---
 
 # WatchFilter is a function that takes a BLEDevice name (str) and returns a boolean.
-WatchFilter: Final[Callable[[str], bool]] = Callable[[str], bool]
+type WatchFilter = Callable[[str], bool] | None
 
 # Type for the filter used in find_device_by_filter (takes device and ad data, returns bool)
-BleakDeviceFilter: Final[Callable[[BLEDevice, AdvertisementData], bool]] = Callable[[BLEDevice, AdvertisementData], bool]
+type BleakDeviceFilter = Callable[[BLEDevice, AdvertisementData], bool]
 
 
 class Scanner:
@@ -38,8 +38,7 @@ class Scanner:
     async def scan(
         self,
         device_address: str | None = None,
-        # Replaced the untyped watch_filter=None with a properly typed Callable or None
-        watch_filter: WatchFilter | None = None, # type: ignore
+        watch_filter: WatchFilter = None,
         max_retries: int = MAX_SCAN_RETRIES
     ) -> BLEDevice | None: