Merge pull request #13 from john-liu2/task/code75

Add `check_latest_version()` and `update_package()` logic

Author: john-liu2

.github/workflows/pylint.yml

@@ -17,7 +17,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install pylint ruff click loguru piexif pillow pillow-heif tqdm numpy opencv-python
+          pip install pylint ruff click loguru piexif pillow pillow-heif tqdm numpy opencv-python packaging requests
       - name: Analysing the code with pylint
         run: |
           pylint $(git ls-files '*.py')

.github/workflows/pytest.yml

@@ -24,7 +24,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install pytest-cov click loguru piexif pillow pillow-heif tqdm numpy opencv-python
+          pip install pytest-cov click loguru piexif pillow pillow-heif tqdm numpy opencv-python packaging requests
           if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
       - name: Test with pytest
         run: |

README.md

@@ -52,7 +52,8 @@ uv pip install --upgrade batch_img
 Usage: batch_img [OPTIONS] COMMAND [ARGS]...
 
 Options:
-  --version  Show this tool's version.
+  --update   Update the tool to the latest version.
+  --version  Show the tool's version.
   --help     Show this message and exit.
 
 Commands:

batch_img/common.py

@@ -2,44 +2,107 @@
 Copyright © 2025 John Liu
 """
 
+import importlib.metadata
 import itertools
 import json
 import subprocess
 import tomllib
 from datetime import datetime
-from importlib.metadata import version
 from multiprocessing import Pool, cpu_count
 from os.path import getmtime, getsize
 from pathlib import Path
 
 import piexif
 import pillow_heif
+import requests
 from loguru import logger
+from packaging import version  # compare versions safely
 from PIL import Image, ImageChops
 from PIL.TiffImagePlugin import IFDRational
 from tqdm import tqdm
 
-from batch_img.const import PATTERNS, PKG_NAME, REPLACE, TS_FORMAT, VER
+from batch_img.const import PATTERNS, REPLACE, TS_FORMAT, VER
 
 pillow_heif.register_heif_opener()  # allow Pillow to open HEIC files
 
 
 class Common:
     @staticmethod
-    def get_version() -> str:
-        """
-        Get this package version using several ways
+    def get_version(pkg_name: str) -> str:
+        """Get this package version by various ways
+
+        Args:
+            pkg_name: package name str
+
+        Returns:
+            str:
         """
         try:
-            return version(PKG_NAME)
+            return importlib.metadata.version(pkg_name)
         except (FileNotFoundError, ImportError, ValueError) as e:
-            # Use lazy % formatting in logging for efficiency
-            logger.warning(f"importlib.metadata.version Error: {e}")
-            logger.debug("Try to get version from pyproject.toml file")
+            logger.warning(f"importlib.metadata.version() Error: {e}")
+            logger.debug("Get version from pyproject.toml file")
             pyproject = Path(__file__).parent.parent / "pyproject.toml"
             with open(pyproject, "rb") as f:
                 return tomllib.load(f)["project"][VER]
 
