Metadata-Version: 2.4
Name: imgsh
Version: 0.1.3
Summary: Privacy-first local image processing utility
Keywords: image,cli,resize,convert,ocr
Author: Sydney Idundun
Author-email: sydney.idundun@gmail.com
Requires-Python: >=3.11
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: Operating System :: OS Independent
Classifier: Topic :: Multimedia :: Graphics :: Graphics Conversion
Classifier: Topic :: Utilities
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Provides-Extra: all
Provides-Extra: gui
Provides-Extra: ocr
Requires-Dist: dearpygui (>=1.11.1) ; extra == "all"
Requires-Dist: dearpygui (>=1.11.1) ; extra == "gui"
Requires-Dist: pillow (>=10.0.0)
Requires-Dist: textract (==1.6.3) ; extra == "all"
Requires-Dist: textract (==1.6.3) ; extra == "ocr"
Requires-Dist: typer (>=0.12.0)
Project-URL: Homepage, https://github.com/SydneyTechnologies/imgsh
Project-URL: Issues, https://github.com/SydneyTechnologies/imgsh/issues
Project-URL: Repository, https://github.com/SydneyTechnologies/imgsh
Description-Content-Type: text/markdown

# Imgsh

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

## Install (Published Package)

```bash
pipx install "imgsh[gui,ocr]"
```

Or with `pip`:

```bash
pip install "imgsh[gui,ocr]"
```

## Install (Local Checkout with pipx)

```bash
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

```bash
poetry install --all-extras
```

## Commands

```bash
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

```bash
imgsh -h
imgsh resize -h
```

## Build Distribution Artifacts

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

## Publish

```bash
# 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.

