pixopt 1.0.5__tar.gz

pixopt-1.0.5/.github/workflows/bump-version.yml

@@ -0,0 +1,143 @@
+name: Bump Version and Publish
+
+on:
+  push:
+    branches: [main, master]
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.PAT }}
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Run tests
+        run: pytest tests/ -v --tb=short
+
+      - name: Run ruff
+        run: ruff check src tests
+
+      - name: Run mypy
+        run: mypy src
+
+  bump:
+    needs: test
+    runs-on: ubuntu-latest
+    outputs:
+      tag: ${{ steps.version.outputs.tag }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.PAT }}
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install python-semantic-release build
+
+      - name: Configure Git
+        run: |
+          git config --global user.name "github-actions"
+          git config --global user.email "actions@github.com"
+
+      - name: Bump version and create tag
+        id: version
+        env:
+          GH_TOKEN: ${{ secrets.PAT }}
+        run: |
+          set -x
+          echo "Running semantic-release version..."
+          if semantic-release version; then
+            echo "Version bump succeeded"
+            git log --oneline -5
+            git tag -l
+            git remote -v
+            git push origin main --tags
+            echo "tag=$(git describe --tags --abbrev=0)" >> "$GITHUB_OUTPUT"
+          else
+            echo "No version bump needed or failed"
+            git log --oneline -5
+            git tag -l
+            echo "tag=" >> "$GITHUB_OUTPUT"
+          fi
+
+  build:
+    needs: bump
+    if: needs.bump.outputs.tag != ''
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ needs.bump.outputs.tag }}
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+
+      - name: Build distribution
+        run: python -m build
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish-pypi:
+    needs: build
+    if: needs.bump.outputs.tag != ''
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/pixopt
+    permissions:
+      id-token: write
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI (Trusted Publishing)
+        id: trusted-publish
+        uses: pypa/gh-action-pypi-publish@release/v1
+        continue-on-error: true
+
+      - name: Publish to PyPI (Token fallback)
+        if: steps.trusted-publish.outcome == 'failure'
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_TOKEN }}

pixopt-1.0.5/.github/workflows/ci.yml

@@ -0,0 +1,58 @@
+name: CI
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        python-version: ["3.10", "3.11", "3.12"]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Run tests
+        run: pytest tests/ -v --tb=short
+
+      - name: Run ruff
+        run: ruff check src tests
+
+      - name: Run mypy
+        run: mypy src
+
+  build-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install docs dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[docs]"
+
+      - name: Build docs
+        run: mkdocs build --strict

pixopt-1.0.5/.github/workflows/docs.yml

@@ -0,0 +1,51 @@
+name: Docs
+
+on:
+  push:
+    branches: [main, master]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[docs]"
+
+      - name: Build docs
+        run: mkdocs build --strict
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: site/
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

pixopt-1.0.5/.gitignore

@@ -0,0 +1,48 @@
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+.mypy_cache/
+.dmypy.json
+dmypy.json
+.pytest_cache/
+.coverage
+htmlcov/
+*.log
+.DS_Store
+Thumbs.db
+*.jpg
+*.jpeg
+*.png
+*.webp
+*.avif
+*.bmp
+*.gif
+*.tiff
+!tests/fixtures/

pixopt-1.0.5/.readthedocs.yaml

@@ -0,0 +1,16 @@
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs
+
+mkdocs:
+  configuration: mkdocs.yml

pixopt-1.0.5/CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- Lossless compression mode for PNG/WEBP (`--lossless`).
+- Interactive HTML before/after comparison slider (`pixopt compare`).
+- Adaptive quality via binary search for target file size (`--target-size`).
+- Responsive srcset image generation with HTML snippet output (`pixopt srcset`).
+- Lazy-loading placeholders: dominant color, LQIP data URI, and blurhash (`pixopt placeholder`).
+- Smart format detection: auto-select WEBP/JPEG/PNG based on image content (`--smart-format`).
+- Backup originals before processing (`--backup`).
+- Skip files below a minimum size threshold (`--min-size`).
+- Animated GIF to animated WEBP conversion.
+- Pure-Python SVG minification.
+- HEIC/HEIF support via `pillow-heif`.
+- GitHub Actions workflows for CI, release (PyPI), and documentation.

pixopt-1.0.5/CONTRIBUTING.md

