fotolab 0.18.4__tar.gz → 0.19.0__tar.gz

{fotolab-0.18.4 → fotolab-0.19.0}/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [0-based versioning](https://0ver.org/).
 
 ## [Unreleased]
 
+## v0.19.0 (2024-11-03)
+
+- Add `-c` or `--canvas` flag to paste an image onto larger canvas
+- Bump deps
+- Require both length and height when `--canvas` flag is toggled
+
 ## v0.18.4 (2024-10-27)
 
 - Bump deps and `pre-commit` hooks

{fotolab-0.18.4 → fotolab-0.19.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fotolab
-Version: 0.18.4
+Version: 0.19.0
 Summary: A console program that manipulate images.
 Keywords: photography,photo
 Author-email: Kian-Meng Ang <kianmeng@cpan.org>
@@ -60,14 +60,13 @@ fotolab -h
 
 ```console
 usage: fotolab [-h] [-o] [-op] [-od OUTPUT_DIR] [-q] [-v] [-d] [-V]
-               {animate,auto,border,contrast,info,resize,rotate,montage,sharpen,watermark,env}
-               ...
+               {animate,auto,border,contrast,info,resize,rotate,montage,sharpen,watermark,env} ...
 
 A console program to manipulate photos.
 
-  website: https://github.com/kianmeng/fotolab
-  changelog: https://github.com/kianmeng/fotolab/blob/master/CHANGELOG.md
-  issues: https://github.com/kianmeng/fotolab/issues
+website: https://github.com/kianmeng/fotolab
+changelog: https://github.com/kianmeng/fotolab/blob/master/CHANGELOG.md
+issues: https://github.com/kianmeng/fotolab/issues
 
 positional arguments:
   {animate,auto,border,contrast,info,resize,rotate,montage,sharpen,watermark,env}
@@ -88,7 +87,7 @@ options:
   -h, --help        show this help message and exit
   -o, --overwrite   overwrite existing image
   -op, --open       open the image using default program (default: 'False')
-  -od OUTPUT_DIR, --output-dir OUTPUT_DIR
+  -od, --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
@@ -115,11 +114,10 @@ positional arguments:
 
 options:
   -h, --help            show this help message and exit
-  -f FORMAT, --format FORMAT
-                        set the image format (default: 'gif')
-  -d DURATION, --duration DURATION
+  -f, --format FORMAT   set the image format (default: 'gif')
+  -d, --duration DURATION
                         set the duration in milliseconds (default: '2500')
-  -l LOOP, --loop LOOP  set the loop cycle (default: '0')
+  -l, --loop LOOP       set the loop cycle (default: '0')
 ```
 
 <!--help-animate !-->
@@ -162,17 +160,15 @@ positional arguments:
 
 options:
   -h, --help            show this help message and exit
-  -c COLOR, --color COLOR
-                        set the color of border (default: 'black')
-  -w WIDTH, --width WIDTH
-                        set the width of border (default: '10')
-  -wt WIDTH, --width-top WIDTH
+  -c, --color COLOR     set the color of border (default: 'black')
+  -w, --width WIDTH     set the width of border (default: '10')
+  -wt, --width-top WIDTH
                         set the width of top border (default: '0')
-  -wr WIDTH, --width-right WIDTH
+  -wr, --width-right WIDTH
                         set the width of right border (default: '0')
-  -wb WIDTH, --width-bottom WIDTH
+  -wb, --width-bottom WIDTH
                         set the width of bottom border (default: '0')
-  -wl WIDTH, --width-left WIDTH
+  -wl, --width-left WIDTH
                         set the width of left border (default: '0')
 ```
 
@@ -190,13 +186,12 @@ fotolab contrast -h
 usage: fotolab contrast [-h] [-c CUTOFF] IMAGE_FILENAMES [IMAGE_FILENAMES ...]
 
 positional arguments:
-  IMAGE_FILENAMES       set the image filename
+  IMAGE_FILENAMES      set the image filename
 
 options:
-  -h, --help            show this help message and exit
-  -c CUTOFF, --cutoff CUTOFF
-                        set the percentage of lightest or darkest pixels to
-                        discard from histogram (default: '1')
+  -h, --help           show this help message and exit
+  -c, --cutoff CUTOFF  set the percentage of lightest or darkest pixels to
+                       discard from histogram (default: '1')
 ```
 
 <!--help-contrast !-->
@@ -271,18 +266,17 @@ fotolab resize -h
 <!--help-resize !-->
 
 ```console
-usage: fotolab resize [-h] [-wh WIDTH | -ht HEIGHT]
+usage: fotolab resize [-h] [-c] [-W WIDTH | -H HEIGHT]
                       IMAGE_FILENAMES [IMAGE_FILENAMES ...]
 
 positional arguments:
-  IMAGE_FILENAMES       set the image filename
+  IMAGE_FILENAMES      set the image filename
 
 options:
-  -h, --help            show this help message and exit
-  -wh WIDTH, --width WIDTH
-                        set the width of the image (default: '600')
-  -ht HEIGHT, --height HEIGHT
-                        set the height of the image (default: '277')
+  -h, --help           show this help message and exit
+  -c, --canvas         paste image onto a larger canvas
+  -W, --width WIDTH    set the width of the image (default: '600')
+  -H, --height HEIGHT  set the height of the image (default: '277')
 ```
 
 <!--help-resize !-->
@@ -304,12 +298,11 @@ positional arguments:
 
 options:
   -h, --help            show this help message and exit
-  -r RADIUS, --radius RADIUS
-                        set the radius or size of edges (default: '1')
-  -p PERCENT, --percent PERCENT
+  -r, --radius RADIUS   set the radius or size of edges (default: '1')
+  -p, --percent PERCENT
                         set the amount of overall strength of sharpening
                         effect (default: '100')
-  -t THRESHOLD, --threshold THRESHOLD
+  -t, --threshold THRESHOLD
                         set the minimum brightness changed to be sharpened
                         (default: '3')
 ```
@@ -329,6 +322,7 @@ usage: fotolab watermark [-h] [-t WATERMARK_TEXT]
                          [-p {top-left,top-right,bottom-left,bottom-right}]
                          [-pd PADDING] [-fs FONT_SIZE] [-fc FONT_COLOR]
                          [-ow OUTLINE_WIDTH] [-oc OUTLINE_COLOR] [--camera]
+                         [-l]
                          IMAGE_FILENAMES [IMAGE_FILENAMES ...]
 
 positional arguments:
@@ -336,26 +330,27 @@ positional arguments:
 
 options:
   -h, --help            show this help message and exit
-  -t WATERMARK_TEXT, --text WATERMARK_TEXT
+  -t, --text WATERMARK_TEXT
                         set the watermark text (default: 'kianmeng.org')
-  -p {top-left,top-right,bottom-left,bottom-right}, --position {top-left,top-right,bottom-left,bottom-right}
+  -p, --position {top-left,top-right,bottom-left,bottom-right}
                         set position of the watermark text (default: 'bottom-
                         left')
-  -pd PADDING, --padding PADDING
+  -pd, --padding PADDING
                         set the padding of the watermark text relative to the
                         image (default: '15')
-  -fs FONT_SIZE, --font-size FONT_SIZE
+  -fs, --font-size FONT_SIZE
                         set the font size of watermark text (default: '12')
-  -fc FONT_COLOR, --font-color FONT_COLOR
+  -fc, --font-color FONT_COLOR
                         set the font color of watermark text (default:
                         'white')
-  -ow OUTLINE_WIDTH, --outline-width OUTLINE_WIDTH
+  -ow, --outline-width OUTLINE_WIDTH
                         set the outline width of the watermark text (default:
                         '2')
-  -oc OUTLINE_COLOR, --outline-color OUTLINE_COLOR
+  -oc, --outline-color OUTLINE_COLOR
                         set the outline color of the watermark text (default:
                         'black')
   --camera              use camera metadata as watermark
+  -l, --lowercase       lowercase the watermark text
 ```
 
 <!--help-watermark !-->

{fotolab-0.18.4 → fotolab-0.19.0}/Pipfile.lock

@@ -261,11 +261,11 @@
         },
         "colorlog": {
             "hashes": [
-                "sha256:3e3e079a41feb5a1b64f978b5ea4f46040a94f11f0e8bbb8261e3dbbeca64d44",
-                "sha256:4dcbb62368e2800cb3c5abd348da7e53f6c362dda502ec27c560b2e58a66bd33"
+                "sha256:5906e71acd67cb07a71e779c47c4bcb45fb8c2993eebe9e5adcd6a6f1b283eff",
+                "sha256:bfba54a1b93b94f54e1f4fe48395725a3d92fd2a4af702f6bd70946bdc0c6ac2"
             ],
             "markers": "python_version >= '3.6'",
-            "version": "==6.8.2"
+            "version": "==6.9.0"
         },
         "coverage": {
             "extras": [
@@ -766,12 +766,12 @@
         },
         "pytest-cov": {
             "hashes": [
-                "sha256:4f0764a1219df53214206bf1feea4633c3b558a2925c8b59f144f682861ce652",
-                "sha256:5837b58e9f6ebd335b0f8060eecce69b662415b16dc503883a02f45dfeb14857"
+                "sha256:eee6f1b9e61008bd34975a4d5bab25801eb31898b032dd55addc93e96fcaaa35",
+                "sha256:fde0b595ca248bb8e2d76f020b465f3b107c9632e6a1d1705f17834c89dcadc0"
             ],
             "index": "pypi",
-            "markers": "python_version >= '3.8'",
-            "version": "==5.0.0"
+            "markers": "python_version >= '3.9'",
+            "version": "==6.0.0"
         },
         "pytest-randomly": {
             "hashes": [
@@ -966,11 +966,11 @@
         },
         "virtualenv": {
             "hashes": [
-                "sha256:2ca56a68ed615b8fe4326d11a0dca5dfbe8fd68510fb6c6349163bed3c15f2b2",
-                "sha256:44a72c29cceb0ee08f300b314848c86e57bf8d1f13107a5e671fb9274138d655"
+                "sha256:142c6be10212543b32c6c45d3d3893dff89112cc588b7d0879ae5a1ec03a47ba",
+                "sha256:f11f1b8a29525562925f745563bfd48b189450f61fb34c4f9cc79dd5aa32a1f4"
             ],
             "markers": "python_version >= '3.8'",
-            "version": "==20.27.0"
+            "version": "==20.27.1"
         },
         "zipp": {
             "hashes": [

{fotolab-0.18.4 → fotolab-0.19.0}/README.md

@@ -38,14 +38,13 @@ fotolab -h
 
 ```console
 usage: fotolab [-h] [-o] [-op] [-od OUTPUT_DIR] [-q] [-v] [-d] [-V]
-               {animate,auto,border,contrast,info,resize,rotate,montage,sharpen,watermark,env}
-               ...
+               {animate,auto,border,contrast,info,resize,rotate,montage,sharpen,watermark,env} ...
 
 A console program to manipulate photos.
 
-  website: https://github.com/kianmeng/fotolab
-  changelog: https://github.com/kianmeng/fotolab/blob/master/CHANGELOG.md
-  issues: https://github.com/kianmeng/fotolab/issues
+website: https://github.com/kianmeng/fotolab
+changelog: https://github.com/kianmeng/fotolab/blob/master/CHANGELOG.md
+issues: https://github.com/kianmeng/fotolab/issues
 
 positional arguments:
   {animate,auto,border,contrast,info,resize,rotate,montage,sharpen,watermark,env}
@@ -66,7 +65,7 @@ options:
   -h, --help        show this help message and exit
   -o, --overwrite   overwrite existing image
   -op, --open       open the image using default program (default: 'False')
-  -od OUTPUT_DIR, --output-dir OUTPUT_DIR
+  -od, --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
@@ -93,11 +92,10 @@ positional arguments:
 
 options:
   -h, --help            show this help message and exit
-  -f FORMAT, --format FORMAT
-                        set the image format (default: 'gif')
-  -d DURATION, --duration DURATION
+  -f, --format FORMAT   set the image format (default: 'gif')
+  -d, --duration DURATION
                         set the duration in milliseconds (default: '2500')
-  -l LOOP, --loop LOOP  set the loop cycle (default: '0')
+  -l, --loop LOOP       set the loop cycle (default: '0')
 ```
 
 <!--help-animate !-->
@@ -140,17 +138,15 @@ positional arguments:
 
 options:
   -h, --help            show this help message and exit
-  -c COLOR, --color COLOR
-                        set the color of border (default: 'black')
-  -w WIDTH, --width WIDTH
-                        set the width of border (default: '10')
-  -wt WIDTH, --width-top WIDTH
+  -c, --color COLOR     set the color of border (default: 'black')
+  -w, --width WIDTH     set the width of border (default: '10')
+  -wt, --width-top WIDTH
                         set the width of top border (default: '0')
-  -wr WIDTH, --width-right WIDTH
+  -wr, --width-right WIDTH
                         set the width of right border (default: '0')
-  -wb WIDTH, --width-bottom WIDTH
+  -wb, --width-bottom WIDTH
                         set the width of bottom border (default: '0')
-  -wl WIDTH, --width-left WIDTH
+  -wl, --width-left WIDTH
                         set the width of left border (default: '0')
 ```
 
@@ -168,13 +164,12 @@ fotolab contrast -h
 usage: fotolab contrast [-h] [-c CUTOFF] IMAGE_FILENAMES [IMAGE_FILENAMES ...]
 
 positional arguments:
-  IMAGE_FILENAMES       set the image filename
+  IMAGE_FILENAMES      set the image filename
 
 options:
-  -h, --help            show this help message and exit
-  -c CUTOFF, --cutoff CUTOFF
-                        set the percentage of lightest or darkest pixels to
-                        discard from histogram (default: '1')
+  -h, --help           show this help message and exit
+  -c, --cutoff CUTOFF  set the percentage of lightest or darkest pixels to
+                       discard from histogram (default: '1')
 ```
 
 <!--help-contrast !-->
@@ -249,18 +244,17 @@ fotolab resize -h
 <!--help-resize !-->
 
 ```console
-usage: fotolab resize [-h] [-wh WIDTH | -ht HEIGHT]
+usage: fotolab resize [-h] [-c] [-W WIDTH | -H HEIGHT]
                       IMAGE_FILENAMES [IMAGE_FILENAMES ...]
 
 positional arguments:
-  IMAGE_FILENAMES       set the image filename
+  IMAGE_FILENAMES      set the image filename
 
 options:
-  -h, --help            show this help message and exit
-  -wh WIDTH, --width WIDTH
-                        set the width of the image (default: '600')
-  -ht HEIGHT, --height HEIGHT
-                        set the height of the image (default: '277')
+  -h, --help           show this help message and exit
+  -c, --canvas         paste image onto a larger canvas
+  -W, --width WIDTH    set the width of the image (default: '600')
+  -H, --height HEIGHT  set the height of the image (default: '277')
 ```
 
 <!--help-resize !-->
@@ -282,12 +276,11 @@ positional arguments:
 
 options:
   -h, --help            show this help message and exit
-  -r RADIUS, --radius RADIUS
-                        set the radius or size of edges (default: '1')
-  -p PERCENT, --percent PERCENT
+  -r, --radius RADIUS   set the radius or size of edges (default: '1')
+  -p, --percent PERCENT
                         set the amount of overall strength of sharpening
                         effect (default: '100')
-  -t THRESHOLD, --threshold THRESHOLD
+  -t, --threshold THRESHOLD
                         set the minimum brightness changed to be sharpened
                         (default: '3')
 ```
@@ -307,6 +300,7 @@ usage: fotolab watermark [-h] [-t WATERMARK_TEXT]
                          [-p {top-left,top-right,bottom-left,bottom-right}]
                          [-pd PADDING] [-fs FONT_SIZE] [-fc FONT_COLOR]
                          [-ow OUTLINE_WIDTH] [-oc OUTLINE_COLOR] [--camera]
+                         [-l]
                          IMAGE_FILENAMES [IMAGE_FILENAMES ...]
 
 positional arguments:
@@ -314,26 +308,27 @@ positional arguments:
 
 options:
   -h, --help            show this help message and exit
-  -t WATERMARK_TEXT, --text WATERMARK_TEXT
+  -t, --text WATERMARK_TEXT
                         set the watermark text (default: 'kianmeng.org')
-  -p {top-left,top-right,bottom-left,bottom-right}, --position {top-left,top-right,bottom-left,bottom-right}
+  -p, --position {top-left,top-right,bottom-left,bottom-right}
                         set position of the watermark text (default: 'bottom-
                         left')
-  -pd PADDING, --padding PADDING
+  -pd, --padding PADDING
                         set the padding of the watermark text relative to the
                         image (default: '15')
-  -fs FONT_SIZE, --font-size FONT_SIZE
+  -fs, --font-size FONT_SIZE
                         set the font size of watermark text (default: '12')
-  -fc FONT_COLOR, --font-color FONT_COLOR
+  -fc, --font-color FONT_COLOR
                         set the font color of watermark text (default:
                         'white')
-  -ow OUTLINE_WIDTH, --outline-width OUTLINE_WIDTH
+  -ow, --outline-width OUTLINE_WIDTH
                         set the outline width of the watermark text (default:
                         '2')
-  -oc OUTLINE_COLOR, --outline-color OUTLINE_COLOR
+  -oc, --outline-color OUTLINE_COLOR
                         set the outline color of the watermark text (default:
                         'black')
   --camera              use camera metadata as watermark
+  -l, --lowercase       lowercase the watermark text
 ```
 
 <!--help-watermark !-->

{fotolab-0.18.4 → fotolab-0.19.0}/fotolab/__init__.py

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

{fotolab-0.18.4 → fotolab-0.19.0}/fotolab/auto.py

@@ -68,6 +68,7 @@ def run(args: argparse.Namespace) -> None:
         "outline_color": "black",
         "padding": 15,
         "camera": False,
+        "canvas": False,
         "lowercase": False,
     }
     combined_args = argparse.Namespace(**vars(args), **extra_args)

{fotolab-0.18.4 → fotolab-0.19.0}/fotolab/resize.py

@@ -18,6 +18,7 @@
 import argparse
 import logging
 import math
+import sys
 
 from PIL import Image
 
@@ -44,27 +45,57 @@ def build_subparser(subparsers) -> None:
         metavar="IMAGE_FILENAMES",
     )
 
-    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=DEFAULT_WIDTH,
-        metavar="WIDTH",
+    resize_parser.add_argument(
+        "-c",
+        "--canvas",
+        default=False,
+        action="store_true",
+        dest="canvas",
+        help="paste image onto a larger canvas",
     )
 
-    group.add_argument(
-        "-ht",
-        "--height",
-        dest="height",
-        help="set the height of the image (default: '%(default)s')",
-        type=int,
-        default=DEFAULT_HEIGHT,
-        metavar="HEIGHT",
-    )
+    if "-c" in sys.argv or "--canvas" in sys.argv:
+        resize_parser.add_argument(
+            "-W",
+            "--width",
+            dest="width",
+            help="set the width of the image (default: '%(default)s')",
+            type=int,
+            required=True,
+            metavar="WIDTH",
+        )
+
+        resize_parser.add_argument(
+            "-H",
+            "--height",
+            dest="height",
+            help="set the height of the image (default: '%(default)s')",
+            type=int,
+            required=True,
+            metavar="HEIGHT",
+        )
+    else:
+        group = resize_parser.add_mutually_exclusive_group(required=False)
+
+        group.add_argument(
+            "-W",
+            "--width",
+            dest="width",
+            help="set the width of the image (default: '%(default)s')",
+            type=int,
+            default=DEFAULT_WIDTH,
+            metavar="WIDTH",
+        )
+
+        group.add_argument(
+            "-H",
+            "--height",
+            dest="height",
+            help="set the height of the image (default: '%(default)s')",
+            type=int,
+            default=DEFAULT_HEIGHT,
+            metavar="HEIGHT",
+        )
 
 
 def run(args: argparse.Namespace) -> None:
@@ -80,14 +111,28 @@ def run(args: argparse.Namespace) -> None:
 
     for image_filename in args.image_filenames:
         original_image = Image.open(image_filename)
+        if args.canvas:
+            resized_image = _resize_image_onto_canvas(original_image, args)
+        else:
+            resized_image = _resize_image(original_image, args)
+        save_image(args, resized_image, image_filename, "resize")
 
-        new_width, new_height = _calc_new_image_dimension(original_image, args)
-        resized_image = original_image.copy()
-        resized_image = resized_image.resize(
-            (new_width, new_height), Image.Resampling.LANCZOS
-        )
 
-        save_image(args, resized_image, image_filename, "resize")
+def _resize_image_onto_canvas(original_image, args):
+    resized_image = Image.new("RGB", (args.width, args.height), (0, 0, 0))
+    x_offset = (args.width - original_image.width) // 2
+    y_offset = (args.height - original_image.height) // 2
+    resized_image.paste(original_image, (x_offset, y_offset))
+    return resized_image
+
+
+def _resize_image(original_image, args):
+    new_width, new_height = _calc_new_image_dimension(original_image, args)
+    resized_image = original_image.copy()
+    resized_image = resized_image.resize(
+        (new_width, new_height), Image.Resampling.LANCZOS
+    )
+    return resized_image
 
 
 def _calc_new_image_dimension(image, args) -> tuple: