pyverter 0.1.1__tar.gz

pyverter-0.1.1/CHANGES.rst

@@ -0,0 +1,48 @@
+CHANGELOG
+=========
+
+.. towncrier release notes start
+
+pyverter 0.1.1 (2026-08-23)
+===========================
+
+Miscellaneous
+-------------
+
+- Update license configuration in pyproject.toml to use SPDX expression and license-files.
+
+
+pyverter 0.1.0 (2026-08-23)
+===========================
+
+Features
+--------
+
+- Add tests for resizer (`#2 <https://github.com/fizyk/pyverter/issues/2>`_)
+- Implemented multiprocessing - now images will be converted faster. (`#4 <https://github.com/fizyk/pyverter/issues/4>`_)
+- Build a package structure and define an entrypoint script. This will make the resizer properly installable. (`#9 <https://github.com/fizyk/pyverter/issues/9>`_)
+- List images and error encountered while processing them (`#27 <https://github.com/fizyk/pyverter/issues/27>`_)
+- Print size change in summary (`#28 <https://github.com/fizyk/pyverter/issues/28>`_)
+- Migrate to python 3.12 (`#40 <https://github.com/fizyk/pyverter/issues/40>`_)
+
+
+Miscellaneous
+-------------
+
+- Lint and typecheck code. (`#1 <https://github.com/fizyk/pyverter/issues/1>`_)
+- Added dependabot configuration and automerge workflow (`#3 <https://github.com/fizyk/pyverter/issues/3>`_)
+- Add towncrier and tbump configuration and dependency to (`#5 <https://github.com/fizyk/pyverter/issues/5>`_)
+- Drop dpi related code as they do not really matter. (`#10 <https://github.com/fizyk/pyverter/issues/10>`_)
+- Removed resizer editable installation from Pipfile. It breaks dependabot. (`#15 <https://github.com/fizyk/pyverter/issues/15>`_)
+- Freeze Pillow and click requirements in Pipfile (`#19 <https://github.com/fizyk/pyverter/issues/19>`_)
+- Adjust progressbar typing for mypy and new click. (`#38 <https://github.com/fizyk/pyverter/issues/38>`_)
+- Update code formatting with black 24.1 (`#55 <https://github.com/fizyk/pyverter/issues/55>`_)
+- Extend pre-commit with pyproject-fmt to format pyproject.toml (`#337 <https://github.com/fizyk/pyverter/issues/337>`_)
+- Migrate development environment and CI to uv (`#338 <https://github.com/fizyk/pyverter/issues/338>`_)
+- Add release-schedule workflow. (`#343 <https://github.com/fizyk/pyverter/issues/343>`_)
+- Migrated the Automerge workflow to `fizyk/actions-reuse` version 5.4.1. (`#348 <https://github.com/fizyk/pyverter/issues/348>`_)
+- Configure Dependabot to update pre-commit dependencies. (`#351 <https://github.com/fizyk/pyverter/issues/351>`_)
+- `#352 <https://github.com/fizyk/pyverter/issues/352>`_
+- Settle on pyverter as the package name
+- Update workflows for actions-reuse 3
+- Use pre-commit for maintaining code style and linting

pyverter-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Grzegorz Śliwiński
+
+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.

pyverter-0.1.1/PKG-INFO

@@ -0,0 +1,31 @@
+Metadata-Version: 2.4
+Name: pyverter
+Version: 0.1.1
+Summary: (Batch) Image resizer cli command based on Pillow
+Keywords: cli,image,processing
+Author: Grzegorz Śliwiński
+Author-email: Grzegorz Śliwiński <fizyk+pypi@fizyk.dev>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: click
+Requires-Dist: pillow
+Requires-Python: >=3.12
+Project-URL: Source, https://github.com/fizyk/pyverter
+Project-URL: Bug Tracker, https://github.com/fizyk/pyverter/issues
+Project-URL: Changelog, https://github.com/fizyk/pyverter/blob/v0.1.1/CHANGES.rst
+Description-Content-Type: text/x-rst
+
+A (batch) File converter
+========================
+
+Program that will help you convert a whole collection of files in a batch.
+
+At this stage, it can resize Images with Pillow
+
+Plan is to allow more and provide a plugin system to be able to allow even more.

pyverter-0.1.1/README.rst

