tacklebox-cli 0.2.2__tar.gz → 0.2.4__tar.gz

{tacklebox_cli-0.2.2 → tacklebox_cli-0.2.4}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
 Name: tacklebox-cli
-Version: 0.2.2
+Version: 0.2.4
 Summary: A small collection of CLI utilities.
 Project-URL: Homepage, https://c.csw.im/cswimr/tacklebox
 Project-URL: Issues, https://c.csw.im/cswimr/tacklebox/issues
-Project-URL: source_archive, https://c.csw.im/cswimr/tacklebox/archive/a338ec567b0358a40fa7ca3bd3504309a5046ba1.tar.gz
+Project-URL: source_archive, https://c.csw.im/cswimr/tacklebox/archive/d808a4b8b4f6e697fae111ad82ffa49b4d44e668.tar.gz
 Author-email: cswimr <seaswimmerthefsh@gmail.com>
 License: The MIT License (MIT)
         =====================
@@ -34,11 +34,10 @@ License: The MIT License (MIT)
 License-File: LICENSE.md
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Requires-Python: >=3.10
+Requires-Python: >=3.11
 Requires-Dist: desktop-notifier>=6.1.0
 Requires-Dist: platformdirs>=4.3.0
 Requires-Dist: zipline-py[cli]>=0.27.0
