crcutil 2.1.2__tar.gz → 2.2.0__tar.gz

{crcutil-2.1.2/src/crcutil.egg-info → crcutil-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crcutil
-Version: 2.1.2
+Version: 2.2.0
 Author-email: Carlos Florez <carlos@florez.co.uk>
 Maintainer-email: Carlos Florez <carlos@florez.co.uk>
 License: MIT License
@@ -41,6 +41,7 @@ Requires-Dist: colorlog==6.10.1
 Requires-Dist: pynput==1.8.1
 Requires-Dist: python-xlib==0.33
 Requires-Dist: evdev==1.9.2; sys_platform == "linux"
+Requires-Dist: pyobjc-framework-AppKit==12.1; sys_platform == "darwin"
 Dynamic: license-file
 
 # CRCUtil
@@ -53,11 +54,12 @@ Portable CRC32 Checksum Tool – Generate & Compare
 ![CLI](https://img.shields.io/badge/Interface-CLI-important)
 
 > [!NOTE]
-> Installation is supported only for the following: 
+> Installation is supported for the following: 
 > - Windows (amd64)
 > - Linux (amd64)
 >    - X11
 >    - Wayland
+> - MacOS (arm64)
 
 
 ## Table of Contents
@@ -67,6 +69,7 @@ Portable CRC32 Checksum Tool – Generate & Compare
   * [crc](#crc)
   * [diff](#diff)
   * [pause/resume](#pauseresume)
+* [Logs](#logs)
 * [Development](#development)
 
 ## Installation
@@ -87,6 +90,15 @@ sudo usermod -aG input $USER
 sudo pkill -u $USER
 ```
 
+### MacOS
+> [!NOTE]
+> - Enable Accesibility Access for the Terminal on System Settings > Privacy & Security > Accessibility
+> - This makes it possible in MacOS to track keyboard presses; necessary for the playback controls
+
+```bash
+pip install crcutil
+```
+
 ## Usage
 
 ### crc
@@ -124,22 +136,30 @@ crcutil diff -l 'C:\crc1.json' 'C:\crc2.json' -o 'C:\diff.json'
     - p
         - Windows
         - Linux (X11)
+        - MacOS
     - alt+p
         - Linux (Wayland)
 - The tool can be exited at any time by pressing:
     - q
         - Windows
         - Linux (X11)
+        - MacOS
     - alt+q
         - Linux (Wayland)
 
+## Logs
+
+> [!NOTE]
+> Logs can be found in:
+> - Windows -> C:\Users\User\Documents\crcutil\log
+> - Linux -> $XDG_STATE_HOME/crcutil/log
+> - MacOS -> /Library/Application Support/crcutil/log
+
 ## Development
 
 > [!NOTE]
-> Development requires a fully configured [Dotfiles](https://github.com/florez-carlos/dotfiles) dev environment <br>
+> Only Ubuntu environments supported
 
 ```bash
 source init.sh
 ```
-
-

{crcutil-2.1.2 → crcutil-2.2.0}/README.md

@@ -8,11 +8,12 @@ Portable CRC32 Checksum Tool – Generate & Compare
 ![CLI](https://img.shields.io/badge/Interface-CLI-important)
 
 > [!NOTE]
-> Installation is supported only for the following: 
+> Installation is supported for the following: 
 > - Windows (amd64)
 > - Linux (amd64)
 >    - X11
 >    - Wayland
+> - MacOS (arm64)
 
 
 ## Table of Contents
@@ -22,6 +23,7 @@ Portable CRC32 Checksum Tool – Generate & Compare
   * [crc](#crc)
   * [diff](#diff)
   * [pause/resume](#pauseresume)
+* [Logs](#logs)
 * [Development](#development)
 
 ## Installation
@@ -42,6 +44,15 @@ sudo usermod -aG input $USER
 sudo pkill -u $USER
 ```
 
+### MacOS
+> [!NOTE]
+> - Enable Accesibility Access for the Terminal on System Settings > Privacy & Security > Accessibility
+> - This makes it possible in MacOS to track keyboard presses; necessary for the playback controls
+
+```bash
+pip install crcutil
+```
+
 ## Usage
 
 ### crc
@@ -79,22 +90,30 @@ crcutil diff -l 'C:\crc1.json' 'C:\crc2.json' -o 'C:\diff.json'
     - p
         - Windows
         - Linux (X11)
+        - MacOS
     - alt+p
         - Linux (Wayland)
 - The tool can be exited at any time by pressing:
     - q
         - Windows
         - Linux (X11)
+        - MacOS
     - alt+q
         - Linux (Wayland)
 
+## Logs
+
+> [!NOTE]
+> Logs can be found in:
+> - Windows -> C:\Users\User\Documents\crcutil\log
+> - Linux -> $XDG_STATE_HOME/crcutil/log
+> - MacOS -> /Library/Application Support/crcutil/log
+
 ## Development
 
 > [!NOTE]
-> Development requires a fully configured [Dotfiles](https://github.com/florez-carlos/dotfiles) dev environment <br>
+> Only Ubuntu environments supported
 
 ```bash
 source init.sh
 ```
-
-

{crcutil-2.1.2 → crcutil-2.2.0}/git-hooks/pre-commit

@@ -1,4 +1,4 @@
 #!/bin/bash
-shellcheck source.init.sh
+shellcheck init.sh
 ruff check --fix
 ruff format

{crcutil-2.1.2 → crcutil-2.2.0}/init.sh

@@ -1,7 +1,9 @@
 #!/bin/bash
 
 color_red=$(tput setaf 1)
+# shellcheck disable=SC2034
 color_green=$(tput setaf 2)
+# shellcheck disable=SC2034
 color_yellow=$(tput setaf 3)
 color_normal=$(tput sgr0)
 setopt aliases

{crcutil-2.1.2 → crcutil-2.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "crcutil"
-version = "2.1.2"
+version = "2.2.0"
 requires-python = ">=3.11"
 authors = [
   {name = "Carlos Florez", email = "carlos@florez.co.uk"}
@@ -30,6 +30,7 @@ dependencies = [
   "pynput==1.8.1",
   "python-xlib==0.33",
   "evdev==1.9.2;sys_platform == 'linux'",
+  "pyobjc-framework-AppKit==12.1;sys_platform == 'darwin'",
 ]
 
 [project.scripts]

{crcutil-2.1.2 → crcutil-2.2.0}/requirements.txt

@@ -6,4 +6,5 @@ jsonschema==4.25.1
 colorlog==6.10.1
 pynput==1.8.1
 python-xlib==0.33
-evdev==1.9.2
+evdev==1.9.2;sys_platform == 'linux'
+pyobjc-framework-AppKit==12.1;sys_platform == 'darwin'

{crcutil-2.1.2 → crcutil-2.2.0}/src/crcutil/core/checksum_manager.py

@@ -182,9 +182,7 @@ class ChecksumManager:
                 description = f"Playback controls disabled: {e}"
                 CrcutilLogger.get_console_logger().warning(description)
 
-            length = (
-                total_count if total_count else len(str_relative_locations)
-            )
+            length = total_count or len(str_relative_locations)
             with alive_bar(length, dual_line=True) as bar:
                 if total_count:
                     offset_count = total_count - len(str_relative_locations)

crcutil-2.2.0/src/crcutil/core/keyboard_monitor_darwin.py

@@ -0,0 +1,86 @@
+from __future__ import annotations
+
+import platform
+
+from pynput import keyboard
+
+from crcutil.core.keyboard_monitor import KeyboardMonitor
+from crcutil.util.crcutil_logger import CrcutilLogger
+
+
+class KeyboardMonitorDarwin(KeyboardMonitor):
+    def __init__(self) -> None:
+        self.is_paused = False
+        self.is_quit = False
+        self.listener = None
+        self.pause_description = "\n*Press p to pause/resume"
+        self.quit_description = "*Press q to quit"
+
+    def start(self) -> None:
+        self.is_paused = False
+        self.is_quit = False
+        self.listener = keyboard.Listener(on_press=self.__on_press)
+        self.listener.start()
+
+    def stop(self) -> None:
+        self.is_paused = False
+        self.is_quit = True
+        if self.listener:
+            self.listener.stop()
+
+    def get_pause_message(self) -> str:
+        return self.pause_description
+
+    def get_quit_message(self) -> str:
+        return self.quit_description
+
+    def is_listen_quit(self) -> bool:
+        return self.is_quit
+
+    def is_listen_paused(self) -> bool:
+        return self.is_paused
+
+    def __on_press(self, key: keyboard.Key | keyboard.KeyCode | None) -> None:
+        try:
+            if self.is_terminal_focused():
+                if key == keyboard.KeyCode.from_char("p"):
+                    self.is_paused = not self.is_paused
+                if key == keyboard.KeyCode.from_char("q"):
+                    self.stop()
+        except AttributeError:
+            pass
+
+    def is_terminal_focused(self) -> bool:
+        try:
+            if platform.system() == "Darwin":
+                from AppKit import (  # noqa: PLC0415  # pyright: ignore[reportMissingImports]
+                    NSWorkspace,
+                )
+
+                active_app = NSWorkspace.sharedWorkspace().activeApplication()
+                bundle_id: str = active_app.get(
+                    "NSApplicationBundleIdentifier", ""
+                )
+                name: str = active_app.get("NSApplicationName", "")
+                return bundle_id.startswith(
+                    (
+                        "com.apple.Terminal",
+                        "com.googlecode.iterm2",
+                        "io.alacritty",
+                        "net.kovidgoyal.kitty",
+                        "com.mitchellh.ghostty",
+                    )
+                ) or name.lower() in (
+                    "terminal",
+                    "iterm2",
+                    "alacritty",
+                    "kitty",
+                    "ghostty",
+                    "warp",
+                    "hyper",
+                )
+        except Exception as e:  # noqa: BLE001
+            message = f"Could not probe for window focus: {e!s}"
+            CrcutilLogger.get_logger().debug(message)
+            return False
+        return False

{crcutil-2.1.2 → crcutil-2.2.0}/src/crcutil/core/keyboard_monitor_factory.py

@@ -25,6 +25,13 @@ class KeyboardMonitorFactory(Static):
             )
 
             return KeyboardMonitorWindows()
+
+        elif system == "Darwin":
+            from crcutil.core.keyboard_monitor_darwin import (  # noqa:PLC0415
+                KeyboardMonitorDarwin,
+            )
+
+            return KeyboardMonitorDarwin()
         elif system == "Linux":
             session = os.getenv("XDG_SESSION_TYPE") or ""
 

{crcutil-2.1.2 → crcutil-2.2.0}/src/crcutil/util/file_importer.py

@@ -9,7 +9,6 @@ if TYPE_CHECKING:
 
 import ctypes.wintypes
 import json
-import os
 import platform
 from datetime import UTC, datetime, timedelta
 from pathlib import Path
@@ -195,7 +194,9 @@ class FileImporter(Static):
                     description = "Could not locate Documents folder"
                     raise FileNotFoundError(description)  # noqa: TRY301
             elif system == "Linux":
-                home_folder = os.getenv("HOME") or ""
+                home_folder = Path.home() / ".local/state"
+            elif system == "Darwin":
+                home_folder = Path.home() / "Library/Application Support"
             else:
                 description = f"Unsupported OS: {system}"
                 raise OSError(description)  # noqa: TRY301

{crcutil-2.1.2 → crcutil-2.2.0/src/crcutil.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crcutil
-Version: 2.1.2
+Version: 2.2.0
 Author-email: Carlos Florez <carlos@florez.co.uk>
 Maintainer-email: Carlos Florez <carlos@florez.co.uk>
 License: MIT License
@@ -41,6 +41,7 @@ Requires-Dist: colorlog==6.10.1
 Requires-Dist: pynput==1.8.1
 Requires-Dist: python-xlib==0.33
 Requires-Dist: evdev==1.9.2; sys_platform == "linux"
+Requires-Dist: pyobjc-framework-AppKit==12.1; sys_platform == "darwin"
 Dynamic: license-file
 
 # CRCUtil
@@ -53,11 +54,12 @@ Portable CRC32 Checksum Tool – Generate & Compare
 ![CLI](https://img.shields.io/badge/Interface-CLI-important)
 
 > [!NOTE]
-> Installation is supported only for the following: 
+> Installation is supported for the following: 
 > - Windows (amd64)
 > - Linux (amd64)
 >    - X11
 >    - Wayland
+> - MacOS (arm64)
 
 
 ## Table of Contents
@@ -67,6 +69,7 @@ Portable CRC32 Checksum Tool – Generate & Compare
   * [crc](#crc)
   * [diff](#diff)
   * [pause/resume](#pauseresume)
+* [Logs](#logs)
 * [Development](#development)
 
 ## Installation
@@ -87,6 +90,15 @@ sudo usermod -aG input $USER
 sudo pkill -u $USER
 ```
 
+### MacOS
+> [!NOTE]
+> - Enable Accesibility Access for the Terminal on System Settings > Privacy & Security > Accessibility
+> - This makes it possible in MacOS to track keyboard presses; necessary for the playback controls
+
+```bash
+pip install crcutil
+```
+
 ## Usage
 
 ### crc
@@ -124,22 +136,30 @@ crcutil diff -l 'C:\crc1.json' 'C:\crc2.json' -o 'C:\diff.json'
     - p
         - Windows
         - Linux (X11)
+        - MacOS
     - alt+p
         - Linux (Wayland)
 - The tool can be exited at any time by pressing:
     - q
         - Windows
         - Linux (X11)
+        - MacOS
     - alt+q
         - Linux (Wayland)
 
+## Logs
+
+> [!NOTE]
+> Logs can be found in:
+> - Windows -> C:\Users\User\Documents\crcutil\log
+> - Linux -> $XDG_STATE_HOME/crcutil/log
+> - MacOS -> /Library/Application Support/crcutil/log
+
 ## Development
 
 > [!NOTE]
-> Development requires a fully configured [Dotfiles](https://github.com/florez-carlos/dotfiles) dev environment <br>
+> Only Ubuntu environments supported
 
 ```bash
 source init.sh
 ```
-
-

{crcutil-2.1.2 → crcutil-2.2.0}/src/crcutil.egg-info/SOURCES.txt

@@ -1,7 +1,6 @@
 .gitignore
 LICENSE
 README.md
-__init__.py
 init.sh
 pyproject.toml
 requirements.txt
@@ -22,6 +21,7 @@ src/crcutil/core/__init__.py
 src/crcutil/core/checksum.py
 src/crcutil/core/checksum_manager.py
 src/crcutil/core/keyboard_monitor.py
+src/crcutil/core/keyboard_monitor_darwin.py
 src/crcutil/core/keyboard_monitor_factory.py
 src/crcutil/core/keyboard_monitor_wayland.py
 src/crcutil/core/keyboard_monitor_windows.py

{crcutil-2.1.2 → crcutil-2.2.0}/src/crcutil.egg-info/requires.txt

@@ -6,6 +6,9 @@ colorlog==6.10.1
 pynput==1.8.1
 python-xlib==0.33
 
+[:sys_platform == "darwin"]
+pyobjc-framework-AppKit==12.1
+
 [:sys_platform == "linux"]
 evdev==1.9.2