@@ -0,0 +1,8 @@
+A (batch) File converter
+========================
+
+Program that will help you convert a whole collection of files in a batch.
+
+At this stage, it can resize Images with Pillow
+
+Plan is to allow more and provide a plugin system to be able to allow even more.

pyverter-0.1.1/pyproject.toml

@@ -0,0 +1,162 @@
+[build-system]
+build-backend = "uv_build"
+requires = ["uv-build>=0.12.5,<0.13"]
+
+[project]
+name = "pyverter"
+version = "0.1.1"
+description = "(Batch) Image resizer cli command based on Pillow"
+readme = "README.rst"
+keywords = [
+    "cli",
+    "image",
+    "processing",
+]
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.12"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.12",
+]
+dependencies = [
+    "click",
+    "pillow",
+]
+
+[[project.authors]]
+name = "Grzegorz Śliwiński"
+email = "fizyk+pypi@fizyk.dev"
+
+[project.urls]
+Source = "https://github.com/fizyk/pyverter"
+"Bug Tracker" = "https://github.com/fizyk/pyverter/issues"
+Changelog = "https://github.com/fizyk/pyverter/blob/v0.1.1/CHANGES.rst"
+
+[project.scripts]
+pyverter = "pyverter.cli:pyverter"
+
+[dependency-groups]
+dev = [
+    "click==8.4.2",
+    "mypy==2.3.1",
+    "pdbpp==0.12.1",
+    "pillow==12.3.0",
+    "pytest==9.1.1",
+    "pytest-cov==7.1.0",
+    "towncrier==25.8.0",
+    "types-pillow==10.2.0.20240822",
+]
+release = ["tbump==6.11.0"]
+
+[tool.uv.build-backend]
+module-name = "pyverter"
+module-root = ""
+source-include = ["CHANGES.rst"]
+
+[tool.ruff]
+target-version = "py311"
+line-length = 120
+
+[tool.ruff.lint]
+select = [
+    "E",
+    "F",
+    "I",
+    "D",
+    "RUF",
+]
+
+[tool.pyproject-fmt]
+column_width = 120
+indent = 4
+keep_full_version = true
+generate_python_version_classifiers = false
+table_format = "long"
+sub_table_spacing = """
+
+"""
+
+[tool.mypy]
+exclude = ["build/*"]
+
+[tool.pytest.ini_options]
+xfail_strict = true
+addopts = "--showlocals --verbose --cov"
+testpaths = "tests"
+
+[[tool.tbump.before_commit]]
+name = "Build changelog"
+cmd = "uv run towncrier build --version {new_version} --yes"
+
+[[tool.tbump.field]]
+name = "extra"
+default = ""
+
+[[tool.tbump.file]]
+src = "pyverter/__init__.py"
+
+[[tool.tbump.file]]
+src = "pyproject.toml"
+search = 'version = "{current_version}"'
+
+[[tool.tbump.file]]
+src = "pyproject.toml"
+search = 'Changelog = "https://github.com/fizyk/pyverter/blob/v{current_version}/CHANGES.rst"'
+
+[tool.tbump.git]
+message_template = "Release {new_version}"
+tag_template = "v{new_version}"
+
+[tool.tbump.version]
+current = "0.1.1"
+regex = '''
+  (?P<major>\d+)
+  \.
+  (?P<minor>\d+)
+  \.
+  (?P<patch>\d+)
+  (\-
+    (?P<extra>.+)
+  )?
+  '''
+
+[tool.towncrier]
+directory = "newsfragments"
+filename = "CHANGES.rst"
+issue_format = "`#{issue} <https://github.com/fizyk/pyverter/issues/{issue}>`_"
+single_file = true
+
+[[tool.towncrier.type]]
+directory = "break"
+name = "Breaking changes"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "depr"
+name = "Deprecations"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "feature"
+name = "Features"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "bugfix"
+name = "Bugfixes"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "docs"
+name = "Documentation"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "misc"
+name = "Miscellaneous"
+showcontent = true

pyverter-0.1.1/pyproject.toml.orig

