tacklebox-cli 0.1.0__tar.gz

tacklebox_cli-0.1.0/.envrc

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+use flake

tacklebox_cli-0.1.0/.forgejo/workflows/actions.yml

@@ -0,0 +1,93 @@
+name: Actions
+on:
+  push:
+    branches:
+      - "main"
+    tags:
+      - "*"
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build
+    runs-on: docker
+    container: catthehacker/ubuntu:act-latest@sha256:932a29dd9f17cceda5a85597b9c6d4705fd8da13e488e800be81feb98e505594
+    steps:
+      - name: Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+        with:
+          fetch-depth: 0
+          ref: ${{ github.ref }}
+
+      - name: Setup uv
+        uses: actions/setup-uv@f0ec1fc3b38f5e7cd731bb6ce540c5af426746bb # v6
+        with:
+          version: "latest"
+          python-version: "3.12"
+          activate-environment: true
+          enable-cache: true
+          prune-cache: false
+          github-token: ${{ secrets.GITHUBTOKEN }}
+
+      - name: Install dependencies
+        run: uv sync --no-dev
+
+      - name: Build the package
+        run: uv build
+
+      - name: Upload the package
+        uses: actions/upload-artifact@16871d9e8cfcf27ff31822cac382bbb5450f1e1e # v4
+        with:
+          name: tacklebox-cli
+          path: ./dist/*
+
+      - name: Publish to CoastalCommits
+        if: startsWith(github.ref, 'refs/tags/')
+        run: uv publish
+        env:
+          UV_PUBLISH_USERNAME: ${{ github.repository_owner }}
+          UV_PUBLISH_PASSWORD: ${{ secrets.COASTALCOMMITSTOKEN }}
+          UV_PUBLISH_URL: https://c.csw.im/api/packages/${{ github.repository_owner }}/pypi
+
+      # - name: Publish to CoastalCommits
+      #   if: startsWith(github.ref, 'refs/tags/')
+      #   uses: actions/pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc # v1.12.4
+      #   with:
+      #     username: ${{ github.repository_owner }}
+      #     password: ${{ secrets.COASTALCOMMITSTOKEN }}
+      #     repository_url: https://c.csw.im/api/packages/${{ github.repository_owner }}/pypi
+
+      # - name: Publish to PyPi
+      #   if: startsWith(github.ref, 'refs/tags/')
+      #   uses: actions/pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc # v1.12.4
+      #   with:
+      #     password: ${{ secrets.PYPI_API_TOKEN }}
+
+  lint:
+    name: Lint
+    runs-on: docker
+    container: catthehacker/ubuntu:act-latest@sha256:932a29dd9f17cceda5a85597b9c6d4705fd8da13e488e800be81feb98e505594
+    steps:
+      - name: Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup uv
+        uses: actions/setup-uv@f0ec1fc3b38f5e7cd731bb6ce540c5af426746bb # v6
+        with:
+          version: "latest"
+          enable-cache: true
+          prune-cache: false
+          github-token: ${{ secrets.GITHUBTOKEN }}
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Analysing code with Ruff
+        run: uv run ruff check $(git ls-files '*.py')
+
+      - name: Analysing code with BasedPyright
+        if: ${{ success() }} || ${{ failure() }}
+        run: CI=false uv run basedpyright $(git ls-files '*.py')

tacklebox_cli-0.1.0/.gitignore

@@ -0,0 +1,7 @@
+.data/
+.direnv/
+.dist/
+.venv/
+__pycache__/
+.ruff_cache
+tacklebox/version.py

tacklebox_cli-0.1.0/LICENSE.md

@@ -0,0 +1,25 @@
+The MIT License (MIT)
+=====================
+
+Copyright © 2025 cswimr
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the “Software”), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

tacklebox_cli-0.1.0/PKG-INFO

@@ -0,0 +1,46 @@
+Metadata-Version: 2.4
+Name: tacklebox-cli
+Version: 0.1.0
+Summary: A small colection 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/0149870cfcd91418709412936f4866ca195b88f2.tar.gz
+Author-email: cswimr <seaswimmerthefsh@gmail.com>
+License-File: LICENSE.md
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.12
+Requires-Dist: desktop-notifier==6.1.1
+Requires-Dist: platformdirs==4.3.8
+Requires-Dist: zipline-py[cli]==0.27.0
+Description-Content-Type: text/markdown
+
+# tacklebox-cli
+
+tacklebox-cli offers a suite of useful CLI tools.
+
+## Usage
+
+### tacklebox clip
+
+Cross-platform clipboard copying tool. Uses `wl-copy`, `xclip`, or `xsel` on Linux, `pbcopy` on MacOS, `clip` on Windows, and [OSC 52](https://www.reddit.com/r/vim/comments/k1ydpn/a_guide_on_how_to_copy_text_from_anywhere/) escape codes when operating over SSH or when no other tools are available.
+
+```bash
+echo "a" | tr -d '\n' | tacklebox clip
+```
+
+### tacklebox spectacle (Linux only)
+
+Uses the [zipline.py](https://pypi.org/project/zipline-py/) CLI 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 | tr -d '\n' | tacklebox clip
+
+# or to record a video
+tacklebox spectacle --record | tr -d '\n' | tacklebox clip
+```
+
+### tacklebox zipline
+
+Wraps the [zipline.py](https://pypi.org/project/zipline-py/) CLI. See that project for documentation.

tacklebox_cli-0.1.0/README.md

@@ -0,0 +1,28 @@
+# tacklebox-cli
+
+tacklebox-cli offers a suite of useful CLI tools.
+
+## Usage
+
+### tacklebox clip
+
+Cross-platform clipboard copying tool. Uses `wl-copy`, `xclip`, or `xsel` on Linux, `pbcopy` on MacOS, `clip` on Windows, and [OSC 52](https://www.reddit.com/r/vim/comments/k1ydpn/a_guide_on_how_to_copy_text_from_anywhere/) escape codes when operating over SSH or when no other tools are available.
+
+```bash
+echo "a" | tr -d '\n' | tacklebox clip
+```
+
+### tacklebox spectacle (Linux only)
+
+Uses the [zipline.py](https://pypi.org/project/zipline-py/) CLI 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 | tr -d '\n' | tacklebox clip
+
+# or to record a video
+tacklebox spectacle --record | tr -d '\n' | tacklebox clip
+```
+
+### tacklebox zipline
+
+Wraps the [zipline.py](https://pypi.org/project/zipline-py/) CLI. See that project for documentation.

tacklebox_cli-0.1.0/flake.lock

@@ -0,0 +1,95 @@
+{
+  "nodes": {
+    "devshell": {
+      "inputs": {
+        "nixpkgs": "nixpkgs"
+      },
+      "locked": {
+        "lastModified": 1741473158,
+        "narHash": "sha256-kWNaq6wQUbUMlPgw8Y+9/9wP0F8SHkjy24/mN3UAppg=",
+        "owner": "numtide",
+        "repo": "devshell",
+        "rev": "7c9e793ebe66bcba8292989a68c0419b737a22a0",
+        "type": "github"
+      },
+      "original": {
+        "owner": "numtide",
+        "repo": "devshell",
+        "type": "github"
+      }
+    },
+    "flake-utils": {
+      "inputs": {
+        "systems": "systems"
+      },
+      "locked": {
+        "lastModified": 1731533236,
+        "narHash": "sha256-l0KFg5HjrsfsO/JpG+r7fRrqm12kzFHyUHqHCVpMMbI=",
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "rev": "11707dc2f618dd54ca8739b309ec4fc024de578b",
+        "type": "github"
+      },
+      "original": {
+        "id": "flake-utils",
+        "type": "indirect"
+      }
+    },
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1722073938,
+        "narHash": "sha256-OpX0StkL8vpXyWOGUD6G+MA26wAXK6SpT94kLJXo6B4=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "e36e9f57337d0ff0cf77aceb58af4c805472bfae",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixpkgs-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "nixpkgs_2": {
+      "locked": {
+        "lastModified": 1748460289,
+        "narHash": "sha256-7doLyJBzCllvqX4gszYtmZUToxKvMUrg45EUWaUYmBg=",
+        "owner": "nixos",
+        "repo": "nixpkgs",
+        "rev": "96ec055edbe5ee227f28cdbc3f1ddf1df5965102",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nixos",
+        "ref": "nixos-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "root": {
+      "inputs": {
+        "devshell": "devshell",
+        "flake-utils": "flake-utils",
+        "nixpkgs": "nixpkgs_2"
+      }
+    },
+    "systems": {
+      "locked": {
+        "lastModified": 1681028828,
+        "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
+        "owner": "nix-systems",
+        "repo": "default",
+        "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-systems",
+        "repo": "default",
+        "type": "github"
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}

tacklebox_cli-0.1.0/flake.nix

@@ -0,0 +1,83 @@
+{
+  inputs = {
+    nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
+    devshell.url = "github:numtide/devshell";
+  };
+
+  outputs =
+    {
+      self,
+      nixpkgs,
+      flake-utils,
+      ...
+    }@inputs:
+    flake-utils.lib.eachDefaultSystem (
+      system:
+      let
+        pkgs = import nixpkgs {
+          inherit system;
+          overlays = with inputs; [
+            devshell.overlays.default
+          ];
+        };
+      in
+      {
+        devShells.default = pkgs.devshell.mkShell {
+          devshell = {
+            name = "Tacklebox";
+            startup = {
+              install-uv-dependencies.text = "uv sync --all-groups --locked";
+              source-venv = {
+                text = ''
+                  source .venv/bin/activate
+                  export PATH="${pkgs.ruff}/bin:${pkgs.basedpyright}/bin:$PATH"
+                '';
+                deps = [ "install-uv-dependencies" ];
+              };
+              ensure-data-dir-exists.text = ''mkdir -p "$PRJ_DATA_DIR"'';
+            };
+          };
+
+          commands = with pkgs; [
+            { package = uv; }
+            { package = ruff; } # the ruff pip package installs a dynamically linked binary that cannot run on NixOS
+            { package = basedpyright; } # same as ruff
+            { package = typos; }
+          ];
+
+          packages = with pkgs; [
+            stdenv.cc.cc
+            python3
+          ];
+
+          env = [
+            {
+              name = "CPPFLAGS";
+              eval = "-I$DEVSHELL_DIR/include";
+            }
+            {
+              name = "LDFLAGS";
+              eval = "-L$DEVSHELL_DIR/lib";
+            }
+            {
+              name = "LD_LIBRARY_PATH";
+              eval = "$DEVSHELL_DIR/lib:$LD_LIBRARY_PATH";
+            }
+            {
+              name = "UV_PYTHON_PREFERENCE";
+              value = "only-system";
+            }
+            {
+              name = "UV_PYTHON_DOWNLOADS";
+              value = "never";
+            }
+          ];
+
+          motd = ''
+            {33}🔨 Welcome to the {208}Tacklebox{33} Devshell!{reset}
+            $(type -p menu &>/dev/null && menu)
+          '';
+        };
+      }
+    );
+}

tacklebox_cli-0.1.0/pyproject.toml

@@ -0,0 +1,48 @@
+[project]
+name = "tacklebox-cli"
+description = "A small colection of CLI utilities."
+authors = [{ name = "cswimr", email = "seaswimmerthefsh@gmail.com" }]
+readme = "README.md"
+requires-python = ">=3.12"
+classifiers = [
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+]
+dependencies = [
+    "desktop-notifier==6.1.1",
+    "platformdirs==4.3.8",
+    "zipline.py[cli]==0.27.0",
+]
+dynamic = ["version", "urls"]
+
+[dependency-groups]
+dev = ["basedpyright==1.29.2", "ruff==0.11.12"]
+
+[project.scripts]
+tacklebox = "tacklebox.entrypoint:app"
+
+[tool.ruff]
+line-length = 160
+
+[tool.pyright]
+typeCheckingMode = "strict"
+reportMissingTypeStubs = false
+
+[tool.typos]
+files.extend-exclude = [".direnv/**", ".venv/**"]
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.build.hooks.vcs]
+version-file = "tacklebox/version.py"
+
+[tool.hatch.metadata.hooks.vcs.urls]
+Homepage = "https://c.csw.im/cswimr/Tacklebox"
+Issues = "https://c.csw.im/cswimr/Tacklebox/issues"
+source_archive = "https://c.csw.im/cswimr/Tacklebox/archive/{commit_hash}.tar.gz"
+
+[build-system]
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"

tacklebox_cli-0.1.0/renovate.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "local>cc/renovate-config"
+  ]
+}

tacklebox_cli-0.1.0/tacklebox/__init__.py

@@ -0,0 +1,5 @@
+from tacklebox.sync import sync
+from tacklebox.utils import get_environment
+from tacklebox.version import __version__
+
+__all__ = ["sync", "get_environment", "__version__"]

tacklebox_cli-0.1.0/tacklebox/commands/__init__.py

@@ -0,0 +1,14 @@
+import platform
+
+from typer import Typer
+from zipline.cli.entrypoint import app as zipline
+
+from .clipboard import app as clipboard
+from .version import app as version
+
+commands: list[Typer] = [clipboard, version, zipline]
+
+if platform.system() == "Linux":
+    from .spectacle import app as spectacle
+
+    commands.append(spectacle)

tacklebox_cli-0.1.0/tacklebox/commands/clipboard.py

@@ -0,0 +1,171 @@
+import os
+import platform
+import shutil
+import subprocess
+import sys
+from base64 import b64encode
+from typing import Annotated, Literal
+
+from typer import Argument, Exit, Option, Typer, echo
+
+from tacklebox.utils import get_environment
+
+app = Typer()
+
+
+def _try_command(data: str, cmd: list[str], verbose: bool = False) -> bool:
+    if shutil.which(cmd[0]) is None:
+        if verbose:
+            echo(f"{cmd[0]} not found in PATH.", err=True)
+        return False
+
+    try:
+        process = subprocess.Popen(
+            cmd,
+            stdin=subprocess.PIPE,
+            stdout=subprocess.DEVNULL if not verbose else None,
+            stderr=subprocess.DEVNULL if not verbose else None,
+            env=get_environment(),
+        )
+        process.communicate(input=data.encode("utf-8"))
+
+        if process.returncode == 0:
+            if verbose:
+                echo(f"Copied using {' '.join(cmd)}")
+            return True
+    except Exception as e:
+        if verbose:
+            echo(f"{cmd[0]} failed: {e}", err=True)
+
+    return False
+
+
+def _copy_with_tooling(data: str, verbose: bool = False) -> bool:
+    system = platform.system()
+
+    if system == "Linux":
+        protocol: Literal["wayland", "x11"] | None = (
+            "wayland"
+            if "WAYLAND_DISPLAY" in get_environment()
+            else ("x11" if "DISPLAY" in get_environment() else None)
+        )
+
+        if verbose:
+            echo(f"Detected display protocol: {protocol}")
+
+        if protocol == "wayland":
+            if _try_command(data, ["wl-copy"], verbose):
+                return True
+        elif protocol == "x11":
+            for tool in [
+                ["xclip", "-selection", "clipboard"],
+                ["xsel", "--clipboard", "--input"],
+            ]:
+                if _try_command(data, tool, verbose):
+                    return True
+        else:
+            if verbose:
+                echo(
+                    "Unknown display protocol: neither WAYLAND_DISPLAY nor DISPLAY set.",
+                    err=True,
+                )
+        return False
+
+    elif system == "Darwin":
+        return _try_command(data, ["pbcopy"], verbose)
+
+    elif system == "Windows":
+        return _try_command(data, ["clip"], verbose)
+
+    if verbose:
+        echo(f"No suitable clipboard tool found for platform {system}", err=True)
+    return False
+
+
+def _encode_osc52(data: str, verbose: bool = False) -> str:
+    """Encode a string into an [OCS 52]() string, supporting tmux and screen as well.
+
+    Args:
+        data (str): The data to encode.
+        verbose (bool, optional): Print additional information during execution. Defaults to False.
+
+    Returns:
+        str: The OSC 52 (& base64) encoded data.
+    """
+    b64_data = b64encode(data.encode("utf-8")).decode("ascii")
+    osc_seq = f"\x1b]52;c;{b64_data}\x07"
+
+    if "TMUX" in os.environ:
+        if verbose:
+            echo("Wrapping OSC 52 for tmux.")
+        return f"\x1bPtmux;\x1b{osc_seq}\x1b\\"
+    elif os.environ.get("TERM", "").startswith("screen"):
+        if verbose:
+            echo("Wrapping OSC 52 for screen.")
+        return f"\x1bP{osc_seq}\x1b\\"
+    else:
+        if verbose:
+            echo("Using plain OSC 52.")
+        return osc_seq
+
+
+@app.command("clip")
+def clipboard(
+    data: Annotated[
+        str | None,
+        Argument(
+            help="The data to copy to the clipboard. Reads from stdin if this is not provided.",
+        ),
+    ] = None,
+    verbose: Annotated[
+        bool,
+        Option(
+            "--verbose",
+            "-v",
+            help="Print some additional information during execution.",
+        ),
+    ] = False,
+) -> None:
+    """Read from stdin and copy to the system clipboard using wl-copy or OSC 52."""
+    if not data:
+        data = sys.stdin.read()
+
+    if not data:
+        echo("No input received from stdin.", err=True)
+        raise Exit(code=1)
+
+    if verbose:
+        echo(
+            message="\n".join(
+                (
+                    f"Platform: {platform.system()}",
+                    f"TERM: {os.environ.get('TERM')}",
+                    f"TMUX: {'present' if 'TMUX' in os.environ else 'absent'}",
+                    f"SCREEN: {'present' if os.environ.get('TERM', '').startswith('screen') else 'absent'}",
+                )
+            )
+        )
+
+    success = _copy_with_tooling(data, verbose)
+    if success:
+        return
+
+    ssh = "SSH_CONNECTION" in os.environ
+
+    if ssh or not success:
+        if verbose:
+            echo("Clipboard tools failed; trying OSC 52...", err=True)
+
+        osc = _encode_osc52(data, verbose)
+        try:
+            with open("/dev/tty", "w") as tty:
+                tty.write(osc)
+            if verbose:
+                echo("Copied using OSC 52.")
+        except Exception as e:
+            echo(f"OSC 52 failed: {e}", err=True)
+            raise Exit(code=1)
+
+
+if __name__ == "__main__":
+    app()