fotolab 0.13.0__tar.gz → 0.14.0__tar.gz

{fotolab-0.13.0 → fotolab-0.14.0}/.pre-commit-config.yaml

@@ -45,7 +45,7 @@ repos:
           - --py=312
 
   - repo: https://github.com/psf/black
-    rev: 24.4.0
+    rev: 24.4.2
     hooks:
       - id: black
         language_version: python3.12
@@ -107,7 +107,7 @@ repos:
           - --disable=R0801,W0212
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.9.0
+    rev: v1.10.0
     hooks:
       - id: mypy
         exclude: docs/

{fotolab-0.13.0 → fotolab-0.14.0}/CHANGELOG.md

@@ -7,6 +7,16 @@ and this project adheres to [0-based versioning](https://0ver.org/).
 
 ## [Unreleased]
 
+## v0.14.0 (2024-04-28)
+
+### Added
+
+- Add `animate` subcommand to create animated `gif` image
+
+### Changed
+
+- Bump deps and `pre-commit` hooks
+
 ## v0.13.0 (2024-04-21)
 
 ### Changed

{fotolab-0.13.0 → fotolab-0.14.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fotolab
-Version: 0.13.0
+Version: 0.14.0
 Summary: A console program that manipulate images.
 Keywords: photography,photo
 Author-email: Kian-Meng Ang <kianmeng@cpan.org>
@@ -57,8 +57,9 @@ fotolab -h
 ```
 
 ```console
+
 usage: fotolab [-h] [-o] [-op] [-od OUTPUT_DIR] [-q] [-d] [-V]
-               {auto,border,contrast,info,resize,montage,sharpen,watermark,env}
+               {animate,auto,border,contrast,info,resize,montage,sharpen,watermark,env}
                ...
 
 A console program to manipulate photos.
@@ -68,8 +69,9 @@ A console program to manipulate photos.
   issues: https://github.com/kianmeng/fotolab/issues
 
 positional arguments:
-  {auto,border,contrast,info,resize,montage,sharpen,watermark,env}
+  {animate,auto,border,contrast,info,resize,montage,sharpen,watermark,env}
                     sub-command help
+    animate         animate an image
     auto            auto adjust (resize, contrast, and watermark) a photo
     border          add border to image
     contrast        contrast an image
@@ -91,6 +93,29 @@ optional arguments:
   -V, --version     show program's version number and exit
 ```
 
+### fotolab animate
+
+```console
+fotolab animate -h
+```
+
+```console
+
+usage: fotolab animate [-h] [-f FORMAT] [-d DURATION] [-l LOOP]
+                       IMAGE_FILENAMES [IMAGE_FILENAMES ...]
+
+positional arguments:
+  IMAGE_FILENAMES       set the image filenames
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -f FORMAT, --format FORMAT
+                        set the image format (default: 'gif')
+  -d DURATION, --duration DURATION
+                        set the duration in milliseconds (default: '2500')
+  -l LOOP, --loop LOOP  set the loop cycle (default: '0')
+```
+
 ### fotolab auto
 
 ```console

{fotolab-0.13.0 → fotolab-0.14.0}/Pipfile.lock

@@ -261,11 +261,11 @@
         },
         "identify": {
             "hashes": [
-                "sha256:10a7ca245cfcd756a554a7288159f72ff105ad233c7c4b9c6f0f4d108f5f6791",
-                "sha256:c4de0081837b211594f8e877a6b4fad7ca32bbfc1a9307fdd61c28bfe923f13e"
+                "sha256:37d93f380f4de590500d9dba7db359d0d3da95ffe7f9de1753faa159e71e7dfa",
+                "sha256:e5e00f54165f9047fbebeb4a560f9acfb8af4c88232be60a488e9b68d122745d"
             ],
             "markers": "python_version >= '3.8'",
-            "version": "==2.5.35"
+            "version": "==2.5.36"
         },
         "importlib-metadata": {
             "hashes": [
@@ -394,11 +394,11 @@
         },
         "pluggy": {
             "hashes": [
-                "sha256:7db9f7b503d67d1c5b95f59773ebb58a8c1c288129a88665838012cfb07b8981",
-                "sha256:8c85c2876142a764e5b7548e7d9a0e0ddb46f5185161049a79b7e974454223be"
+                "sha256:2cffa88e94fdc978c4c574f15f9e59b7f4201d439195c3715ca9e2486f1d0cf1",
+                "sha256:44e1ad92c8ca002de6377e165f3e0f1be63266ab4d554740532335b9d75ea669"
             ],
             "markers": "python_version >= '3.8'",
-            "version": "==1.4.0"
+            "version": "==1.5.0"
         },
         "pre-commit": {
             "hashes": [
@@ -860,12 +860,12 @@
         },
         "myst-parser": {
             "hashes": [
-                "sha256:7c36344ae39c8e740dad7fdabf5aa6fc4897a813083c6cc9990044eb93656b14",
-                "sha256:ea929a67a6a0b1683cdbe19b8d2e724cd7643f8aa3e7bb18dd65beac3483bead"
+                "sha256:0b4ae0b33a45800a748260cb40348c37089a8a456c35120609240bd1b32f9255",
+                "sha256:8ee926557b8e4c2940a1e62c5720e1667cfaf8480b94b1b9c77dc38e31d104aa"
             ],
             "index": "pypi",
             "markers": "python_version >= '3.8'",
-            "version": "==2.0.0"
+            "version": "==3.0.0"
         },
         "packaging": {
             "hashes": [

{fotolab-0.13.0 → fotolab-0.14.0}/README.md

@@ -35,8 +35,9 @@ fotolab -h
 ```
 
 ```console
+
 usage: fotolab [-h] [-o] [-op] [-od OUTPUT_DIR] [-q] [-d] [-V]
-               {auto,border,contrast,info,resize,montage,sharpen,watermark,env}
+               {animate,auto,border,contrast,info,resize,montage,sharpen,watermark,env}
                ...
 
 A console program to manipulate photos.
@@ -46,8 +47,9 @@ A console program to manipulate photos.
   issues: https://github.com/kianmeng/fotolab/issues
 
 positional arguments:
-  {auto,border,contrast,info,resize,montage,sharpen,watermark,env}
+  {animate,auto,border,contrast,info,resize,montage,sharpen,watermark,env}
                     sub-command help
+    animate         animate an image
     auto            auto adjust (resize, contrast, and watermark) a photo
     border          add border to image
     contrast        contrast an image
@@ -69,6 +71,29 @@ optional arguments:
   -V, --version     show program's version number and exit
 ```
 
+### fotolab animate
+
+```console
+fotolab animate -h
+```
+
+```console
+
+usage: fotolab animate [-h] [-f FORMAT] [-d DURATION] [-l LOOP]
+                       IMAGE_FILENAMES [IMAGE_FILENAMES ...]
+
+positional arguments:
+  IMAGE_FILENAMES       set the image filenames
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -f FORMAT, --format FORMAT
+                        set the image format (default: 'gif')
+  -d DURATION, --duration DURATION
+                        set the duration in milliseconds (default: '2500')
+  -l LOOP, --loop LOOP  set the loop cycle (default: '0')
+```
+
 ### fotolab auto
 
 ```console

{fotolab-0.13.0 → fotolab-0.14.0}/fotolab/__init__.py

@@ -21,7 +21,7 @@ import subprocess
 import sys
 from pathlib import Path
 
-__version__ = "0.13.0"
+__version__ = "0.14.0"
 
 log = logging.getLogger(__name__)
 

fotolab-0.14.0/fotolab/animate.py

@@ -0,0 +1,114 @@
+# Copyright (C) 2024 Kian-Meng Ang
+#
+# This program is free software: you can redistribute it and/or modify it under
+# the terms of the GNU Affero General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option) any
+# later version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
+# details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+"""Animate subcommand."""
+
+import argparse
+import logging
+from pathlib import Path
+
+from PIL import Image
+
+from fotolab import _open_image
+
+log = logging.getLogger(__name__)
+
+
+def build_subparser(subparsers) -> None:
+    """Build the subparser."""
+    animate_parser = subparsers.add_parser("animate", help="animate an image")
+
+    animate_parser.set_defaults(func=run)
+
+    animate_parser.add_argument(
+        dest="image_filenames",
+        help="set the image filenames",
+        nargs="+",
+        type=str,
+        default=None,
+        metavar="IMAGE_FILENAMES",
+    )
+
+    animate_parser.add_argument(
+        "-f",
+        "--format",
+        dest="format",
+        type=str,
+        choices=["gif", "webp"],
+        default="gif",
+        help="set the image format (default: '%(default)s')",
+        metavar="FORMAT",
+    )
+
+    animate_parser.add_argument(
+        "-d",
+        "--duration",
+        dest="duration",
+        type=int,
+        default=2500,
+        help="set the duration in milliseconds (default: '%(default)s')",
+        metavar="DURATION",
+    )
+
+    animate_parser.add_argument(
+        "-l",
+        "--loop",
+        dest="loop",
+        type=int,
+        default=0,
+        help="set the loop cycle (default: '%(default)s')",
+        metavar="LOOP",
+    )
+
+
+def run(args: argparse.Namespace) -> None:
+    """Run animate subcommand.
+
+    Args:
+        config (argparse.Namespace): Config from command line arguments
+
+    Returns:
+        None
+    """
+    log.debug(args)
+
+    first_image = args.image_filenames[0]
+    animated_image = Image.open(first_image)
+
+    append_images = []
+    for image_filename in args.image_filenames[1:]:
+        append_images.append(Image.open(image_filename))
+
+    image_file = Path(first_image)
+    new_filename = Path(
+        args.output_dir,
+        image_file.with_name(f"animate_{image_file.stem}.{args.format}"),
+    )
+    new_filename.parent.mkdir(parents=True, exist_ok=True)
+
+    log.info("animate image: %s", new_filename)
+
+    animated_image.save(
+        new_filename,
+        format=args.format,
+        append_images=append_images,
+        save_all=True,
+        duration=args.duration,
+        loop=args.loop,
+        optimize=True,
+    )
+
+    if args.open:
+        _open_image(new_filename)

{fotolab-0.13.0 → fotolab-0.14.0}/fotolab/cli.py

@@ -25,6 +25,7 @@ import logging
 import sys
 from typing import Dict, Optional, Sequence
 
+import fotolab.animate
 import fotolab.auto
 import fotolab.border
 import fotolab.contrast
@@ -121,6 +122,7 @@ def build_parser() -> argparse.ArgumentParser:
     )
 
     subparsers = parser.add_subparsers(help="sub-command help")
+    fotolab.animate.build_subparser(subparsers)
     fotolab.auto.build_subparser(subparsers)
     fotolab.border.build_subparser(subparsers)
     fotolab.contrast.build_subparser(subparsers)