@@ -0,0 +1,162 @@
+[build-system]
+build-backend = "uv_build"
+requires = [ "uv-build>=0.12.5,<0.13" ]
+
+[project]
+name = "pyverter"
+version = "0.1.1"
+description = "(Batch) Image resizer cli command based on Pillow"
+readme = "README.rst"
+keywords = [ "cli", "image", "processing" ]
+license = "MIT"
+license-files = [ "LICENSE" ]
+requires-python = ">=3.12"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.12",
+]
+dependencies = [
+    "click",
+    "pillow",
+]
+
+[[project.authors]]
+name = "Grzegorz Śliwiński"
+email = "fizyk+pypi@fizyk.dev"
+
+[project.urls]
+Source = "https://github.com/fizyk/pyverter"
+"Bug Tracker" = "https://github.com/fizyk/pyverter/issues"
+Changelog = "https://github.com/fizyk/pyverter/blob/v0.1.1/CHANGES.rst"
+
+[project.scripts]
+pyverter = "pyverter.cli:pyverter"
+
+[dependency-groups]
+dev = [
+    "click==8.4.2",
+    "mypy==2.3.1",
+    "pdbpp==0.12.1",
+    "pillow==12.3.0",
+    "pytest==9.1.1",
+    "pytest-cov==7.1.0",
+    "towncrier==25.8.0",
+    "types-pillow==10.2.0.20240822",
+]
+release = [
+    "tbump==6.11.0",
+]
+
+[tool.uv.build-backend]
+module-name = "pyverter"
+module-root = ""
+source-include = [ "CHANGES.rst" ]
+
+[tool.ruff]
+target-version = "py311"
+line-length = 120
+
+[tool.ruff.lint]
+select = [
+    "E",   # pycodestyle
+    "F",   # pyflakes
+    "I",   # isort
+    "D",   # pydocstyle
+    "RUF", # Ruff specific
+]
+
+[tool.pyproject-fmt]
+column_width = 120
+indent = 4
+keep_full_version = true
+generate_python_version_classifiers = false
+table_format = "long"
+sub_table_spacing = "\n"
+
+[tool.mypy]
+exclude = [
+    "build/*",
+]
+
+[tool.pytest.ini_options]
+xfail_strict = true
+addopts = "--showlocals --verbose --cov"
+testpaths = "tests"
+
+[tool.tbump]
+
+[[tool.tbump.before_commit]]
+name = "Build changelog"
+cmd = "uv run towncrier build --version {new_version} --yes"
+
+[[tool.tbump.field]]
+name = "extra"
+default = ""
+
+[[tool.tbump.file]]
+src = "pyverter/__init__.py"
+
+[[tool.tbump.file]]
+src = "pyproject.toml"
+search = 'version = "{current_version}"'
+
+[[tool.tbump.file]]
+src = "pyproject.toml"
+search = 'Changelog = "https://github.com/fizyk/pyverter/blob/v{current_version}/CHANGES.rst"'
+
+[tool.tbump.git]
+message_template = "Release {new_version}"
+tag_template = "v{new_version}"
+
+[tool.tbump.version]
+current = "0.1.1"
+regex = '''
+  (?P<major>\d+)
+  \.
+  (?P<minor>\d+)
+  \.
+  (?P<patch>\d+)
+  (\-
+    (?P<extra>.+)
+  )?
+  '''
+
+[tool.towncrier]
+directory = "newsfragments"
+filename = "CHANGES.rst"
+issue_format = "`#{issue} <https://github.com/fizyk/pyverter/issues/{issue}>`_"
+single_file = true
+
+[[tool.towncrier.type]]
+directory = "break"
+name = "Breaking changes"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "depr"
+name = "Deprecations"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "feature"
+name = "Features"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "bugfix"
+name = "Bugfixes"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "docs"
+name = "Documentation"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "misc"
+name = "Miscellaneous"
+showcontent = true

pyverter-0.1.1/pyverter/__init__.py

@@ -0,0 +1,3 @@
+"""Pyverter's main entry file."""
+
+__version__ = "0.1.1"

pyverter-0.1.1/pyverter/cli.py

