kellerlab-pre-commit-hooks 0.2.1__py3-none-any.whl

kellerlab_pre_commit_hooks-0.2.1.dist-info/METADATA

@@ -0,0 +1,102 @@
+Metadata-Version: 2.4
+Name: kellerlab-pre-commit-hooks
+Version: 0.2.1
+Summary: Reusable pre-commit hooks for OpenSCAD projects
+Author-email: Patrick Pötz <kellervater@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/kellerlabs/pre-commit-hooks
+Project-URL: Repository, https://github.com/kellerlabs/pre-commit-hooks
+Project-URL: Issues, https://github.com/kellerlabs/pre-commit-hooks/issues
+Project-URL: Changelog, https://github.com/kellerlabs/pre-commit-hooks/blob/main/CHANGELOG.md
+Keywords: pre-commit,openscad,image-optimization,scadm
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Utilities
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: scadm>=0.6.0
+Requires-Dist: Pillow>=11.0.0
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Dynamic: license-file
+
+# 🔧 Pre-commit Hooks
+
+Reusable [pre-commit](https://pre-commit.com/) hooks for OpenSCAD projects.
+
+Published on PyPI as [`kellerlab-pre-commit-hooks`](https://pypi.org/project/kellerlab-pre-commit-hooks/).
+
+## 📌 What
+
+Two hooks for OpenSCAD-based 3D printing projects:
+
+| Hook | Description |
+|------|-------------|
+| `flatten-validate` | Runs `scadm flatten --all` and fails if flattened files have uncommitted changes |
+| `optimize-images` | Resizes oversized JPEGs, compresses them, and strips EXIF data (privacy) |
+
+## 🔧 Usage
+
+Add to your `.pre-commit-config.yaml`:
+
+```yaml
+- repo: https://github.com/kellerlabs/pre-commit-hooks
+  rev: v0.1.0  # use latest tag
+  hooks:
+    - id: flatten-validate
+    - id: optimize-images
+```
+
+### `flatten-validate`
+
+Flattens OpenSCAD files via [scadm](https://pypi.org/project/scadm/) and validates that the output is committed. Reads flatten config from `scadm.json` automatically.
+
+```yaml
+- id: flatten-validate
+  # Override trigger pattern (default: always_run)
+  always_run: false
+  files: '^(scadm\.json|models/.*\.scad)'
+```
+
+**Options:**
+
+| Arg | Default | Description |
+|-----|---------|-------------|
+| `--flatten-dir` | Read from `scadm.json` | Override flatten output dirs (list of paths/globs) |
+
+### `optimize-images`
+
+Resizes JPEGs exceeding max width, compresses to target quality, and strips EXIF metadata (removes GPS coordinates from real-life photos).
+
+```yaml
+- id: optimize-images
+  args: [--max-width=1920, --quality=85]
+```
+
+**Options:**
+
+| Arg | Default | Description |
+|-----|---------|-------------|
+| `--max-width` | `1920` | Maximum image width in pixels |
+| `--quality` | `85` | JPEG compression quality (1-95) |
+
+Both hooks **fail when files are modified**, printing instructions to `git add` the changes. Re-run `git commit` after staging.
+
+## 🏗️ Used In
+
+- [kellerlabs/homeracker](https://github.com/kellerlabs/homeracker) — HomeRacker Core
+- [kellerlabs/homeracker-exclusive](https://github.com/kellerlabs/homeracker-exclusive) — HomeRacker MakerWorld models
+
+## 🤝 Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## 📜 License
+
+MIT

kellerlab_pre_commit_hooks-0.2.1.dist-info/RECORD

@@ -0,0 +1,9 @@
+kellerlab_pre_commit_hooks-0.2.1.dist-info/licenses/LICENSE,sha256=54mVbAWTJRVwZmhlOyauv_RlF3YsmceA605ZKVUEhXI,1067
+pre_commit_hooks/__init__.py,sha256=Ca0TTblLl6bkJjtsWn-3Am9laLcVbyF0AIRiVyt7avY,78
+pre_commit_hooks/flatten_validate.py,sha256=RvDWX9oiFT4Kyt3KKFc1tKUU44kHP9VP0_JVIQGF3aQ,3769
+pre_commit_hooks/optimize_images.py,sha256=3iJdzcmMFaRYaoK_1v59HmHdjupNhwbThXtjPMKyjcc,2579
+kellerlab_pre_commit_hooks-0.2.1.dist-info/METADATA,sha256=--DqsNjb1Hu3RaUYiAp6yiDaNcU44yHTa1BYBRDHAmE,3316
+kellerlab_pre_commit_hooks-0.2.1.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+kellerlab_pre_commit_hooks-0.2.1.dist-info/entry_points.txt,sha256=h0pVueZqICvvKQTt2guMZVKfAMNROVDLps8NKve3Zdc,132
+kellerlab_pre_commit_hooks-0.2.1.dist-info/top_level.txt,sha256=VYPubsyOzuMlsdcvTMQYKVCB1e-HcsV9kZ0Q7TlZuc4,17
+kellerlab_pre_commit_hooks-0.2.1.dist-info/RECORD,,

kellerlab_pre_commit_hooks-0.2.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

kellerlab_pre_commit_hooks-0.2.1.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+flatten-validate = pre_commit_hooks.flatten_validate:main
+optimize-images = pre_commit_hooks.optimize_images:main

kellerlab_pre_commit_hooks-0.2.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 KellerLabs
+
+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.

kellerlab_pre_commit_hooks-0.2.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+pre_commit_hooks

pre_commit_hooks/__init__.py

@@ -0,0 +1,3 @@
+"""Reusable pre-commit hooks for OpenSCAD projects."""
+
+__version__ = "0.1.0"

pre_commit_hooks/flatten_validate.py

@@ -0,0 +1,135 @@
+"""Pre-commit hook: flatten OpenSCAD files and validate they are committed."""
+
+import argparse
+import json
+import shlex
+import subprocess
+import sys
+from pathlib import Path
+
+
+def _read_flatten_dirs():
+    """Read flatten destination dirs from scadm.json.
+
+    Returns:
+        List of destination directory paths from the flatten config,
+        or empty list if scadm.json is missing or has no flatten key.
+    """
+    scadm_json = Path("scadm.json")
+    if not scadm_json.exists():
+        print("WARNING: scadm.json not found, skipping flatten dir validation")
+        return []
+
+    with open(scadm_json, encoding="utf-8") as f:
+        config = json.load(f)
+
+    flatten_entries = config.get("flatten", [])
+    if not flatten_entries:
+        print("WARNING: No 'flatten' entries in scadm.json")
+        return []
+
+    return [entry["dest"] for entry in flatten_entries if "dest" in entry]
+
+
+def _git_modified(paths):
+    """Get modified tracked files (not staged) under the given paths.
+
+    Args:
+        paths: List of directory paths to check.
+
+    Returns:
+        List of modified file paths.
+
+    Raises:
+        SystemExit: If git diff fails.
+    """
+    if not paths:
+        return []
+    result = subprocess.run(
+        ["git", "diff", "--name-only", "--"] + paths,
+        capture_output=True,
+        text=True,
+        check=False,
+    )
+    if result.returncode != 0:
+        print(f"ERROR: git diff failed: {result.stderr.strip()}")
+        sys.exit(1)
+    return [line for line in result.stdout.strip().split("\n") if line]
+
+
+def _git_untracked(paths):
+    """Get untracked files under the given paths.
+
+    Args:
+        paths: List of directory paths to check.
+
+    Returns:
+        List of untracked file paths.
+
+    Raises:
+        SystemExit: If git ls-files fails.
+    """
+    if not paths:
+        return []
+    result = subprocess.run(
+        ["git", "ls-files", "--others", "--exclude-standard", "--"] + paths,
+        capture_output=True,
+        text=True,
+        check=False,
+    )
+    if result.returncode != 0:
+        print(f"ERROR: git ls-files failed: {result.stderr.strip()}")
+        sys.exit(1)
+    return [line for line in result.stdout.strip().split("\n") if line]
+
+
+def main():
+    """Entry point for the flatten-validate pre-commit hook."""
+    parser = argparse.ArgumentParser(description="Validate flattened OpenSCAD exports are committed.")
+    parser.add_argument(
+        "--flatten-dir",
+        nargs="+",
+        default=None,
+        help="Override flatten destination dirs (default: read from scadm.json).",
+    )
+    args = parser.parse_args()
+
+    flatten_dirs = args.flatten_dir if args.flatten_dir else _read_flatten_dirs()
+
+    # Run scadm flatten
+    result = subprocess.run(["scadm", "flatten", "--all"], check=False)
+    if result.returncode != 0:
+        print("ERROR: scadm flatten --all failed")
+        return 1
+
+    if not flatten_dirs:
+        print("✓ No flatten directories to validate")
+        return 0
+
+    modified = _git_modified(flatten_dirs)
+    untracked = _git_untracked(flatten_dirs)
+
+    if modified or untracked:
+        print("")
+        print("ERROR: Flattened files have uncommitted/unstaged changes")
+        print("")
+        if modified:
+            print("Modified files (not staged):")
+            for f in modified:
+                print(f"  {f}")
+        if untracked:
+            print("Untracked files:")
+            for f in untracked:
+                print(f"  {f}")
+        dirs = " ".join(shlex.quote(d) for d in flatten_dirs)
+        print("")
+        print("Run the following to stage them:")
+        print(f"  git add {dirs}")
+        return 1
+
+    print("✓ All flattened files are committed")
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())

pre_commit_hooks/optimize_images.py

@@ -0,0 +1,88 @@
+"""Pre-commit hook: resize and compress JPEG images."""
+
+import argparse
+import shlex
+import sys
+
+from PIL import Image, ImageOps
+
+
+def _optimize_file(filepath, max_width, quality):
+    """Resize, compress, and strip EXIF from a single JPEG file.
+
+    Args:
+        filepath: Path to the JPEG file.
+        max_width: Maximum allowed width in pixels.
+        quality: JPEG compression quality (1-95).
+
+    Returns:
+        True if the file was modified, False otherwise.
+    """
+    with Image.open(filepath) as img:
+        # Apply EXIF orientation before checking size
+        img = ImageOps.exif_transpose(img)
+        width, height = img.size
+        needs_resize = width > max_width
+        has_exif = bool(img.info.get("exif"))
+
+        if not needs_resize and not has_exif:
+            return False
+
+        if needs_resize:
+            ratio = max_width / width
+            new_height = max(1, round(height * ratio))
+            new_size = (max_width, new_height)
+            img = img.resize(new_size, Image.LANCZOS)
+
+        if img.mode in ("RGBA", "P"):
+            img = img.convert("RGB")
+        img.save(filepath, "JPEG", quality=quality, optimize=True)
+
+    return True
+
+
+def main():
+    """Entry point for the optimize-images pre-commit hook."""
+    parser = argparse.ArgumentParser(description="Resize and compress JPEG images.")
+    parser.add_argument("filenames", nargs="*", help="JPEG files to check.")
+    parser.add_argument(
+        "--max-width",
+        type=int,
+        default=1920,
+        help="Maximum image width in pixels (default: 1920).",
+    )
+    parser.add_argument(
+        "--quality",
+        type=int,
+        default=85,
+        help="JPEG compression quality 1-95 (default: 85).",
+    )
+    args = parser.parse_args()
+
+    modified = []
+    failed = False
+    for filepath in args.filenames:
+        try:
+            if _optimize_file(filepath, args.max_width, args.quality):
+                modified.append(filepath)
+        except Exception as exc:  # pylint: disable=broad-exception-caught
+            print(f"ERROR: Failed to process {filepath}: {exc}")
+            failed = True
+
+    if modified:
+        quoted = " ".join(shlex.quote(f) for f in modified)
+        print("")
+        print("Images were resized/compressed by this hook:")
+        print("")
+        for f in modified:
+            print(f"  {f}")
+        print("")
+        print("Run the following to stage the optimized files:")
+        print(f"  git add {quoted}")
+        return 1
+
+    return 1 if failed else 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())