imgcmprs 0.1.0__tar.gz

imgcmprs-0.1.0/PKG-INFO

@@ -0,0 +1,11 @@
+Metadata-Version: 2.4
+Name: imgcmprs
+Version: 0.1.0
+Summary: A CLI tool for compressing images (JPEG, PNG)
+Author: Your Name
+Requires-Python: >=3.7
+Requires-Dist: Pillow
+Dynamic: author
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary

imgcmprs-0.1.0/README.md

@@ -0,0 +1,95 @@
+# img
+
+A fast, easy-to-use Python CLI tool for compressing JPEG and PNG images with both lossless and lossy modes.
+
+---
+
+## Features
+- Compresses images individually or in bulk (folders)
+- Supports JPEG and PNG
+- **Lossless mode** (`-l`): Optimizes files without visible quality loss
+- **Lossy mode** (`-q`): Reduce file size by lowering image quality
+- Recursive directory support
+- Custom output folder
+- Prompts to delete originals after compression
+- Skips replacement if compressed file is larger
+- Cross-platform, requires Python 3.7+
+
+---
+
+## Installation
+
+1. Install Python 3.7+
+2. Clone this repo and install:
+   ```bash
+   pip install -e .
+   # Or for user-local install:
+   pip install --user .
+   ```
+
+---
+
+## Usage
+
+### Compress a single image (lossy, 60% quality):
+
+```bash
+img -i myphoto.jpg -q 60
+```
+
+### Compress a folder (lossless, best for PNG):
+
+```bash
+img -i images/ -o optimized/ -l -r
+```
+
+### Options (Single-letter flags)
+| Flag | Meaning                        | Example                   |
+|------|--------------------------------|---------------------------|
+| -i   | Input file or folder (required)| `-i mypic.jpg`            |
+| -o   | Output file or folder (optional)| `-o compressed/`         |
+| -q   | JPEG quality (default 60; ignored in lossless mode)| `-q 80` |
+| -l   | Use lossless compression       | `-l`                      |
+| -r   | Recursively process folders    | `-r`                      |
+
+- All flags are **single-letter** for speed and ease: `-i`, `-o`, `-q`, `-l`, `-r`.
+- After compressing, you will be **prompted to delete the original files**.
+- If the compressed file is larger, the original is kept and a warning is printed.
+
+---
+
+## Requirements
+- Python 3.7+
+- Pillow (`pip install Pillow`)
+
+---
+
+## Notes
+- Lossless for PNG is truly lossless; for JPEG, uses `quality=100` with optimizations (minor effect but no further visual loss).
+- Output defaults to `_compressed` directory if not specified for folders.
+- Re-run with `-l` to optimize previously compressed images further (if possible).
+
+---
+
+## Publishing to PyPI
+
+1. **Ensure you have an account on [PyPI](https://pypi.org/).**
+2. **Install required tools:**
+    ```bash
+    pip install build twine
+    ```
+3. **Build your package:**
+    ```bash
+    python -m build
+    ```
+    This creates a `dist/` folder with your distributable files (tar.gz and .whl).
+4. **Upload to PyPI:**
+    ```bash
+    python -m twine upload dist/*
+    ```
+5. **Enter your PyPI credentials when prompted.**
+
+---
+
+## License
+MIT

imgcmprs-0.1.0/imgcmprs/__main__.py

@@ -0,0 +1,4 @@
+from .img_compress import main
+
+if __name__ == "__main__":
+    main()

imgcmprs-0.1.0/imgcmprs/img_compress.py

@@ -0,0 +1,167 @@
+import argparse
+import os
+from PIL import Image
+import sys
+import traceback
+import shutil
+
+def get_save_format(ext):
+    ext = ext.lstrip('.')
+    if ext in ('jpg', 'jpeg'):
+        return 'JPEG'
+    if ext == 'png':
+        return 'PNG'
+    return None
+
+def compress_image(input_path, output_path, quality, lossless, debug, force):
+    try:
+        img = Image.open(input_path)
+        ext = os.path.splitext(input_path)[1].lower()
+        in_place = os.path.abspath(input_path) == os.path.abspath(output_path)
+        save_format = get_save_format(ext)
+        tmp_path = None
+        if in_place:
+            base, ext_base = os.path.splitext(input_path)
+            tmp_path = f"{base}.imgcmprs_tmp{ext_base}"
+            real_output = tmp_path
+        else:
+            real_output = output_path
+
+        if debug:
+            print(f"[DEBUG] Processing: {input_path}")
+            print(f"[DEBUG] Format: {ext}, Output: {output_path}")
+            print(f"[DEBUG] Options: quality={quality}, lossless={lossless}, in_place={in_place}, force={force}")
+            print(f"[DEBUG] Temp file: {tmp_path if in_place else 'N/A'} for in-place")
+        save_kwargs = {'format': save_format}
+        if lossless:
+            if ext in (".png",):
+                img.save(real_output, optimize=True, **save_kwargs)
+            elif ext in (".jpg", ".jpeg"):
+                img.save(real_output, quality=100, optimize=True, progressive=True, **save_kwargs)
+            else:
+                img.save(real_output, **save_kwargs)
+        else:
+            if ext in (".jpg", ".jpeg"):
+                img.save(real_output, optimize=True, quality=quality, **save_kwargs)
+            elif ext == ".png":
+                img.save(real_output, optimize=True, **save_kwargs)
+            else:
+                img.save(real_output, **save_kwargs)
+        original_size = os.path.getsize(input_path)
+        compressed_size = os.path.getsize(real_output)
+        if debug:
+            print(f"[DEBUG] Input size: {original_size} bytes ; Output size: {compressed_size} bytes")
+        if compressed_size < original_size or force:
+            if in_place:
+                shutil.move(tmp_path, input_path)
+            print(f"Compressed: {input_path} -> {output_path} [{original_size//1024}KB → {compressed_size//1024}KB]")
+            return True
+        else:
+            if in_place:
+                if tmp_path and os.path.exists(tmp_path):
+                    os.remove(tmp_path)
+                print(f"Warning: Compression would not reduce size; in-place file left unchanged!")
+            else:
+                print(f"Warning: {output_path} is larger than or equal to original! Keeping original. [{original_size//1024}KB → {compressed_size//1024}KB]")
+                if os.path.exists(output_path):
+                    os.remove(output_path)
+            return False
+    except Exception as e:
+        print(f"Failed to compress {input_path}: {e}")
+        if debug:
+            traceback.print_exc()
+        if 'tmp_path' in locals() and tmp_path and os.path.exists(tmp_path):
+            os.remove(tmp_path)
+        return False
+
+def process_folder(input_folder, output_folder, quality, recursive, lossless, debug, force):
+    changed_files = []
+    for root, dirs, files in os.walk(input_folder):
+        for file in files:
+            if file.lower().endswith((".jpg", ".jpeg", ".png")):
+                in_path = os.path.join(root, file)
+                rel_path = os.path.relpath(in_path, input_folder)
+                out_path = os.path.join(output_folder, rel_path)
+                os.makedirs(os.path.dirname(out_path), exist_ok=True)
+                success = compress_image(in_path, out_path, quality, lossless, debug, force)
+                if success:
+                    changed_files.append((in_path, out_path))
+        if not recursive:
+            break
+    return changed_files
+
+def ask_delete_or_keep_copy(targets, force, debug):
+    # Only triggers meaningful copy if single file in-place
+    if len(targets) == 1:
+        original, compressed = targets[0]
+        in_place = os.path.abspath(original) == os.path.abspath(compressed)
+        answer = input(f"Do you want to delete the original file after compression? [y/N] ").strip().lower()
+        if answer == 'y':
+            # Overwrite already occurred if compressed, so nothing to do
+            print(f'Original file deleted (overwritten).')
+        else:
+            # In-place: keep original and save comp output to _comp.ext
+            if in_place:
+                base, ext = os.path.splitext(original)
+                comp_name = base + '_comp' + ext
+                if debug:
+                    print(f'[DEBUG] Saving compressed copy as: {comp_name}')
+                # Move current compressed result to new comp file
+                shutil.copy2(original, comp_name)
+                print(f"Compressed copy saved as: {comp_name} (original preserved)")
+            else:
+                print('Original file(s) kept.')
+    else:
+        # Folders or batch: just use original logic
+        answer = input(f"Do you want to delete the original file(s) after compression? [y/N] ").strip().lower()
+        if answer == 'y':
+            for original, compressed in targets:
+                try:
+                    os.remove(original)
+                    print(f"Deleted: {original}")
+                except Exception as e:
+                    print(f"Could not delete {original}: {e}")
+        else:
+            print('Original file(s) kept (batch mode).')
+
+def main():
+    parser = argparse.ArgumentParser(
+        description="Image Compressor CLI Tool: Lossless/lossy JPEG and PNG compression.\n\nFlags:\n  -i   Input file or folder (required)\n  -o   Output file or folder (optional)\n  -q   JPEG quality, 1-95 (default 60, ignored in lossless mode)\n  -l   Use lossless compression for PNG/JPEG\n  -r   Recursively process folders\n  -d   Enable debug output\n  -f   Force overwrite even if output is bigger",
+        formatter_class=argparse.RawTextHelpFormatter
+    )
+    parser.add_argument('-i', required=True, metavar='PATH', help='Input file or folder (required)')
+    parser.add_argument('-o', metavar='PATH', help='Output file or folder (optional)')
+    parser.add_argument('-q', type=int, default=60, metavar='N', help='JPEG quality, 1-95 (default 60, ignored with -l)')
+    parser.add_argument('-l', action='store_true', help='Lossless compression for PNG/JPEG (flag)')
+    parser.add_argument('-r', action='store_true', help='Recursively process folders (flag)')
+    parser.add_argument('-d', action='store_true', help='Enable debug output (flag)')
+    parser.add_argument('-f', action='store_true', help='Force overwrite even if output is bigger (flag)')
+    args = parser.parse_args()
+
+    input_path = args.i
+    output_path = args.o
+    quality = args.q
+    recursive = args.r
+    lossless = args.l
+    debug = args.d
+    force = args.f
+
+    changed_files = []
+    if os.path.isfile(input_path):
+        out = output_path if output_path else input_path
+        success = compress_image(input_path, out, quality, lossless, debug, force)
+        if success:
+            changed_files.append((input_path, out))
+    elif os.path.isdir(input_path):
+        out = output_path if output_path else input_path + "_compressed"
+        os.makedirs(out, exist_ok=True)
+        changed_files = process_folder(input_path, out, quality, recursive, lossless, debug, force)
+    else:
+        print("Input path is not a valid file or directory.")
+        sys.exit(1)
+
+    if changed_files:
+        ask_delete_or_keep_copy(changed_files, force, debug)
+
+if __name__ == "__main__":
+    main()

imgcmprs-0.1.0/imgcmprs.egg-info/PKG-INFO

@@ -0,0 +1,11 @@
+Metadata-Version: 2.4
+Name: imgcmprs
+Version: 0.1.0
+Summary: A CLI tool for compressing images (JPEG, PNG)
+Author: Your Name
+Requires-Python: >=3.7
+Requires-Dist: Pillow
+Dynamic: author
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary

imgcmprs-0.1.0/imgcmprs.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+README.md
+setup.py
+imgcmprs/__init__.py
+imgcmprs/__main__.py
+imgcmprs/img_compress.py
+imgcmprs.egg-info/PKG-INFO
+imgcmprs.egg-info/SOURCES.txt
+imgcmprs.egg-info/dependency_links.txt
+imgcmprs.egg-info/entry_points.txt
+imgcmprs.egg-info/requires.txt
+imgcmprs.egg-info/top_level.txt

imgcmprs-0.1.0/imgcmprs.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

imgcmprs-0.1.0/imgcmprs.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+img = imgcmprs.img_compress:main

imgcmprs-0.1.0/imgcmprs.egg-info/requires.txt

@@ -0,0 +1 @@
+Pillow

imgcmprs-0.1.0/imgcmprs.egg-info/top_level.txt

@@ -0,0 +1 @@
+imgcmprs

imgcmprs-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

imgcmprs-0.1.0/setup.py

@@ -0,0 +1,18 @@
+from setuptools import setup, find_packages
+
+setup(
+    name='imgcmprs',
+    version='0.1.0',
+    description='A CLI tool for compressing images (JPEG, PNG)',
+    author='Your Name',
+    packages=find_packages(),
+    install_requires=[
+        'Pillow'
+    ],
+    entry_points={
+        'console_scripts': [
+            'img=imgcmprs.img_compress:main',
+        ],
+    },
+    python_requires='>=3.7',
+)