@@ -0,0 +1,41 @@
+"""Main pyverter module."""
+
+import pathlib
+
+import click
+from click import Context
+
+from pyverter.resize import Resizer
+from pyverter.stat import image_stats, list_images
+
+
+@click.group()
+@click.argument("path", type=click.Path(exists=True, file_okay=False, path_type=pathlib.Path))
+@click.pass_context
+def pyverter(ctx: Context, path: pathlib.Path) -> None:
+    """Pyverter command group."""
+    ctx.ensure_object(dict)
+    ctx.obj["path"] = path
+
+
+@pyverter.command()
+@click.pass_context
+def stats(ctx: Context) -> None:
+    """Print path's images stats."""
+    ctx.ensure_object(dict)
+    path = ctx.obj["path"]
+    click.echo(f"Reading images to process from {path.absolute()}")
+    count = image_stats(list_images(path))
+    click.echo(f"There's a total of {count} images.")
+    pass
+
+
+@pyverter.command()
+@click.option("--max-size", type=int)
+@click.pass_context
+def resize(ctx: Context, max_size: int) -> None:
+    """Resize images in given path."""
+    ctx.ensure_object(dict)
+    path = ctx.obj["path"]
+    resizer = Resizer(max_size, path, path)
+    resizer()

pyverter-0.1.1/pyverter/resize.py

@@ -0,0 +1,171 @@
+"""Resize algorithm."""
+
+import multiprocessing
+import pathlib
+import signal
+from multiprocessing import Process, Queue
+from multiprocessing.synchronize import Event
+from queue import Empty
+from typing import Any, Dict, List, NamedTuple
+
+import click
+from PIL import Image
+
+from pyverter.stat import list_images
+from pyverter.tools import sizeof_fmt
+
+
+class ProcessedImages(NamedTuple):
+    """Processed image message."""
+
+    image_path: pathlib.Path
+    width: int
+    height: int
+    size_before: int
+    size_after: int
+    processed: bool
+    error: Exception | None
+
+
+class NonInteruptableProcess(Process):
+    """Catch signal interrupt for processes."""
+
+    def run(self) -> None:
+        """Run process but immune to SIGINT."""
+        signal.signal(signal.SIGINT, signal.SIG_IGN)
+        super().run()
+
+
+class Resizer:
+    """Resizer algorithm."""
+
+    def __init__(self, max_size: int, source: pathlib.Path, destination: pathlib.Path) -> None:
+        """Initialize resizer."""
+        self.cpu_cores: int = multiprocessing.cpu_count()
+        self.max_size = max_size
+        self.source = source
+        self.destination = destination
+
+    def __call__(self) -> None:
+        """Run resizer."""
+        stop_event: Event = multiprocessing.Event()
+        process_no: int = int(self.cpu_cores / 2)
+
+        # initial shard queue
+        images_to_process: Queue = Queue()
+        images_processed: Queue = Queue()
+
+        processes: List[NonInteruptableProcess] = []
+        for _ in range(process_no):
+            process = NonInteruptableProcess(
+                target=self.process_images,
+                args=(images_to_process, images_processed, stop_event),
+            )
+            processes.append(process)
+            process.start()
+
+        click.echo(f"Reading images to process from {self.source.absolute()}")
+        image_counter: int = 0
+        for image in list_images(self.source):
+            images_to_process.put(image)
+            image_counter += 1
+        click.echo(f"Found {image_counter} image files.")
+
+        converted: List[ProcessedImages] = []
+        skipped: List[ProcessedImages] = []
+        errored: List[ProcessedImages] = []
+        size_before = 0
+        size_after = 0
+
+        try:
+            items: List[ProcessedImages] = []
+            with click.progressbar(
+                items,
+                show_percent=True,
+                show_pos=True,
+                length=image_counter,
+                label="Processing images",
+            ) as bar:
+                processed_counter: int = 0
+                while True:
+                    try:
+                        image_processed: ProcessedImages = images_processed.get(timeout=5)
+                    except Empty:
+                        break
+                    processed_counter += 1
+                    bar.update(1)
+                    size_before += image_processed.size_before
+                    size_after += image_processed.size_after
+                    if image_processed.processed:
+                        converted.append(image_processed)
+                    else:
+                        skipped.append(image_processed)
+                        if image_processed.error:
+                            errored.append(image_processed)
+                    if processed_counter >= image_counter:
+                        break
+        except KeyboardInterrupt:
+            click.echo("Process stopped")
+        finally:
+            click.echo("Finished")
+            stop_event.set()
+            for process in processes:
+                process.join()
+        click.echo(f" {len(converted)} of images got converted and {len(skipped)} got skipped.")
+        click.echo(
+            f" Original size of images was {sizeof_fmt(size_before)} and got reduced to {sizeof_fmt(size_after)}"
+        )
+        if errored:
+            click.echo(f" There were {len(errored)} errors.")
+            for errored_image in errored:
+                click.echo(f" {errored_image.image_path} errored with f{errored_image.error}")
+
+    def process_images(self, to_process: Queue, processed: Queue, stop: Event) -> None:
+        """Process images, one at a time."""
+        while True:
+            if stop.is_set():
+                break
+            try:
+                image_file: pathlib.Path = to_process.get(timeout=3)
+            except Empty:
+                continue
+            image_file.relative_to(self.source)
+            destination = self.destination / image_file.relative_to(self.source)
+            try:
+                processed.put(self.resize_image(image_file, destination))
+            except OSError as ex:
+                size = image_file.stat().st_size
+                processed.put(ProcessedImages(image_file, 0, 0, size, size, True, ex))
+
+    def resize_image(self, image_file: pathlib.Path, destination: pathlib.Path) -> ProcessedImages:
+        """Resize image, return true if the resize had been performed."""
+        with Image.open(image_file) as image:
+            old_size = image_file.stat().st_size
+            if image.width <= self.max_size and image.height <= self.max_size:
+                return ProcessedImages(
+                    destination,
+                    image.width,
+                    image.height,
+                    old_size,
+                    old_size,
+                    False,
+                    None,
+                )
+            if image.width > image.height:
+                height = int(image.height * self.max_size / image.width)
+                width = self.max_size
+            else:
+                width = int(image.width * self.max_size / image.height)
+                height = self.max_size
+            new_image = image.resize((int(width), int(height)), Image.Resampling.LANCZOS)
+            kwargs: Dict[str, Any] = {"quality": 75}
+            if exif := image.info.get("exif"):
+                kwargs["exif"] = exif
+            try:
+                new_image.save(destination, **kwargs)
+                new_size = destination.stat().st_size
+                return ProcessedImages(destination, width, height, old_size, new_size, True, None)
+            except ValueError:
+                return ProcessedImages(destination, width, height, old_size, old_size, False, None)
+            finally:
+                new_image.close()

