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

{gshock_api-2.0.30/src/gshock_api.egg-info → gshock_api-2.0.32}/PKG-INFO

@@ -1,14 +1,29 @@
 Metadata-Version: 2.4
 Name: gshock_api
-Version: 2.0.30
+Version: 2.0.32
 Summary: Pythgon API for GShock Watches using BLE
 Home-page: https://github.com/pyscaffold/pyscaffold/
 Author: Ivo Zivkov
 Author-email: Ivo Zivkov <izivkov@gmail.com>
+License-Expression: MIT
+Project-URL: Documentation, https://github.com/izivkov/gshock_api
 Platform: any
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.12
 Description-Content-Type: text/x-rst
 License-File: LICENSE.txt
-Requires-Dist: requests
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: types-requests
+Requires-Dist: python-dotenv
+Requires-Dist: typing-extensions>=4.12
+Provides-Extra: dev
+Requires-Dist: basedpyright>=1.31.7; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: gitingest; extra == "dev"
+Requires-Dist: poethepoet; extra == "dev"
+Requires-Dist: radon; extra == "dev"
+Requires-Dist: vulture; extra == "dev"
 Dynamic: license-file
 
 gshock_api

gshock_api-2.0.32/pyproject.toml

@@ -0,0 +1,290 @@
+# ============================================================
+# ULTRA-STRICT PYTHON PROJECT TEMPLATE
+# Maximum strictness - TypeScript strict mode equivalent
+# Tools: uv + ruff + basedpyright + pydantic v2
+# Python 3.12+
+# ============================================================
+
+[build-system]
+requires = ["setuptools>=61.0"]
+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"
+authors = [{ name = "Ivo Zivkov", email = "izivkov@gmail.com" }]
+
+license = "MIT"
+license-files = ["LICEN[CS]E*"]
+
+readme = "README.rst"
+requires-python = ">=3.12"
+dependencies = [
+    "pydantic>=2.0.0",
+    "types-requests",
+    "python-dotenv",
+    "typing-extensions>=4.12",
+]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Programming Language :: Python :: 3",
+]
+urls = { Documentation = "https://github.com/izivkov/gshock_api" }
+
+[project.scripts]
+gshock_server = "examples.gshock_server:main"
+
+[project.optional-dependencies]
+dev = [
+    "basedpyright>=1.31.7",
+    "ruff",
+    "gitingest",
+    "poethepoet",
+    "radon",
+    "vulture"
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+# ============================================================
+# POE THE POET - Task Runner
+# ============================================================
+[tool.poe.tasks]
+# Run with: poe format or uv run poe format
+# Formats code, fixes issues, and type checks
+format = [
+    {cmd = "ruff format ."},
+    {cmd = "ruff check . --fix"},
+    {cmd = "basedpyright --level error"}
+]
+
+# Run with: poe check
+# Lint and type check without fixing
+check = [
+    {cmd = "ruff check ."},
+    {cmd = "basedpyright --level error"}
+]
+
+# Run with: poe lint or uv run poe lint
+# Only linting, no type checking
+lint = {cmd = "ruff check . --fix"}
+
+# Run with: poe lint-unsafe or uv run poe lint-unsafe
+# Lint with unsafe fixes enabled (more aggressive)
+lint-unsafe = {cmd = "ruff check . --fix --unsafe-fixes"}
+
+# Run with: poe metrics or uv run poe metrics
+# Check code quality: dead code, complexity, and maintainability
+metrics = [
+    {cmd = "vulture . --min-confidence 80"},
+    {cmd = "radon cc . -a -nb"},
+    {cmd = "radon mi . -nb"}
+]
+
+# Run with: poe quality or uv run poe quality
+# Full quality check: format, lint, type check, and metrics
+quality = [
+    {cmd = "ruff format ."},
+    {cmd = "ruff check . --fix"},
+    {cmd = "basedpyright --level error"},
+    {cmd = "vulture . --min-confidence 80 --exclude .venv,build,dist,docs,scripts,tests"},
+    {cmd = "radon cc . -a -nb"}
+]
+
+# ============================================================
+# RUFF CONFIGURATION - MAXIMUM STRICTNESS
+# ============================================================
+[tool.ruff]
+target-version = "py312"
+line-length = 88
+indent-width = 4
+fix = true
+show-fixes = true
+
+[tool.ruff.lint]
+# Comprehensive rule set for strict checking
+select = [
+    "E",      # pycodestyle errors
+    "F",      # pyflakes
+    "I",      # isort
+    "UP",     # pyupgrade
+    "B",      # flake8-bugbear
+    "C4",     # flake8-comprehensions
+    "T20",    # flake8-print (no print statements)
+    "SIM",    # flake8-simplify
+    "N",      # pep8-naming
+    "Q",      # flake8-quotes
+    "RUF",    # Ruff-specific rules
+    "ASYNC",  # flake8-async
+    "S",      # flake8-bandit (security)
+    "PTH",    # flake8-use-pathlib
+    "ERA",    # eradicate (commented-out code)
+    "PL",     # pylint
+    "PERF",   # perflint (performance)
+    "ANN",    # flake8-annotations
+    "ARG",    # flake8-unused-arguments
+    "RET",    # flake8-return
+    "TCH",    # flake8-type-checking
+]
+
+ignore = [
+    "E501",    # Line too long (formatter handles this)
+    "S603",    # subprocess without shell=True (too strict)
+    "S607",    # Starting a process with a partial path (too strict)
+]
+
+# Per-file ignores
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = [
+    "F401",    # Allow unused imports in __init__.py
+]
+"tests/**/*.py" = [
+    "S101",    # Allow assert in tests
+    "PLR2004", # Allow magic values in tests
+    "ANN",     # Don't require annotations in tests
+]
+
+[tool.ruff.lint.isort]
+known-first-party = ["gshock_api"]  # CHANGE THIS
+combine-as-imports = true
+force-sort-within-sections = true
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ruff.lint.flake8-type-checking]
+strict = true
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+
+# ============================================================
+# Basedpyright CONFIGURATION - MAXIMUM STRICTNESS
+# TypeScript strict mode equivalent
+# ============================================================
+[tool.basedpyright]
+pythonVersion = "3.12"
+typeCheckingMode = "strict"
+
+# ============================================================
+# IMPORT AND MODULE CHECKS
+# ============================================================
+reportMissingImports = true
+reportMissingTypeStubs = true  # Stricter: require type stubs
+reportUndefinedVariable = true
+reportAssertAlwaysTrue = true
+reportInvalidStringEscapeSequence = true
+
+# ============================================================
+# STRICT NULL SAFETY (like TS strictNullChecks)
+# ============================================================
+reportOptionalSubscript = true
+reportOptionalMemberAccess = true
+reportOptionalCall = true
+reportOptionalIterable = true
+reportOptionalContextManager = true
+reportOptionalOperand = true
+reportAny = true  # Prohibir Any completamente
+reportExplicitAny = true
+reportIgnoreCommentWithoutRule = false  # No permitir # type: ignore sin código
+reportPrivateLocalImportUsage = true
+reportUnnecessaryTypeAnnotation = true  # Detectar anotaciones redundantes
+
+# ============================================================
+# TYPE COMPLETENESS (like TS noImplicitAny + strictFunctionTypes)
+# ============================================================
+reportMissingParameterType = true
+reportMissingTypeArgument = true
+reportUnknownParameterType = true
+reportUnknownLambdaType = true
+reportUnknownArgumentType = true   # STRICT: Enable (can be noisy)
+reportUnknownVariableType = true   # STRICT: Enable (can be noisy)
+reportUnknownMemberType = true     # STRICT: Enable (can be noisy)
+reportUntypedFunctionDecorator = true
+reportUntypedClassDecorator = true
+reportUntypedBaseClass = true
+reportUntypedNamedTuple = true
+
+# ============================================================
+# CLASS AND INHERITANCE CHECKS
+# ============================================================
+reportIncompatibleMethodOverride = true
+reportIncompatibleVariableOverride = true
+reportInconsistentConstructor = true
+reportUninitializedInstanceVariable = true
+reportOverlappingOverload = true
+reportMissingSuperCall = true  # STRICT: Enable
+
+# ============================================================
+# CODE QUALITY (like TS noUnusedLocals + noUnusedParameters)
+# ============================================================
+reportPrivateUsage = true
+reportConstantRedefinition = true
+reportInvalidStubStatement = true
+reportIncompleteStub = true
+reportUnsupportedDunderAll = true
+reportUnusedClass = "error"        # STRICT: Error instead of warning
+reportUnusedFunction = "error"     # STRICT: Error instead of warning
+reportUnusedVariable = "error"     # STRICT: Error instead of warning
+reportUnusedImport = "error"       # STRICT: Error instead of warning
+reportDuplicateImport = "error"    # STRICT: Error instead of warning
+
+# ============================================================
+# UNNECESSARY CODE DETECTION
+# ============================================================
+reportUnnecessaryIsInstance = "error"         # STRICT: Error
+reportUnnecessaryCast = "error"               # STRICT: Error
+reportUnnecessaryComparison = "error"         # STRICT: Error
+reportUnnecessaryContains = "error"           # STRICT: Error
+reportUnnecessaryTypeIgnoreComment = "error"  # STRICT: Error
+
+# ============================================================
+# FUNCTION/METHOD SIGNATURE STRICTNESS
+# ============================================================
+reportGeneralTypeIssues = true
+reportPropertyTypeMismatch = true
+reportFunctionMemberAccess = true
+reportCallInDefaultInitializer = true
+reportImplicitStringConcatenation = true  # STRICT: Enable
+
+# ============================================================
+# ADDITIONAL STRICT CHECKS (Progressive Enhancement)
+# ============================================================
+reportImplicitOverride = true    # STRICT: Require @override decorator (Python 3.12+)
+reportShadowedImports = true     # STRICT: Detect shadowed imports
+reportDeprecated = "warning"     # Warn on deprecated usage
+
+# ============================================================
+# ADDITIONAL TYPE CHECKS
+# ============================================================
+reportImportCycles = "warning"
+
+# ============================================================
+# EXCLUSIONS
+# ============================================================
+exclude = [
+    "**/__pycache__",
+    "**/node_modules",
+    ".git",
+    ".mypy_cache",
+    ".pyright_cache",
+    ".ruff_cache",
+    ".pytest_cache",
+    ".venv",
+    "venv",
+    "env",
+    "logs",
+    "output",
+    "data",
+    "build",
+    "dist",
+    "*.egg-info",
+]
+
+venvPath = "."
+venv = ".venv"

