fotolab 0.13.0__py2.py3-none-any.whl → 0.15.0__py2.py3-none-any.whl

fotolab/__init__.py

@@ -21,7 +21,7 @@ import subprocess
 import sys
 from pathlib import Path
 
-__version__ = "0.13.0"
+__version__ = "0.15.0"
 
 log = logging.getLogger(__name__)
 
@@ -48,7 +48,7 @@ def save_image(args, new_image, output_filename, subcommand):
         )
         new_filename.parent.mkdir(parents=True, exist_ok=True)
 
-    log.info("%s image: %s", subcommand, new_filename)
+    log.info("%s image: %s", subcommand, new_filename.resolve())
     new_image.save(new_filename)
 
     if args.open:
@@ -64,4 +64,4 @@ def _open_image(filename):
     elif sys.platform == "windows":
         os.startfile(filename)
 
-    log.info("open image: %s using default program.", filename.resolve())
+    log.info("open image: %s", filename.resolve())

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/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
@@ -41,6 +42,9 @@ log = logging.getLogger(__name__)
 
 def setup_logging(args: argparse.Namespace) -> None:
     """Set up logging by level."""
+    if args.verbose == 0:
+        logging.getLogger("PIL").setLevel(logging.ERROR)
+
     if args.quiet:
         logging.disable(logging.NOTSET)
     else:
@@ -104,6 +108,15 @@ def build_parser() -> argparse.ArgumentParser:
         help="suppress all logging",
     )
 
+    parser.add_argument(
+        "-v",
+        "--verbose",
+        default=0,
+        action="count",
+        dest="verbose",
+        help="show verbosity of debugging log, use -vv, -vvv for more details",
+    )
+
     parser.add_argument(
         "-d",
         "--debug",
@@ -121,6 +134,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)

fotolab/resize.py

@@ -17,6 +17,7 @@
 
 import argparse
 import logging
+import math
 
 from PIL import Image
 
@@ -24,6 +25,9 @@ from fotolab import save_image
 
 log = logging.getLogger(__name__)
 
+DEFAULT_WIDTH = 600
+DEFAULT_HEIGHT = 277
+
 
 def build_subparser(subparsers) -> None:
     """Build the subparser."""
@@ -40,23 +44,25 @@ def build_subparser(subparsers) -> None:
         metavar="IMAGE_FILENAMES",
     )
 