pyverter-0.1.1/pyverter/stat.py

@@ -0,0 +1,50 @@
+"""Statistic gathering methods."""
+
+import pathlib
+from collections import defaultdict
+from queue import SimpleQueue
+from typing import Dict, Generator
+
+import click
+from PIL import Image
+
+
+def list_images(path: pathlib.Path) -> Generator[pathlib.Path, None, None]:
+    """List all images from path."""
+    directories: SimpleQueue[pathlib.Path] = SimpleQueue()
+    directories.put(path)
+    while not directories.empty():
+        current_directory = directories.get()
+        for children_path in current_directory.iterdir():
+            if children_path.is_dir():
+                directories.put(children_path)
+            else:
+                try:
+                    with Image.open(children_path):
+                        yield children_path
+                except IOError:
+                    pass
+
+
+def count_images(path):
+    """Count all images in a path."""
+    return sum(1 for _ in list_images(path))
+
+
+def image_stats(images: Generator[pathlib.Path, None, None]) -> int:
+    """Actual print all images statistics."""
+    size_stat: Dict = defaultdict(int)
+    images_count = 0
+    for image_file in images:
+        with Image.open(image_file) as image:
+            if image.width > image.height:
+                size = (image.width, image.height)
+            else:
+                size = (image.height, image.width)
+            size_stat[size] += 1
+            images_count += 1
+    click.echo("Sizes:")
+    for size, count in size_stat.items():
+        click.echo(f" {size[0]:5}x{size[1]:<5}: {count:6}")
+
+    return images_count

pyverter-0.1.1/pyverter/tools.py

@@ -0,0 +1,10 @@
+"""Additional tools to use."""
+
+
+def sizeof_fmt(num, suffix="B"):
+    """Format sizes with proper unit."""
+    for unit in ("", "Ki", "Mi", "Gi", "Ti", "Pi", "Ei", "Zi"):
+        if abs(num) < 1024.0:
+            return f"{num:3.1f}{unit}{suffix}"
+        num /= 1024.0
+    return f"{num:.1f}Yi{suffix}"