@@ -0,0 +1,38 @@
+# Contributing
+
+Thanks for your interest in contributing!
+
+## Development setup
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/MathiasPaulenko/pixopt.git
+   cd pixopt
+   ```
+
+2. Create a virtual environment and install dependencies:
+   ```bash
+   python -m venv .venv
+   source .venv/bin/activate  # Windows: .venv\Scripts\activate
+   pip install -e ".[dev]"
+   ```
+
+## Running tests
+
+```bash
+pytest tests/ -v
+```
+
+## Code style
+
+- Follow PEP 8.
+- Use type hints where possible.
+- Keep docstrings concise and descriptive.
+
+## Pull requests
+
+1. Fork the repository.
+2. Create a feature branch.
+3. Make your changes with tests.
+4. Ensure `pytest` passes.
+5. Submit a pull request with a clear description.

pixopt-1.0.5/LICENSE

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

pixopt-1.0.5/MANIFEST.in

@@ -0,0 +1,7 @@
+include README.md
+include CHANGELOG.md
+include LICENSE
+recursive-include src *.py
+recursive-exclude tests *
+recursive-exclude .pytest_cache *
+recursive-exclude __pycache__ *

pixopt-1.0.5/PKG-INFO

@@ -0,0 +1,304 @@
+Metadata-Version: 2.4
+Name: pixopt
+Version: 1.0.5
+Summary: Fast Python image optimizer. Resize, compress, convert, and generate responsive assets.
+Project-URL: Homepage, https://github.com/MathiasPaulenko/pixopt
+Project-URL: Repository, https://github.com/MathiasPaulenko/pixopt
+Project-URL: Issues, https://github.com/MathiasPaulenko/pixopt/issues
+Author-email: Mathias Paulenko Echeverz <mathias.paulenko@outlook.com>
+License: MIT
+License-File: LICENSE
+Keywords: cli,compression,image,jpeg,optimization,png,webp
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Multimedia :: Graphics
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Requires-Dist: piexif>=1.1.3
+Requires-Dist: pillow-heif>=1.0.0
+Requires-Dist: pillow>=10.0.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: typer>=0.12.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: python-semantic-release>=9.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.4.0; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: mkdocs-material>=9.5.0; extra == 'docs'
+Requires-Dist: mkdocs>=1.6.0; extra == 'docs'
+Requires-Dist: mkdocstrings[python]>=0.25.0; extra == 'docs'
+Description-Content-Type: text/markdown
+
+# pixopt
+
+A powerful, easy-to-use Python library and CLI tool for optimizing images for web and storage.
+
+## Features
+
+- **Size reduction** – resize images to maximum width/height while keeping aspect ratio
+- **Format conversion** – convert between JPEG, PNG, WEBP, AVIF, GIF, HEIC/HEIF and SVG
+- **Animated GIF → WEBP** – convert animated GIFs to much lighter animated WEBP
+- **SVG minification** – pure-Python SVG cleanup (no Node.js tools needed)
+- **HEIC/HEIF import** – open iPhone photos directly thanks to `pillow-heif`
+- **Lossless mode** – lossless PNG/WEBP compression for UI assets that need pixel-perfect fidelity
+- **Adaptive quality** – binary-search quality to hit a target file size automatically
+- **Visual comparison** – generate interactive HTML before/after sliders
+- **Responsive srcset** – generate multiple width variants and HTML `<img srcset="...">` snippets
+- **Lazy-loading placeholders** – extract dominant color, generate LQIP data URIs, or blurhash strings
+- **Smart format detection** – auto-detect the most efficient format (photo → WEBP, graphic → PNG, transparent → WEBP)
+- **Backup originals** – copy originals to a backup directory before processing
+- **Min-size filter** – skip files already below a size threshold
+- **Metadata stripping** – remove EXIF and other metadata to save space
+- **Quality tuning** – adjustable compression quality (1-100)
+- **Progressive JPEG** – enable progressive encoding for better web delivery
+- **Batch processing** – optimize single files, directories, or multiple files at once
+- **CLI with Typer** – intuitive command-line interface with beautiful output
+
+## Installation
+
+```bash
+pip install pixopt
+```
+
+## CLI Usage
+
+### Optimize a single image
+
+```bash
+pixopt optimize photo.jpg photo_optimized.jpg --quality 80 --width 1200
+```
+
+### Optimize all images in a directory
+
+```bash
+pixopt optimize ./images ./optimized --recursive --quality 85 --format webp
+```
+
+### Batch optimize specific files
+
+```bash
+pixopt batch photo1.jpg photo2.png photo3.bmp -o ./optimized --width 800
+```
+
+### Convert image format / extension
+
+```bash
+pixopt convert photo.png photo.webp -f webp
+pixopt convert ./images ./webp_images -r -f webp
+```
+
+### Generate favicon (.ico)
+
+```bash
+pixopt favicon logo.png favicon.ico
+pixopt favicon logo.png --size 16 --size 32 --size 48
+```
+
+### Convert animated GIF to animated WEBP
+
+```bash
+pixopt convert animation.gif animation.webp -f webp
+```
+
+### Optimize SVG
+
+```bash
+pixopt convert icon.svg icon.min.svg
+```
+
+### Convert HEIC (iPhone) to JPEG
+
+```bash
+pixopt convert photo.heic photo.jpg
+```
+
+### Lossless PNG/WEBP for UI assets
+
+```bash
+pixopt convert icon.png icon.webp --lossless -f webp
+```
+
+### Adaptive quality (target file size)
+
+```bash
+pixopt optimize photo.jpg --target-size 50
+```
+
+### Generate visual comparison HTML
+
+```bash
+pixopt compare photo.jpg comparison.html --open
+```
+
+### Generate responsive srcset images
+
+```bash
+pixopt srcset hero.jpg --sizes 320,640,1024,1920 --output-dir ./responsive/
+pixopt srcset hero.jpg --sizes 320,640,1024,1920 -f webp --html snippet.html
+```
+
+### Generate lazy-loading placeholders
+
+```bash
+pixopt placeholder photo.jpg --type color
+pixopt placeholder photo.jpg --type lqip
+pixopt placeholder photo.jpg --type blurhash -o blurhash.txt
+```
+
+### Smart format detection
+
+```bash
+pixopt optimize photo.jpg --smart-format
+pixopt convert graphic.png output --smart-format
+```
+
+### Backup originals before processing
+
+```bash
+pixopt optimize ./images --backup ./originals --recursive
+```
+
+### Skip already-optimized files
+
+```bash
+pixopt optimize ./images --min-size 10 --recursive
+```
+
+### Inspect image info without optimizing
+
+```bash
+pixopt info photo.jpg
+```
+
+### Available options
+
+| Option | Description |
+|--------|-------------|
+| `-q, --quality` | JPEG/WEBP quality (1-100, default: 85) |
+| `-w, --width` | Maximum width in pixels |
+| `-h, --height` | Maximum height in pixels |
+| `-f, --format` | Output format: auto, jpeg, png, webp, avif, original |
+| `-s, --strip` | Remove metadata (default: True) |
+| `--progressive` | Progressive JPEG encoding (default: True) |
+| `-r, --recursive` | Process directories recursively |
+| `--overwrite` | Overwrite source files |
+| `--lossless` | Lossless PNG/WEBP compression |
+| `--target-size` | Target file size in KB (adaptive quality) |
+| `--smart-format` | Auto-detect the most efficient output format |
+| `--backup` | Backup originals to this directory |
+| `--min-size` | Skip files already smaller than this threshold (KB) |
+
+## Library Usage
+
+```python
+from pixopt import optimize_image
+from pixopt.models import OutputFormat
+
+# Optimize a single image
+result = optimize_image(
+    "photo.jpg",
+    "photo_optimized.webp",
+    max_width=1200,
+    quality=80,
+    strip_metadata=True,
+    output_format=OutputFormat.WEBP,
+)
+
+print(f"Saved {result.savings_percent:.1f}% ({result.human_savings})")
+```
+
+### Placeholders for lazy loading
+
+```python
+from pixopt.placeholder import generate_placeholder
+
+color = generate_placeholder("photo.jpg", placeholder_type="color")
+lqip = generate_placeholder("photo.jpg", placeholder_type="lqip")
+blurhash = generate_placeholder("photo.jpg", placeholder_type="blurhash")
+```
+
+### Smart format detection
+
+```python
+from pixopt.smart_format import detect_optimal_format
+
+fmt = detect_optimal_format("photo.jpg")
+# Returns OutputFormat.WEBP for photos, PNG for graphics, WEBP for transparent images
+```
+
+### Responsive srcset generation
+
+```python
+from pixopt.srcset_generator import generate_srcset_images
+
+variants = generate_srcset_images(
+    "hero.jpg",
+    "./responsive",
+    widths=[320, 640, 1024, 1920],
+    output_format="WEBP",
+    quality=80,
+)
+for v in variants:
+    print(f"{v.width}px -> {v.size_bytes} bytes")
+```
+
+### Batch / directory processing
+
+```python
+from pixopt import optimize_directory
+
+results = optimize_directory(
+    "./images",
+    "./optimized",
+    recursive=True,
+    max_width=800,
+    quality=75,
+    output_format=OutputFormat.WEBP,
+)
+
+for r in results:
+    if r.success:
+        print(f"{r.source_path.name}: {r.savings_percent:.1f}% saved")
+```
+
+## Development
+
+Install in development mode:
+
+```bash
+git clone https://github.com/MathiasPaulenko/pixopt.git
+cd pixopt
+pip install -e ".[dev]"
+```
+
+Run tests:
+
+```bash
+pytest
+```
+
+Run linter:
+
+```bash
+ruff check src tests
+mypy src
+```
+
+Build documentation locally:
+
+```bash
+pip install -e ".[docs]"
+mkdocs serve
+```
+
+## License
+
+MIT