-    resize_parser.add_argument(
+    group = resize_parser.add_mutually_exclusive_group(required=False)
+
+    group.add_argument(
         "-wh",
         "--width",
         dest="width",
         help="set the width of the image (default: '%(default)s')",
         type=int,
-        default="600",
+        default=DEFAULT_WIDTH,
         metavar="WIDTH",
     )
 
-    resize_parser.add_argument(
+    group.add_argument(
         "-ht",
         "--height",
         dest="height",
         help="set the height of the image (default: '%(default)s')",
         type=int,
-        default="277",
+        default=DEFAULT_HEIGHT,
         metavar="HEIGHT",
     )
 
@@ -74,9 +80,37 @@ def run(args: argparse.Namespace) -> None:
 
     for image_filename in args.image_filenames:
         original_image = Image.open(image_filename)
+
+        new_width, new_height = _calc_new_image_dimension(original_image, args)
         resized_image = original_image.copy()
         resized_image = resized_image.resize(
-            (args.width, args.height), Image.Resampling.LANCZOS
+            (new_width, new_height), Image.Resampling.LANCZOS
         )
 
         save_image(args, resized_image, image_filename, "resize")
+
+
+def _calc_new_image_dimension(image, args) -> tuple:
+    new_width = args.width
+    new_height = args.height
+
+    old_width, old_height = image.size
+    log.debug("old image dimension: %d x %d", old_width, old_height)
+
+    if args.width != DEFAULT_WIDTH:
+        aspect_ratio = old_height / old_width
+        log.debug("aspect ratio: %f", aspect_ratio)
+
+        new_height = math.ceil(args.width * aspect_ratio)
+        log.debug("new height: %d", new_height)
+
+    if args.height != DEFAULT_HEIGHT:
+        aspect_ratio = old_width / old_height
+        log.debug("aspect ratio: %f", aspect_ratio)
+
+        new_width = math.floor(args.height * aspect_ratio)
+        log.debug("new width: %d", new_width)
+
+    log.debug("new image dimension: %d x %d", new_width, new_height)
+
+    return (new_width, new_height)

fotolab/sharpen.py

@@ -44,7 +44,7 @@ def build_subparser(subparsers) -> None:
         "-r",
         "--radius",
         dest="radius",
-        type=str,
+        type=int,
         default=1,
         help="set the radius or size of edges (default: '%(default)s')",
         metavar="RADIUS",
@@ -54,7 +54,7 @@ def build_subparser(subparsers) -> None:
         "-p",
         "--percent",
         dest="percent",
-        type=str,
+        type=int,
         default=100,
         help=(
             "set the amount of overall strength of sharpening effect "
@@ -67,7 +67,7 @@ def build_subparser(subparsers) -> None:
         "-t",
         "--threshold",
         dest="threshold",
-        type=str,
+        type=int,
         default=3,
         help=(
             "set the minimum brightness changed to be sharpened "

fotolab/watermark.py

@@ -17,6 +17,7 @@
 
 import argparse
 import logging
+import math
 
 from PIL import Image, ImageColor, ImageDraw, ImageFont
 
@@ -24,6 +25,9 @@ from fotolab import save_image
 
 log = logging.getLogger(__name__)
 
+FONT_SIZE_ASPECT_RATIO = 12 / 600
+FONT_PADDING_ASPECT_RATIO = 15 / 600
+FONT_OUTLINE_WIDTH_ASPECT_RATIO = 2 / 600
 POSITIONS = ["top-left", "top-right", "bottom-left", "bottom-right"]
 
 
@@ -140,19 +144,21 @@ def run(args: argparse.Namespace) -> None:
 
         draw = ImageDraw.Draw(watermarked_image)
 
-        font = ImageFont.truetype("arial.ttf", args.font_size)
+        font = ImageFont.truetype(
+            "arial.ttf", calc_font_size(original_image, args)
+        )
 
         (left, top, right, bottom) = draw.textbbox(
             xy=(0, 0), text=args.text, font=font
         )
         text_width = right - left
         text_height = bottom - top
-        (position_x, position_y) = calculate_position(
+        (position_x, position_y) = calc_position(
             watermarked_image,
             text_width,
             text_height,
             args.position,
-            args.padding,
+            calc_padding(original_image, args),
         )
 
         draw.text(
@@ -160,16 +166,49 @@ def run(args: argparse.Namespace) -> None:
             args.text,
             font=font,
             fill=(*ImageColor.getrgb(args.font_color), 128),
-            stroke_width=args.outline_width,
+            stroke_width=calc_font_outline_width(original_image, args),
             stroke_fill=(*ImageColor.getrgb(args.outline_color), 128),
         )
 
         save_image(args, watermarked_image, image_filename, "watermark")
 
 
-def calculate_position(
-    image, text_width, text_height, position, padding
-) -> tuple:
+def calc_font_size(image, args) -> int:
+    """Calculate the font size based on the width of the image."""
+    width, _height = image.size
+    new_font_size = args.font_size
+    if width > 600:
+        new_font_size = math.floor(FONT_SIZE_ASPECT_RATIO * width)
+
+    log.debug("new font size: %d", new_font_size)
+    return new_font_size
+
+
+def calc_font_outline_width(image, args) -> int:
+    """Calculate the font padding based on the width of the image."""
+    width, _height = image.size
+    new_font_outline_width = args.outline_width
+    if width > 600:
+        new_font_outline_width = math.floor(
+            FONT_OUTLINE_WIDTH_ASPECT_RATIO * width
+        )
+
+    log.debug("new font outline width: %d", new_font_outline_width)
+    return new_font_outline_width
+
+
+def calc_padding(image, args) -> int:
+    """Calculate the font padding based on the width of the image."""
+    width, _height = image.size
+    new_padding = args.padding
+    if width > 600:
+        new_padding = math.floor(FONT_PADDING_ASPECT_RATIO * width)
+
+    log.debug("new padding: %d", new_padding)
+    return new_padding
+
+
+def calc_position(image, text_width, text_height, position, padding) -> tuple:
     """Calculate the boundary coordinates of the watermark text."""
     if position == "top-left":
         position_x = 0 + padding

{fotolab-0.13.0.dist-info → fotolab-0.15.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fotolab
-Version: 0.13.0
+Version: 0.15.0
 Summary: A console program that manipulate images.
 Keywords: photography,photo
 Author-email: Kian-Meng Ang <kianmeng@cpan.org>
@@ -57,8 +57,8 @@ fotolab -h
 ```
 
 ```console
-usage: fotolab [-h] [-o] [-op] [-od OUTPUT_DIR] [-q] [-d] [-V]
-               {auto,border,contrast,info,resize,montage,sharpen,watermark,env}
+usage: fotolab [-h] [-o] [-op] [-od OUTPUT_DIR] [-q] [-v] [-d] [-V]
+               {animate,auto,border,contrast,info,resize,montage,sharpen,watermark,env}
                ...
 
 A console program to manipulate photos.
@@ -68,8 +68,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
@@ -87,10 +88,33 @@ optional arguments:
   -od OUTPUT_DIR, --output-dir OUTPUT_DIR
                     set default output folder (default: 'output')
   -q, --quiet       suppress all logging
+  -v, --verbose     show verbosity of debugging log, use -vv, -vvv for more details
   -d, --debug       show debugging log and stacktrace
   -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
@@ -179,7 +203,6 @@ fotolab montage -h
 ```
 
 ```console
-
 usage: fotolab montage [-h] IMAGE_FILENAMES [IMAGE_FILENAMES ...]
 
 positional arguments:
@@ -196,7 +219,7 @@ fotolab resize -h
 ```
 
 ```console
-usage: fotolab resize [-h] [-wh WIDTH] [-ht HEIGHT]
+usage: fotolab resize [-h] [-wh WIDTH | -ht HEIGHT]
                       IMAGE_FILENAMES [IMAGE_FILENAMES ...]
 
 positional arguments:

fotolab-0.15.0.dist-info/RECORD

@@ -0,0 +1,18 @@
+fotolab/__init__.py,sha256=MgF4Bm8__GfCAghI7CvQRO6IuZSuNoPHe7A8qJu5BME,2061
+fotolab/__main__.py,sha256=aboOURPs_snOXTEWYR0q8oq1UTY9e-NxCd1j33V0wHI,833
+fotolab/animate.py,sha256=ejimhTozo9DN7BbqqcV4x8zLnanZRKq1pxBBFeOdr6Q,2967
+fotolab/auto.py,sha256=1Toxe8pA_tq15g1-imMFuHf1L94Ac7EthPTu7E8SAzE,2217
+fotolab/border.py,sha256=5ch2d7LVPhB2OFuuXSW5ci6Cn967CPDQu0qSfaO7uMg,3591
+fotolab/cli.py,sha256=hKlSoomuwhXsMOTWOxjASlt0a25kDOqu7Lsg6d5Elfs,4939
+fotolab/contrast.py,sha256=l7Bs5p8W8ypN9Cg3fFHnU-A20UwMKtjTiPk6D0PRwpM,2095
+fotolab/env.py,sha256=NTTvfISWBBfIw5opWrUfg0BtkaAtdUtcISBAJC2gVUk,1449
+fotolab/info.py,sha256=DawXTQJiQDBwy0Ml5Ysk8MvKga3ikp_aIw73AR3LdZo,1687
+fotolab/montage.py,sha256=lUVY-zDSH7mwH-s34_XefdNp7CoDJHkwpbTUGiyJGgs,2037
+fotolab/resize.py,sha256=cvPfh4wUfydM23Do7VnP6Bx2EqMHKfYFYrpiNhyWzCU,3259
+fotolab/sharpen.py,sha256=wUPtJdtB6mCRmcHrA0CoEVO0O0ROBJWhejTvUeL67QU,2655
+fotolab/watermark.py,sha256=3yHqtrh6WtFcGArgrpKAL6849Y2R1Fk-g3FeKdejrz0,6513
+fotolab-0.15.0.dist-info/entry_points.txt,sha256=mvw7AY_yZkIyjAxPtHNed9X99NZeLnMxEeAfEJUbrCM,44
+fotolab-0.15.0.dist-info/LICENSE.md,sha256=tGtFDwxWTjuR9syrJoSv1Hiffd2u8Tu8cYClfrXS_YU,31956
+fotolab-0.15.0.dist-info/WHEEL,sha256=Sgu64hAMa6g5FdzHxXv9Xdse9yxpGGMeagVtPMWpJQY,99
+fotolab-0.15.0.dist-info/METADATA,sha256=mKiBo5IuAm5fp-mGW3Wz1ukk45QVfdaWcSwoOqU0KbY,9830
+fotolab-0.15.0.dist-info/RECORD,,

fotolab-0.13.0.dist-info/RECORD

@@ -1,17 +0,0 @@
-fotolab/__init__.py,sha256=Z3guoQD823MHOmrtHNE9W0RnI6neYdRWNCv7QTxQb6s,2074
-fotolab/__main__.py,sha256=aboOURPs_snOXTEWYR0q8oq1UTY9e-NxCd1j33V0wHI,833
-fotolab/auto.py,sha256=1Toxe8pA_tq15g1-imMFuHf1L94Ac7EthPTu7E8SAzE,2217
-fotolab/border.py,sha256=5ch2d7LVPhB2OFuuXSW5ci6Cn967CPDQu0qSfaO7uMg,3591
-fotolab/cli.py,sha256=KoSDb752mewrtKE5wDs9icXF2McBVOKoEB98KYAV-jQ,4570
-fotolab/contrast.py,sha256=l7Bs5p8W8ypN9Cg3fFHnU-A20UwMKtjTiPk6D0PRwpM,2095
-fotolab/env.py,sha256=NTTvfISWBBfIw5opWrUfg0BtkaAtdUtcISBAJC2gVUk,1449
-fotolab/info.py,sha256=DawXTQJiQDBwy0Ml5Ysk8MvKga3ikp_aIw73AR3LdZo,1687
-fotolab/montage.py,sha256=lUVY-zDSH7mwH-s34_XefdNp7CoDJHkwpbTUGiyJGgs,2037
-fotolab/resize.py,sha256=y3JT2IZUOeWf4gjORtaJ_ZseklO2jG6XvR-d6EdhS0k,2242
-fotolab/sharpen.py,sha256=DsbIe4VU0Ty5oVzKnU70p9dMfhKr1i_UAQDimzAGX-Y,2655
-fotolab/watermark.py,sha256=6LeK5g6W7Gq5kpLinwqBCwFGCtp0Uz_hrqBE3BD_CEU,5210
-fotolab-0.13.0.dist-info/entry_points.txt,sha256=mvw7AY_yZkIyjAxPtHNed9X99NZeLnMxEeAfEJUbrCM,44
-fotolab-0.13.0.dist-info/LICENSE.md,sha256=tGtFDwxWTjuR9syrJoSv1Hiffd2u8Tu8cYClfrXS_YU,31956
-fotolab-0.13.0.dist-info/WHEEL,sha256=Sgu64hAMa6g5FdzHxXv9Xdse9yxpGGMeagVtPMWpJQY,99
-fotolab-0.13.0.dist-info/METADATA,sha256=v1RC94R2HI1BVbz7dyA3nAVuGso-OsRmDZQvrHnCfuU,9085
-fotolab-0.13.0.dist-info/RECORD,,