@@ -68,13 +67,13 @@ a
 Uses the [zipline.py](https://pypi.org/project/zipline-py/) library alongside KDE's [Spectacle](https://invent.kde.org/plasma/spectacle) application to take a screenshot or screen recording and automatically upload it to a [Zipline](https://github.com/diced/zipline) instance. This automatically reads Spectacle's configuration files to determine file formats.
 
 ```bash
-$ tacklebox spectacle \ 
+$ tacklebox spectacle --mode region \ 
     --server "https://zipline.example.com" \ 
     --token "$(cat /file/containing/zipline/token)" \ 
     | tacklebox copy --trim
 
 # or to record a video
-$ tacklebox spectacle --record \ 
+$ tacklebox spectacle --mode region --record \ 
     --server "https://zipline.example.com" \ 
     --token "$(cat /file/containing/zipline/token)" \ 
     | tacklebox copy --trim

{tacklebox_cli-0.2.2 → tacklebox_cli-0.2.4}/README.md

@@ -22,13 +22,13 @@ a
 Uses the [zipline.py](https://pypi.org/project/zipline-py/) library alongside KDE's [Spectacle](https://invent.kde.org/plasma/spectacle) application to take a screenshot or screen recording and automatically upload it to a [Zipline](https://github.com/diced/zipline) instance. This automatically reads Spectacle's configuration files to determine file formats.
 
 ```bash
-$ tacklebox spectacle \ 
+$ tacklebox spectacle --mode region \ 
     --server "https://zipline.example.com" \ 
     --token "$(cat /file/containing/zipline/token)" \ 
     | tacklebox copy --trim
 
 # or to record a video
-$ tacklebox spectacle --record \ 
+$ tacklebox spectacle --mode region --record \ 
     --server "https://zipline.example.com" \ 
     --token "$(cat /file/containing/zipline/token)" \ 
     | tacklebox copy --trim

{tacklebox_cli-0.2.2 → tacklebox_cli-0.2.4}/pyproject.toml

@@ -3,12 +3,11 @@ name = "tacklebox-cli"
 description = "A small collection of CLI utilities."
 authors = [{ name = "cswimr", email = "seaswimmerthefsh@gmail.com" }]
 readme = "README.md"
-requires-python = ">=3.10"
+requires-python = ">=3.11"
 license = { file = "LICENSE.md" }
 classifiers = [
     "License :: OSI Approved :: MIT License",
     "Programming Language :: Python",
-    "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
@@ -21,7 +20,11 @@ dependencies = [
 dynamic = ["version", "urls"]
 
 [dependency-groups]
-dev = ["basedpyright==1.29.2", "ruff==0.11.12"]
+dev = [
+    "basedpyright==1.29.2",
+    "pyinstrument==5.0.2",
+    "ruff==0.11.12",
+]
 
 [project.scripts]
 tacklebox = "tacklebox.entrypoint:app"

{tacklebox_cli-0.2.2 → tacklebox_cli-0.2.4}/tacklebox/commands/spectacle.py

@@ -5,7 +5,7 @@ import subprocess
 import sys
 import tempfile
 from datetime import datetime, timezone
-from enum import IntEnum
+from enum import IntEnum, StrEnum
 from pathlib import Path
 from shutil import which
 from typing import Annotated
@@ -28,7 +28,7 @@ if not platform.system() == "Linux":
 app = Typer()
 
 
-class VideoFormats(IntEnum):
+class VideoFormat(IntEnum):
     """Because Spectacle is weird and doesn't just use file extensions for storing video formats 😭"""
 
     WEBM = 0
@@ -44,22 +44,71 @@ class VideoFormats(IntEnum):
         return self.name.lower()
 
 
-def _read_spectacle_config() -> tuple[str, VideoFormats]:
+def _read_spectacle_config() -> tuple[str, VideoFormat]:
     """Read the Spectacle config file and return the configured file formats."""
     path = Path(user_config_dir("spectaclerc"))
     if not path.exists():
-        return "png", VideoFormats.WEBM
+        return "png", VideoFormat.WEBM
 
-    config = configparser.ConfigParser()
+    config = configparser.ConfigParser(strict=False)
     config.read(path)
 
     preferred_image_format = config.get("ImageSave", "preferredImageFormat", fallback="png").lower()
 
-    preferred_video_format = VideoFormats(config.getint("VideoSave", "preferredVideoFormat", fallback=0))
+    preferred_video_format = VideoFormat(config.getint("VideoSave", "preferredVideoFormat", fallback=0))
 
     return preferred_image_format, preferred_video_format
 
 
+class SpectacleMode(StrEnum):
+    REGION = "region"
+    DESKTOP = "desktop"
+    MONITOR = "monitor"
+    WINDOW = "window"
+    ACTIVEWINDOW = "activewindow"
+    TRANSIENT = "transient"
+
+    @classmethod
+    def complete_format(cls, incomplete: str) -> list[tuple[str, str] | str]:
+        """Generate autocompletion strings for Typer."""
+        completions: list[tuple[str, str] | str] = []
+        for mode in SpectacleMode:
+            if mode.startswith(incomplete):
+                completions.append((mode, mode.completion_string) if mode.completion_string else mode)
+        return completions
+
+    @property
+    def completion_string(self) -> str | None:
+        argument = self.get_argument()
+        record_argument = self.get_argument(True)
+
+        completion_strings: dict[SpectacleMode, str] = {
+            SpectacleMode.REGION: f"Capture a retangular region of the desktop. ({argument} | {record_argument})",
+            SpectacleMode.DESKTOP: f"Capture the entire desktop (default). When recording, this will capture only the current monitor. ({argument} | {record_argument})",
+            SpectacleMode.MONITOR: f"Capture the current monitor. ({argument} | {record_argument})",
+            SpectacleMode.WINDOW: f"Capture the window currently under the cursor, including parents of pop-up menus. ({argument} | {record_argument})",
+            SpectacleMode.ACTIVEWINDOW: f"Capture the currently selected window. ({argument} | {record_argument})",
+            SpectacleMode.TRANSIENT: f"Capture the window currently under the cursor, excluding parents of pop-up menus. ({argument} | {record_argument})",
+        }
+
+        return completion_strings.get(self, None)
+
+    def get_argument(self, record: bool = False) -> str:
+        match self:
+            case SpectacleMode.REGION:
+                return "--record=region" if record else "--region"
+            case SpectacleMode.DESKTOP:
+                return "--record=screen" if record else "--fullscreen"
+            case SpectacleMode.MONITOR:
+                return "--record=screen" if record else "--current"
+            case SpectacleMode.WINDOW:
+                return "--record=window" if record else "--windowundercursor"
+            case SpectacleMode.ACTIVEWINDOW:
+                return "--record=window" if record else "--activewindow"
+            case SpectacleMode.TRANSIENT:
+                return "--record=window" if record else "--transientonly"
+
+
 @app.command(name="spectacle")
 @sync
 async def spectacle(
@@ -92,15 +141,22 @@ async def spectacle(
             ...,
             "--object/--text",
             "-o/-O",
-            default_factory=sys.stdout.isatty,
+            default_factory=lambda: bool(sys.stdout.isatty()),
             help=(
-                "Choose how to format the output. If --text (or piped),\n"
-                "you'll get a link to the uploaded file; if --object (or on a TTY),\n"
+                "Specify how to format the output. If --text (or piped), "
+                "you'll get a link to the uploaded file; if --object (or on a TTY), "
                 "you'll get the raw Python object."
             ),
+            envvar="ZIPLINE_PRINT_OBJECT",
         ),
     ],
-    record: Annotated[bool, Option("--record", "-r", help="Record a video instead of taking a screenshot.")] = False,
+    mode: Annotated[
+        SpectacleMode,
+        Option(..., "--mode", "-M", help="Specify what mode Spectacle should be launched in.", autocompletion=SpectacleMode.complete_format),
+    ] = SpectacleMode.DESKTOP,
+    record: Annotated[
+        bool, Option(..., "--record", "-r", help="Specify whether or not to record a video instead of taking a screenshot.")
+    ] = False,
     format: Annotated[
         NameFormat | None,
         Option(
@@ -213,12 +269,16 @@ async def spectacle(
         file_path = Path(temp_file.name)
         temp_file.close()
 
-        command: list[str] = ["spectacle", "--nonotify", "--background", "--pointer", "--copy-image", "--output", str(file_path)]
-
-        if record:
-            command.append("--record=region")
-        else:
-            command.append("--region")
+        command: list[str] = [
+            "spectacle",
+            "--nonotify",
+            "--background",
+            "--pointer",
+            mode.get_argument(record),
+            "--copy-image",
+            "--output",
+            str(file_path),
+        ]
 
         proc = await asyncio.create_subprocess_exec(*command, stdout=asyncio.subprocess.PIPE, stderr=asyncio.subprocess.PIPE)
         stdout, stderr = await proc.communicate()

{tacklebox_cli-0.2.2 → tacklebox_cli-0.2.4}/tacklebox/version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.2.2'
-__version_tuple__ = version_tuple = (0, 2, 2)
+__version__ = version = '0.2.4'
+__version_tuple__ = version_tuple = (0, 2, 4)