czk-tool 1.0.0__tar.gz

czk_tool-1.0.0/PKG-INFO

@@ -0,0 +1,71 @@
+Metadata-Version: 2.4
+Name: czk-tool
+Version: 1.0.0
+Summary: CLI wrapper around czkawka_cli for duplicate media workflows
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+Requires-Dist: rich>=13.7.0
+
+# czk
+
+A CLI wrapper around [`czkawka_cli`](https://github.com/qarmin/czkawka) focused on usability and easier analysis of duplicate images and videos.
+
+## Features
+
+- Dry-run and live deletion modes with colorized, grouped terminal output
+- CSV and JSON reports per run
+- Interactive SQL analysis via DuckDB
+- Self-contained HTML visual report with inline image/video previews, search, and pagination
+
+## Requirements
+
+- macOS or Linux
+- [`czkawka_cli`](https://github.com/qarmin/czkawka) — duplicate detection engine
+- [`duckdb`](https://duckdb.org/) CLI — required for `czk analyze`
+- Python + [`uv`](https://github.com/astral-sh/uv)
+
+## Installation
+
+```bash
+uv tool install --editable .
+```
+
+## Usage
+
+```bash
+czk test <directory>      # Dry run — scan for duplicates, no deletion
+czk execute <directory>   # Delete duplicates (AEB strategy)
+czk analyze <directory>   # Interactive DuckDB SQL session over scan results
+czk viz <directory>       # Generate a self-contained HTML visual report
+```
+
+`czk check` is an alias for `czk test`; `czk analyse` is an alias for `czk analyze`.
+
+## Options
+
+| Flag | Description |
+|---|---|
+| `--media {both,images,videos}` | Media type to scan (default: `both`) |
+| `-s, --similarity-preset` | Image similarity preset: `Original`, `VeryHigh`, `High`, `Medium`, `Small`, `VerySmall`, `Minimal` (default: `High`) |
+| `-c, --hash-size {8,16,32,64}` | Perceptual hash size for images (default: `32`) |
+| `-g, --hash-alg` | Hash algorithm for images: `Mean`, `Gradient`, `Blockhash`, `VertGradient`, `DoubleGradient`, `Median` (default: `Gradient`) |
+| `-z, --image-filter` | Resize filter for images: `Lanczos3`, `Nearest`, `Triangle`, `Faussian`, `Catmullrom` (default: `Nearest`) |
+| `-t, --tolerance 0..20` | Similarity tolerance for videos (default: `10`) |
+| `--top N` | Limit duplicate groups in previews (default: `50`) |
+| `--all` | Show all duplicate groups, overrides `--top` |
+| `--out-dir <path>` | Output directory (default: `<system-temp>/czk-reports`) |
+| `--no-color` | Disable colored output |
+
+## Output
+
+Each run writes timestamped artifacts to the output directory:
+
+- `<base>-<media>-<YYYYMMDD-HHMMSS>.json`
+- `<base>-<media>-<YYYYMMDD-HHMMSS>.csv`
+- `<base>-viz-<YYYYMMDD-HHMMSS>.html` (`czk viz` only)
+
+CSV columns: `index`, `file_to_keep`, `files_to_remove`, `count`
+
+## Disclaimer
+
+Parts of this project were assisted by AI tooling. Review all commands carefully before running, especially deletion workflows. This software is provided "as is" without warranties of any kind. The authors are not liable for any data loss or other damages resulting from use.

czk_tool-1.0.0/README.md

@@ -0,0 +1,63 @@
+# czk
+
+A CLI wrapper around [`czkawka_cli`](https://github.com/qarmin/czkawka) focused on usability and easier analysis of duplicate images and videos.
+
+## Features
+
+- Dry-run and live deletion modes with colorized, grouped terminal output
+- CSV and JSON reports per run
+- Interactive SQL analysis via DuckDB
+- Self-contained HTML visual report with inline image/video previews, search, and pagination
+
+## Requirements
+
+- macOS or Linux
+- [`czkawka_cli`](https://github.com/qarmin/czkawka) — duplicate detection engine
+- [`duckdb`](https://duckdb.org/) CLI — required for `czk analyze`
+- Python + [`uv`](https://github.com/astral-sh/uv)
+
+## Installation
+
+```bash
+uv tool install --editable .
+```
+
+## Usage
+
+```bash
+czk test <directory>      # Dry run — scan for duplicates, no deletion
+czk execute <directory>   # Delete duplicates (AEB strategy)
+czk analyze <directory>   # Interactive DuckDB SQL session over scan results
+czk viz <directory>       # Generate a self-contained HTML visual report
+```
+
+`czk check` is an alias for `czk test`; `czk analyse` is an alias for `czk analyze`.
+
+## Options
+
+| Flag | Description |
+|---|---|
+| `--media {both,images,videos}` | Media type to scan (default: `both`) |
+| `-s, --similarity-preset` | Image similarity preset: `Original`, `VeryHigh`, `High`, `Medium`, `Small`, `VerySmall`, `Minimal` (default: `High`) |
+| `-c, --hash-size {8,16,32,64}` | Perceptual hash size for images (default: `32`) |
+| `-g, --hash-alg` | Hash algorithm for images: `Mean`, `Gradient`, `Blockhash`, `VertGradient`, `DoubleGradient`, `Median` (default: `Gradient`) |
+| `-z, --image-filter` | Resize filter for images: `Lanczos3`, `Nearest`, `Triangle`, `Faussian`, `Catmullrom` (default: `Nearest`) |
+| `-t, --tolerance 0..20` | Similarity tolerance for videos (default: `10`) |
+| `--top N` | Limit duplicate groups in previews (default: `50`) |
+| `--all` | Show all duplicate groups, overrides `--top` |
+| `--out-dir <path>` | Output directory (default: `<system-temp>/czk-reports`) |
+| `--no-color` | Disable colored output |
+
+## Output
+
+Each run writes timestamped artifacts to the output directory:
+
+- `<base>-<media>-<YYYYMMDD-HHMMSS>.json`
+- `<base>-<media>-<YYYYMMDD-HHMMSS>.csv`
+- `<base>-viz-<YYYYMMDD-HHMMSS>.html` (`czk viz` only)
+
+CSV columns: `index`, `file_to_keep`, `files_to_remove`, `count`
+
+## Disclaimer
+
+Parts of this project were assisted by AI tooling. Review all commands carefully before running, especially deletion workflows. This software is provided "as is" without warranties of any kind. The authors are not liable for any data loss or other damages resulting from use.

czk_tool-1.0.0/pyproject.toml

@@ -0,0 +1,27 @@
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "czk-tool"
+version = "1.0.0"
+description = "CLI wrapper around czkawka_cli for duplicate media workflows"
+readme = "README.md"
+requires-python = ">=3.14"
+dependencies = [
+    "rich>=13.7.0",
+]
+
+[project.scripts]
+czk = "czk_tool.cli:main"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[dependency-groups]
+dev = [
+    "pytest>=9.0.2",
+]

czk_tool-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

czk_tool-1.0.0/src/czk_tool/__init__.py

@@ -0,0 +1,2 @@
+"""czk tool package."""
+

czk_tool-1.0.0/src/czk_tool/__main__.py

@@ -0,0 +1,4 @@
+from .cli import main
+
+raise SystemExit(main())
+