🔧 Pre-commit Hooks

Reusable pre-commit hooks for OpenSCAD projects.

Published on PyPI as 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/PNGs, compresses them, and strips metadata (privacy)

🔧 Usage

Add to your .pre-commit-config.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 and validates that the output is committed. Reads flatten config from scadm.json automatically.

- 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 and PNGs exceeding max width, compresses them, and strips metadata. EXIF data (including GPS coordinates) is removed from JPEGs; text metadata chunks are removed from PNGs.

- 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, ignored for PNG)

Both hooks fail when files are modified, printing instructions to git add the changes. Re-run git commit after staging.

🏗️ Used In

kellerlabs/homeracker — HomeRacker Core
kellerlabs/homeracker-exclusive — HomeRacker MakerWorld models

🤝 Contributing

See CONTRIBUTING.md.

📜 License

MIT

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kellerlab_pre_commit_hooks-0.3.11.tar.gz (8.4 kB view details)

Uploaded Aug 31, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

kellerlab_pre_commit_hooks-0.3.11-py3-none-any.whl (7.0 kB view details)

Uploaded Aug 31, 2026 Python 3

File details

Details for the file kellerlab_pre_commit_hooks-0.3.11.tar.gz.

File metadata

Download URL: kellerlab_pre_commit_hooks-0.3.11.tar.gz
Upload date: Aug 31, 2026
Size: 8.4 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for kellerlab_pre_commit_hooks-0.3.11.tar.gz
Algorithm	Hash digest
SHA256	`8589514eb7dcc8b1eb3b533bb2936f1360a88cd2a261c868c0593a0821c4ecdf`
MD5	`616fbd17b3a2e446715c4687790d059f`
BLAKE2b-256	`fd3c45a1ee05348a602d53d19fdafe3fea97298fe7763933baa83f1925284981`

See more details on using hashes here.

Provenance

The following attestation bundles were made for kellerlab_pre_commit_hooks-0.3.11.tar.gz:

Publisher: publish.yml on kellerlabs/pre-commit-hooks

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: kellerlab_pre_commit_hooks-0.3.11.tar.gz
- Subject digest: 8589514eb7dcc8b1eb3b533bb2936f1360a88cd2a261c868c0593a0821c4ecdf
- Sigstore transparency entry: 2663482258
- Sigstore integration time: Aug 31, 2026
Source repository:
- Permalink: kellerlabs/pre-commit-hooks@05b96ee613c9738d05381f4cb3f533cac4868a3f
- Branch / Tag: refs/tags/pre-commit-hooks-v0.3.11
- Owner: https://github.com/kellerlabs
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish.yml@05b96ee613c9738d05381f4cb3f533cac4868a3f
- Trigger Event: release