gshock_api-2.0.32/setup.py

@@ -0,0 +1,17 @@
+from setuptools import find_packages, setup
+
+setup(
+    name="gshock_api",
+    version="2.0.31",
+    package_dir={"": "src"},
+    packages=find_packages(where="src"),
+    install_requires=[
+        "pytz",
+        "bleak>=1.0.1",
+    ],
+    entry_points={
+        "console_scripts": [
+            "gshock_server=examples.gshock_server:main",
+        ],
+    },
+)

gshock_api-2.0.32/src/examples/api_tests.py

@@ -0,0 +1,218 @@
+import asyncio
+from collections.abc import Sequence
+from datetime import datetime
+import json
+import sys
+import time
+from typing import Optional
+
+import pytz
+
+from gshock_api.always_connected_watch_filter import (
+    always_connected_watch_filter as watch_filter,
+)
+from gshock_api.app_notification import AppNotification, NotificationType
+from gshock_api.connection import Connection
+from gshock_api.event import Event, RepeatPeriod, create_event_date
+from gshock_api.exceptions import GShockConnectionError
+from gshock_api.gshock_api import GshockAPI
+from gshock_api.logger import logger
+
+
+async def main(argv: Sequence[str]) -> None:
+    await run_api_tests(argv)
+
+def prompt() -> None:
+    logger.info(
+        "========================================================================"
+    )
+    logger.info(
+        "Press and hold lower-left button on your watch for 3 seconds to start..."
+    )
+    logger.info(
+        "========================================================================"
+    )
+    logger.info("")
+
+
+async def run_api_tests(argv: Sequence[str]) -> None:  # noqa: PLR0915
+    prompt()
+
+    try:
+        logger.info("Waiting for connection...")
+        connection = Connection()
+        await connection.connect(watch_filter.connection_filter)
+        logger.info("Connected...")
+
+        api = GshockAPI(connection)
+
+        app_info = await api.get_app_info()
+        logger.info(f"app info: {app_info}")
+
+        pressed_button = await api.get_pressed_button()
+        logger.info(f"pressed button: {pressed_button}")
+
+        watch_name = await api.get_watch_name()
+        logger.info(f"got watch name: {watch_name}")
+
+        await api.set_time(time.time() + 10 * 60)
+
+        alarms = await api.get_alarms()
+        logger.info(f"alarms: {alarms}")
+
+        alarms[3]["enabled"] = True
+        alarms[3]["hour"] = 7
+        alarms[3]["minute"] = 25
+        alarms[3]["enabled"] = False
+        await api.set_alarms(alarms)
+
+        seconds = await api.get_timer()
+        logger.info(f"timer: {seconds} seconds")
+
+        await api.set_timer(seconds + 10)
+        time_adjstment = await api.get_time_adjustment()
+        logger.info(f"time_adjstment: {time_adjstment}")
+
+        await api.set_time_adjustment(time_adjustement=True, minutes_after_hour=10)
+
+        condition = await api.get_watch_condition()
+        logger.info(f"condition: {condition}")
+
+        settings_local = await api.get_basic_settings()
+        logger.info(f"settings: {settings_local}")
+
+        settings_local["button_tone"] = True
+        settings_local["language"] = "Russian"
+        settings_local["time_format"] = "24h"
+
+        await api.set_settings(settings_local)
+        settings_local = await api.get_basic_settings()
+        await app_notifications(api)
+
+        # Create a single event
+        tz = pytz.timezone("America/Toronto")
+        dt = datetime.now()
+        utc_timestamp = dt.timestamp()
+        event_date = create_event_date(utc_timestamp, tz)
+        event_date_str = json.dumps(event_date.__dict__)
+        event_json_str = (
+            """{"title":"Test Event", "time":{"selected":\""""
+            + str(False)
+            + """\", "enabled":\""""
+            + str(True)
+            + """\", "repeat_period":\""""
+            + str(RepeatPeriod.WEEKLY)
+            + """\","days_of_week":\""""
+            + "MONDAY"
+            + """\", "start_date":"""
+            + event_date_str
+            + """, "end_date":"""
+            + event_date_str
+            + """}}"""
+        )
+        Event().create_event(json.loads(event_json_str))
+        logger.info(f"Created event: {event_json_str}")
+
+        reminders = await api.get_reminders()
+        for reminder in reminders:
+            logger.info(f"reminder: {reminder}")
+
+        reminders[3]["title"] = "Test Event"
+
+        await api.set_reminders(reminders)
+
+    except GShockConnectionError as e:
+        logger.info(f"Connection problem: {e}")
+
+    input("Hit any key to disconnect")
+
+    await connection.disconnect()
+    logger.info("--- END OF TESTS ---")
+
+
+async def run_api_tests_notifications() -> None:
+    prompt()
+
+    connection = Connection()
+    await connection.connect()
+
+    api = GshockAPI(connection)
+
+    await app_notifications(api)
+
+    input("Hit any key to disconnect")
+
+    await connection.disconnect()
+    logger.info("--- END OF TESTS ---")
+
+
+async def app_notifications(api: GshockAPI) -> None:
+    AppNotification(
+        type=NotificationType.CALENDAR,
+        timestamp="20231001T121000",
+        app="Calendar",
+        title="This is a very long Meeting with Team",
+        text=" 9:20 - 10:15 AM",
+    )
+
+    AppNotification(
+        type=NotificationType.CALENDAR,
+        timestamp="20250516T233000",
+        app="Calendar",
+        title="Full day event 3",
+        text="Tomorrow",
+    )
+
+    email_notification2 = AppNotification(
+        type=NotificationType.EMAIL_SMS,
+        timestamp="20250516T211520",
+        app="Gmail",
+        title="me",
+        text="""[translate:彼女はピア
+彼女はピアノを弾いたり、絵を描くのが好きです。リア充です
+彼女はピア
+彼女はピアノを弾いたり、絵を描くのが好きです。リア充です
+彼女はピア
+彼女はピアノを弾いたり、絵を描くのが好きです。リア充です
+]""",
+        short_text="""[translate:彼女はピア
+彼女はピアノを弾いたり、絵を描くのが好きです。リア充です
+彼女はピア
+彼女はピアノを弾いたり、絵を描くのが好きです。リア充です
+彼女はピア
+彼女はピアノを弾いたり、絵を描くのが好きです。リア充です
+]""",
+    )
+
+    AppNotification(
+        type=NotificationType.EMAIL_SMS,
+        timestamp="20250516T211520",
+        app="Gmail",
+        title="me",
+        text="[translate:الساعة\n]",
+    )
+
+    AppNotification(
+        type=NotificationType.EMAIL,
+        timestamp="20231001T120000",
+        app="EmailApp",
+        title="Ivo",
+        short_text="""And this is a short message up to 40 chars""",
+        text="This is the message up to 193 characters, combined up to 206 characters",
+    )
+
+    await api.send_app_notification(email_notification2)
+
+
+def convert_time_string_to_epoch(time_string: str) -> Optional[float]:
+    try:
+        time_object = datetime.strptime(time_string, "%H:%M:%S")
+        timestamp = time_object.timestamp()
+        return timestamp
+    except ValueError:
+        logger.info("Invalid time format. Please use the format HH:MM:SS.")
+        return None
+
+
+if __name__ == "__main__":
+    asyncio.run(main(sys.argv[1:]))

