Skip to main content

Privacy-first local image processing utility

Project description

Imgsh

Privacy-first local image utility for resize, convert, batch processing, and optional OCR.

Install (Published Package)

pipx install "imgsh[gui,ocr]"

Or with pip:

pip install "imgsh[gui,ocr]"

Install (Local Checkout with pipx)

pipx install "$HOME/Desktop/projects/imgsh[gui,ocr]"

pipx install <path> installs only base dependencies unless extras are included in the path spec.

Development Setup

poetry install --all-extras

Commands

imgsh resize input.jpg --width 1200 --fit contain
imgsh batch-resize ./images --width 1200 --recursive --out ./processed
imgsh convert input.png --format webp
imgsh extract-text input.jpg --engine textract --ocr-format txt
imgsh gui

Help

imgsh -h
imgsh resize -h

Build Distribution Artifacts

poetry check
rm -rf dist
poetry build
pipx run twine check dist/*

Publish

# bump patch version, commit, and create tag (for example v0.1.1)
poetry run publish

# bump minor instead
poetry run publish --bump minor

# set an explicit version
poetry run publish --version 0.2.0

# push commit and tag to origin (triggers tag-based publish workflow)
poetry run publish --push

A GitHub Actions workflow is included at .github/workflows/publish.yml. Set PYPI_API_TOKEN in repository secrets, then push a tag like v0.1.1 to publish automatically.

Notes

  • OCR extra is pinned to textract==1.6.3 for compatibility with current packaging tooling.

Project details


Download files

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

Source Distribution

imgsh-0.1.3.tar.gz (11.0 kB view details)

Uploaded Source

Built Distribution

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

imgsh-0.1.3-py3-none-any.whl (19.4 kB view details)

Uploaded Python 3

File details

Details for the file imgsh-0.1.3.tar.gz.

File metadata

  • Download URL: imgsh-0.1.3.tar.gz
  • Upload date:
  • Size: 11.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for imgsh-0.1.3.tar.gz
Algorithm Hash digest
SHA256 bb1950a47451686373a7f98f5dc4c4db9ac64adf0ae60ae0f9917b5fa2f46984
MD5 2631894308d9ef7ef9e440cecfc2ee27
BLAKE2b-256 dfa5379e47b46f02d9e6c5fd436bc0d39009e6184d41af645fb9c5c45e0c9325

See more details on using hashes here.

File details

Details for the file imgsh-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: imgsh-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 19.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for imgsh-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 6c419fd1ba30a3f2c6b30b49ba8f2d9c48880a165e33b18fe5aaa411d28f0ef2
MD5 18d14889b6b33292912f0f861e6199ac
BLAKE2b-256 a1dc9103c7617fa5b4a539464b1d3f2c31177a2f94cfa4de714ce24e69d48861

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page