+    @staticmethod
+    def check_latest_version(pkg_name: str) -> str:
+        """Check if the installed version is the latest one
+
+        Args:
+            pkg_name: package name str
+
+        Returns:
+            str
+        """
+        try:
+            jsn_url = f"https://pypi.org/pypi/{pkg_name}/json"
+            response = requests.get(jsn_url, timeout=8)
+            if response.status_code != 200:
+                msg = f"⚠️ Error get data from PyPI: {jsn_url}"
+                logger.error(msg)
+                return msg
+
+            latest_ver = response.json()["info"]["version"]
+            cur_ver = Common.get_version(pkg_name)
+            if version.parse(cur_ver) < version.parse(latest_ver):
+                msg = (
+                    f"🔔 Update available: {cur_ver} → {latest_ver}\n"
+                    f"Please run '{pkg_name} --update'"
+                )
+            else:
+                msg = f"✅ {pkg_name} is up to date ({cur_ver})"
+            logger.info(msg)
+        except requests.RequestException as e:
+            msg = f"requests.get() Exception: {e}"
+            logger.error(msg)
+        except (KeyError, json.JSONDecodeError) as e:
+            msg = f"Error parse PyPI response: {e}"
+            logger.error(msg)
+        return msg
+
+    @staticmethod
+    def update_package(pkg_name: str) -> str:
+        """Update the package to the latest version
+
+        Args:
+            pkg_name: package name str
+
+        Returns:
+            str
+        """
+        logger.info(f"🔄 Updating {pkg_name} ...")
+        cmd = f"uv pip install --upgrade {pkg_name}"
+        try:
+            Common.run_cmd(cmd)
+            msg = "✅ Update completed."
+            logger.info(msg)
+        except subprocess.CalledProcessError as e:
+            msg = f"❌ Failed to update {pkg_name}: {e}"
+            logger.error(msg)
+        return msg
+
     @staticmethod
     def run_cmd(cmd: str) -> tuple:
         """Run a command on the host and get the output

batch_img/interface.py

@@ -5,17 +5,20 @@
 import click
 
 from batch_img.common import Common
-from batch_img.const import MSG_BAD, MSG_OK
+from batch_img.const import MSG_BAD, MSG_OK, PKG_NAME
 from batch_img.main import Main
 
 
 @click.group(invoke_without_command=True)
 @click.pass_context
-@click.option("--version", is_flag=True, help="Show this tool's version.")
-def cli(ctx, version):  # pragma: no cover
+@click.option("--update", is_flag=True, help="Update the tool to the latest version.")
+@click.option("--version", is_flag=True, help="Show the tool's version.")
+def cli(ctx, update, version):  # pragma: no cover
     if not ctx.invoked_subcommand:
+        if update:
+            Common.update_package(PKG_NAME)
         if version:
-            click.secho(Common.get_version())
+            click.secho(Common.get_version(PKG_NAME))
 
 
 @cli.command(help="Add internal border to image file(s), not expand the size.")

batch_img/main.py

@@ -10,6 +10,7 @@
 from loguru import logger
 
 from batch_img.border import Border
+from batch_img.common import Common
 from batch_img.const import PKG_NAME, REPLACE, TS_FORMAT
 from batch_img.resize import Resize
 from batch_img.rotate import Rotate
@@ -43,15 +44,16 @@ def resize(options: dict) -> bool:
         Main.init_log_file()
         in_path = Path(options["src_path"])
         length = options.get("length")
-        output = options.get("output")
         if not length or length == 0:
-            logger.warning(f"No resize due to bad {length=}")
+            logger.error(f"No resize due to bad {length=}")
             return False
+        output = options.get("output")
         out = Path(output) if output else REPLACE
         if in_path.is_file():
             ok, _ = Resize.resize_an_image(in_path, out, length)
         else:
             ok = Resize.resize_all_progress_bar(in_path, out, length)
+        Common.check_latest_version(PKG_NAME)
         return ok
 
     @staticmethod
@@ -68,15 +70,16 @@ def rotate(options: dict) -> bool:
         Main.init_log_file()
         in_path = Path(options["src_path"])
         angle = options.get("angle")
-        output = options.get("output")
         if not angle or angle == 0:
-            logger.warning(f"No rotate due to bad {angle=}")
+            logger.error(f"No rotate due to bad {angle=}")
             return False
+        output = options.get("output")
         out = Path(output) if output else REPLACE
         if in_path.is_file():
             ok, _ = Rotate.rotate_1_image(in_path, out, angle)
         else:
             ok = Rotate.rotate_all_in_dir(in_path, out, angle)
+        Common.check_latest_version(PKG_NAME)
         return ok
 
     @staticmethod
@@ -93,14 +96,18 @@ def border(options: dict) -> bool:
         Main.init_log_file()
         in_path = Path(options["src_path"])
         bd_width = options.get("border_width")
-        bd_color = options.get("border_color")
-        output = options.get("output")
         if not bd_width or bd_width == 0:
-            logger.warning(f"No add border due to bad {bd_width=}")
+            logger.error(f"Bad border width: {bd_width=}")
+            return False
+        bd_color = options.get("border_color")
+        if not bd_color:
+            logger.error(f"Bad border color: {bd_color=}")
             return False
+        output = options.get("output")
         out = Path(output) if output else REPLACE
         if in_path.is_file():
             ok, _ = Border.border_1_image(in_path, out, bd_width, bd_color)
         else:
             ok = Border.border_all_in_dir(in_path, out, bd_width, bd_color)
+        Common.check_latest_version(PKG_NAME)
         return ok

pyproject.toml

@@ -4,8 +4,8 @@ requires = ["setuptools>=80.0"]
 
 [project]
 name = "batch_img"
-version = "0.0.8"
-description = "Batch processing image files by utilizing Pillow / PIL library"
+version = "0.0.9"
+description = "Batch processing (resize, rotate, add border) image files (HEIC, JPG, PNG)"
 readme = "README.md"
 authors = [{ name = "John Liu" }]
 license-files = ["LICENSE"]
@@ -20,12 +20,14 @@ requires-python = ">=3.12"
 dependencies = [
     "click",
     "loguru",
+    "numpy", # check orientation
+    "opencv-python", # check orientation by face
+    "packaging",
     "piexif",
     "pillow",
     "pillow-heif",
+    "requests",
     "tqdm",
-    "numpy", # check rotate
-    "opencv-python", # check rotate by face
 ]
 [project.scripts]
 batch_img = "batch_img.interface:cli"
@@ -85,8 +87,11 @@ exclude = [
     "**/build/",
     "**/generated/**/*.py",
 ]
+
 [tool.pytest.ini_options]
 markers = [
     "slow: marks tests as slow (deselect with '-m \"not slow\"')",
     "serial",
 ]
+[run]
+parallel = true

pyproject_release.toml

@@ -4,8 +4,8 @@ requires = ["setuptools>=80.0"]
 
 [project]
 name = "batch_img"
-version = "0.0.8"
-description = "Batch processing image files by utilizing Pillow / PIL library"
+version = "0.0.9"
+description = "Batch processing (resize, rotate, add border) image files (HEIC, JPG, PNG)"
 readme = "README.md"
 authors = [{ name = "John Liu" }]
 license-files = ["LICENSE"]
@@ -20,12 +20,14 @@ requires-python = ">=3.12"
 dependencies = [
     "click",
     "loguru",
+    "numpy",
+    "opencv-python",
+    "packaging",
     "piexif",
     "pillow",
     "pillow-heif",
+    "requests",
     "tqdm",
-    "numpy",
-    "opencv-python",
 ]
 [project.scripts]
 batch_img = "batch_img.interface:cli"

tests/cmd.txt

@@ -0,0 +1,3 @@
+curl --header 'Accept: application/json' -v "https://pypistats.org/api/packages/batch-img/recent?period=week" > ~/Downloads/stats.json
+
+curl --header 'Accept: application/json' -v "https://pypi.org/pypi/batch-img/json" > ~/Downloads/versions.json

tests/test_common.py

@@ -9,25 +9,60 @@
 from unittest.mock import MagicMock, patch
 
 import pytest
+import requests
 
 from batch_img.common import Common
 from batch_img.const import NAME, PKG_NAME, VER
 from .helper import DotDict
 
 
-@pytest.fixture(params=[({NAME: PKG_NAME, VER: "0.1.2"}, "0.0.8"), ({}, "0.0.8")])
+@pytest.fixture(params=[(PKG_NAME, "0.0.9"), ("", "0.0.9")])
 def ver_data(request):
     return request.param
 
 
 def test_get_version(ver_data):
-    fake_v, expected = ver_data
-    mock = MagicMock()
-    mock.version = expected
-    actual = Common.get_version()
+    pkg_name, expected = ver_data
+    actual = Common.get_version(pkg_name)
     assert actual == expected
 
 
+@pytest.fixture(
+    params=[
+        (PKG_NAME, f"✅ {PKG_NAME} is up to date (0.0.9)"),
+        (
+            "bad_bogus",
+            f"⚠️ Error get data from PyPI: https://pypi.org/pypi/bad_bogus/json",
+        ),
+    ]
+)
+def data_check_latest_version(request):
+    return request.param
+
+
+def test_check_latest_version(data_check_latest_version):
+    pkg_name, expected = data_check_latest_version
+    actual = Common.check_latest_version(pkg_name)
+    assert actual == expected
+
+
+@patch("requests.get")
+def test_error1_check_latest_version(mock_req_get):
+    mock_req_get.side_effect = requests.RequestException
+    actual = Common.check_latest_version(PKG_NAME)
+    assert actual == "requests.get() Exception: "
+
+
+@patch("requests.get")
+def test_error2_check_latest_version(mock_req_get):
+    mock_response = MagicMock()
+    mock_response.status_code = 200
+    mock_response.json.return_value = {"key": "value"}
+    mock_req_get.return_value = mock_response
+    actual = Common.check_latest_version(PKG_NAME)
+    assert actual == "Error parse PyPI response: 'info'"
+
+
 @pytest.fixture(
     params=[
         ({}, "cmd1 -op1 | grep k1", (0, "", "")),