gshock_api-2.0.32/src/examples/app_notifications_tests.py

@@ -0,0 +1,47 @@
+from gshock_api.iolib.app_notification_io import AppNotificationIO
+
+bufferSMS = "fdfffffffffef9cdcfcdcacfcaceccabcec7cfcdcdcef7ffb29a8c8c9e989a8cf1ffd7cbcec9d6dfc7ccccd2cdcfc8c7ffffe6ffab97968cdf968cdf9edf8c96928f939adf929a8c8c9e989adf"
+bufferSMS_2 = "fcfffffffffef9cdcfcdcacfcaceccabcec7cfcdcac6f7ffb29a8c8c9e989a8cf1ffd7cbcec9d6dfc7ccccd2cdcfc8c7fffff4ffbe91908b979a8ddf90919a"
+bufferGmail = "fffffffffffef9cdcfcdcacfcaceceabcfc8cbcccecffaffb8929e9693fdff929affff05ffab97968cdf968cdf9edf899a8d86df93909198df8c8a9d959a9c8bd1dfb29e86899adf9a899a91df8b9090df93909198d1dfbd8a8bdf979a8d9adf968bdf968cd1d1d1f5a8979e8bdf968cdf968bc0f5b6df8b97969194df889adf9c9e91df9b90df9d9a8b8b9a8ddf8b979e91df8b979adf909999969c969e93dfbc9e8c9690dfb8d2ac97909c94dfbe8f8fdedfab97968cdf9e8f8fdf8f8d9089969b9a8cdf8b979adf999093939088969198df9a878b8d9edf999a9e8b8a8d9a8cc5f5ac9a8b8cdf889e8b9c97d88cdf8d9a9296919b"
+bufferGmailJapanese = "fefffffffffef9cdcfcdcacfcacec9abcdcececacdcffaffb8929e9693fdff929affff9aff1a42431a5a4c1c7e501c7c6b1c7d5df51a42431a5a4c1c7e501c7c6b1c7d5d1c7c711c7d6d1a43411c7e7b1c7e601c7d751c7f7e184a4a1c7d6d1970701c7e701c7e511c7e731a5a421c7e721c7e581c7e661c7f7d1c7c551c7d5d1a7a7a1c7e581c7e66f5"
+bufferCalendar = "f7fffffffffefacdcfcdcacfcaceceabcdcdcecfcfcff7ffbc9e939a919b9e8debff1d7f711d7f55b0919ad28b96929a1d7f531d7f71ffffe1ff1d7f711d7f55cecfc5cbcfdf1d7f6cdfcecec5cbcfdfafb21d7f531d7f71"
+bufferCalendar2 = "f9fffffffffefacdcfcdcacfcaceceabcdcdcfc6cfcbf7ffbc9e939a919b9e8ddaff1d7f711d7f55b290919b9e86dfba899a8d86df889a9a94df99908d9a899a8d1d7f531d7f71ffffe1ff1d7f711d7f55cecfc5cccfdf1d7f6cdfcecec5cccfdfafb21d7f531d7f71"
+bufferAllDayEvent = "fdfffffffffefacdcfcdcacfcacec9abcdcccccfcfcff7ffbc9e939a919b9e8de3ff1d7f711d7f55b98a9393df9b9e86df9a899a918bdfcc1d7f531d7f71ffffebff1d7f711d7f55ab9092908d8d90881d7f531d7f71"  # noqa: N816
+
+
+def format_hex_string(hexstr):
+    """Format a hex string into space-separated bytes."""
+    return " ".join(hexstr[i : i + 2] for i in range(0, len(hexstr), 2))
+
+
+# Example usage
+input_hex_2 = AppNotificationIO.xor_decode_buffer(bufferGmailJapanese).hex()
+buf = bytes.fromhex(input_hex_2)
+
+
+notification = AppNotificationIO.decode_notification_packet(buf)
+print(notification)
+
+
+rebuilt_buf = AppNotificationIO.encode_notification_packet(notification)
+
+
+def compare_buffers(buf1: bytes, buf2: bytes):
+    min_len = min(len(buf1), len(buf2))
+    for i in range(min_len):
+        if buf1[i] != buf2[i]:
+            print(f"Difference at byte {i}:")
+            print(f"  buf1: {buf1[i]:02x}")
+            print(f"  buf2: {buf2[i]:02x}")
+            print(f"  Context buf1: ... {buf1[max(0,i-5):i+5].hex()} ...")
+            print(f"  Context buf2: ... {buf2[max(0,i-5):i+5].hex()} ...")
+            break
+    else:
+        if len(buf1) != len(buf2):
+            print(f"Buffers have different lengths: {len(buf1)} vs {len(buf2)}")
+        else:
+            print("No differences found.")
+
+
+# Usage:
+compare_buffers(rebuilt_buf, buf)

gshock_api-2.0.32/src/examples/args.py

@@ -0,0 +1,28 @@
+import argparse
+import sys
+
+
+class Args:
+    def __init__(self):
+        self.parse_and_store(sys.argv[1:])
+
+    def parse_and_store(self, args):
+        parser = argparse.ArgumentParser(description="Parser")
+
+        parser.add_argument(
+            "--fine-adjustment-secs",
+            type=int,
+            choices=range(-10, 11),
+            default=0,
+            help="Fine adjustment in seconds to add/subtract when setting time (-10 to 10)"
+        )
+        parser.add_argument(
+            "-l", "--log_level", default="INFO", help="Sets log level", required=False
+        )
+        self.args = parser.parse_args(args)
+
+    def get(self):
+        return self.args
+
+
+args = Args()