Merge pull request #19 from achimoraites/feat/extended-features

achimoraites · web-flow · commit 673a451527d6 · 2023-10-01T12:37:08.000+02:00
Feat/extended features
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,6 @@
+{
+    "[python]": {
+        "editor.defaultFormatter": "ms-python.black-formatter"
+    },
+    "python.formatting.provider": "none"
+}
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -48,7 +48,12 @@ Please follow the [PEP 8](https://www.python.org/dev/peps/pep-0008/) style guide
 
 Ensure that your code works as expected without affecting existing functionality.
 
-(We will add unit tests to the project in the near future)
+We are using pytest, the `tests` folder contains our unit tests.
+
+```bash
+# run unit tests
+pytest tests
+```
 
 ## Reporting Issues
 
diff --git a/README.md b/README.md
@@ -39,19 +39,34 @@ In that case using an virtual environment is recommended
 ```
 ## Example usage
 
+### Arguments
+- `-s, --src` (required): set the path to the directory you want to convert (source)! 
+- `-t, --tgt`: where to store the converted images (target), by default they are stored in the "converted" folder. 
+- `-d, --delete-source-directory`: removes the directory with the original images (source) 
+- `-r, --resolution`: Allows to set the converted image resolutions, you can use numbers or percentages: eg 75% -> width and height are 75% of the original size, 1000,1500 sets the width to 1000px and the height to 1500px
+- `-e, --ext`: specify the converted image format that will be used for the converted images; by default the `.jpg` is used. valid options are:
+    - `.jpg`
+    - `.png`
+
 ```
  # simple usage
- raw_image_converter --s <Enter-Path-Of-Directory>
+ raw_image_converter -s <Enter-Path-Of-Directory>
 
  # set a custom target image format
  raw_image_converter --s <Enter-Path-Of-Directory> --ext '.png'
+
+ # Advanced usage 1
+ raw_image_converter -s images -t converted/png -r 25% -e .png -d
+
+ # Set custom resolution 1
+ raw_image_converter -s images -t converted/jpg -r 1024,768
+
+ # Set custom resolution 2
+ raw_image_converter -s images -t converted/jpg -r 50%,33%
 ```
-- The --s argument is where you set the path to the directory you want to convert! 
-- The --ext argument is where you specify the image format that will be used for the converted images; by default the `.jpg` is used. valid options are:
-    - `.jpg`
-    - `.png`
 
-The application will create a folder 'converted' where all your converted images are located!
+
+
 
 And you are done! 
 
diff --git a/raw_image_converter/__main__.py b/raw_image_converter/__main__.py
@@ -1,83 +1,128 @@
 from datetime import datetime
 import os
-from raw_image_converter.utils import check_extension, convert_file, convert_raw, image_not_exists
+from raw_image_converter.utils import (
+    check_extension,
+    convert_file,
+    convert_raw,
+    image_not_exists,
+    delete_directory,
+)
 import argparse
 import concurrent.futures
-from colorama import *
-#TODO use the extension argument of the command everywhere
+from colorama import Fore, Style
 
-# All images are converted to jpg
 
-# where to save our images
-directory = "converted"
-
-# create a directory if needed to store our converted images!
-if not os.path.exists(directory):
-    os.makedirs(directory)
+def tuple_type(values):
+    values = values.split(",")
+    return tuple(values)
 
 
 def main():
-    print('### PYTHON IMAGE CONVERTER ### \n \n')
-
-    parser = argparse.ArgumentParser(description="Convert images to JPG")
-    parser.add_argument('-s', "--src", dest = "src_dir",help='specify the source directory!', required=True) # this argument is required to start the conversion
-    parser.add_argument("-t","--tgt", dest = "tgt_dir", help="specify the target directory!") # if there is no target directory given, the script will store the converted images in the source folder
-    parser.add_argument('-e',"--ext", dest = "ext", default=".jpg", choices=['.jpg', '.png'],
-                      help='the image format to be used for the converted images.')
-    parser.add_argument("-f","--folder", dest = "seperate_folder", default=False, help="should the converted images be placed in a seperate folder")
+    print("### PYTHON IMAGE CONVERTER ### \n \n")
+
+    parser = argparse.ArgumentParser(description="Convert images to JPG/PNG")
+    parser.add_argument(
+        "-s",
+        "--src",
+        dest="src_dir",
+        help="specify the source directory!",
+        required=True,
+    )
+    parser.add_argument(
+        "-t",
+        "--tgt",
+        dest="tgt_dir",
+        help="specify the target directory!",
+        default="converted",
+    )
+    parser.add_argument(
+        "-e",
+        "--ext",
+        dest="ext",
+        default=".jpg",
+        choices=[".jpg", ".png"],
+        help="the image format to be used for the converted images.",
+    )
+    parser.add_argument(
+        "-d",
+        "--delete-source-directory",
+        action="store_true",
+        dest="delete_source_directory",
+        default=False,
+        help="Delete the source directory after the convesion",
+    )
+    parser.add_argument(
+        "-r",
+        "--resolution",
+        type=tuple_type,
+        dest="resolution",
+        default="100%,100%",
+        help="image dimensions (width, height) as a tuple (using numbers 800,600 or using percentages 75%,75%)",
+    )
+
     args = parser.parse_args()
-    
-    if args.tgt_dir == None:
-        if args.seperate_folder:
-            if not os.path.exists(args.src_dir + "/" + directory):
-                os.makedirs(args.src_dir + "/" + directory)
-            srcDir = args.src_dir
-            tgtDir = args.src_dir + directory
-        else:
-            srcDir = args.src_dir
-            tgtDir = args.src_dir
-    else:
-        if args.seperate_folder: # if the converted files should be stored in a seperate folder, create the folder and add the images to the folder
-            if not os.path.exists(args.tgt_dir + "/" + directory):
-                os.makedirs(args.tgt_dir + "/" + directory)
-            srcDir = os.path.abspath(args.src_dir)
-            tgtDir = os.path.abspath(args.tgt_dir + directory)
-        else: # if the converted files sould be kept in the source folder, 
-            srcDir = os.path.abspath(args.src_dir)
-            tgtDir = os.path.abspath(args.tgt_dir)
+
+    srcDir = os.path.abspath(args.src_dir)
+    tgtDir = os.path.abspath(args.tgt_dir)
+    resolution = args.resolution
+
+    # Handle one dimensional tuples
+    if len(resolution) == 1:
+        resolution = (resolution[0], resolution[0])
+
+    if not os.path.exists(tgtDir):
+        os.makedirs(tgtDir)
 
     # find files to convert
     try:
-        with concurrent.futures.ProcessPoolExecutor() as executor: 
-            print("Started conversion at : " + datetime.now().time().strftime('%H:%M:%S') + '\n')
-            print("Converting -> " + srcDir + " Directory !\n")  
+        with concurrent.futures.ProcessPoolExecutor() as executor:
+            print(
+                "Started conversion at : "
+                + datetime.now().time().strftime("%H:%M:%S")
+                + "\n"
+            )
+            print("Converting -> " + srcDir + " Directory !\n")
             for file in os.listdir(srcDir):
-                #TODO also use the extension from the command as a parameter to the image_not_exists function
                 if image_not_exists(file, tgtDir, args.ext):
-                    if 'RAW' == check_extension(file):
-                             executor.submit(
-                                convert_raw,
-                                file,
-                                srcDir,
-                                tgtDir,
-                                args.ext,
-                            )
-                            
-                    if 'NOT_RAW' == check_extension(file):
+                    if "RAW" == check_extension(file):
+                        executor.submit(
+                            convert_raw,
+                            file,
+                            srcDir,
+                            tgtDir,
+                            args.ext,
+                            resolution,
+                        )
+
+                    if "NOT_RAW" == check_extension(file):
                         executor.submit(
                             convert_file,
                             file,
                             srcDir,
                             tgtDir,
                             args.ext,
+                            resolution,
                         )
                 else:
-                    print(f"{Fore.GREEN}File " + file + f" is already converted!{Style.RESET_ALL}"+" \n ")
+                    print(
+                        f"{Fore.GREEN}File "
+                        + file
+                        + f" is already converted!{Style.RESET_ALL}"
+                        + " \n "
+                    )
+
+        print(
+            f"{Fore.GREEN}Converted Images are stored at - > "
+            + os.path.abspath(tgtDir)
+            + f"{Style.RESET_ALL}"
+        )
 
-        print(f"{Fore.GREEN}Converted Images are stored at - > " + os.path.abspath(tgtDir)+f"{Style.RESET_ALL}")   
+        if args.delete_source_directory:
+            delete_directory(srcDir)
 
     except Exception as e:
         print(f"{Fore.RED}ERROR IN APPLICATION{Style.RESET_ALL}" + e)
 
+
 if __name__ == "__main__":
     main()
diff --git a/raw_image_converter/utils.py b/raw_image_converter/utils.py
@@ -1,31 +1,39 @@
 from PIL import Image
 import os
+import numpy as np
 import rawpy
 import imageio
 from datetime import datetime
+import shutil
 
 
 def message(file, converted):
+    current_time = datetime.now().time().strftime("%H:%M:%S")
     # if conversion finished
     if converted:
-        print(datetime.now().time().strftime("%H:%M:%S") + " Converted:  " + file)
+        print(f"{current_time} Converted: {file}")
     # if conversion failed
     else:
-        print(
-            datetime.now().time().strftime("%H:%M:%S")
-            + " Conversion failed for File:  "
-            + file
-        )
+        print(f"{current_time} Conversion failed for File: {file}")
 
 
 # convert RAW images function
-def convert_raw(file, srcDir, tgtDir, extension=".jpg"):
+def convert_raw(file, srcDir, tgtDir, extension=".jpg", resolution=("100%", "100%")):
     try:
         ext = "." + file.split(".")[-1].lower()
         print(datetime.now().time().strftime("%H:%M:%S") + " Converting:  " + file)
         source = os.path.join(srcDir, file)
         with rawpy.imread(source) as raw:
             rgb = raw.postprocess()
+        if resolution:
+            pil_image = Image.fromarray(rgb)
+
+            # Resize the image
+            width = calculate_image_dimension(pil_image.width, resolution[0])
+            height = calculate_image_dimension(pil_image.height, resolution[1])
+            pil_image = pil_image.resize((width, height))
+
+            rgb = np.array(pil_image)
         imageio.imsave(os.path.join(tgtDir, file.replace(ext, "") + extension), rgb)
         message(file, True)
     except Exception as e:
@@ -34,8 +42,17 @@ def convert_raw(file, srcDir, tgtDir, extension=".jpg"):
         pass
 
 
+def calculate_image_dimension(dimension, resolution):
+    if "%" in resolution:
+        factor = float(resolution.strip("%").strip()) / 100.0
+        result = int(dimension * factor)
+    else:
+        result = int(resolution)
+    return result
+
+
 # convert function
-def convert_file(file, srcDir, tgtDir, extension=".jpg"):
+def convert_file(file, srcDir, tgtDir, extension=".jpg", resolution=("100%", "100%")):
     mappings = {
         ".jpg": "JPEG",
         ".png": "PNG",
@@ -46,6 +63,10 @@ def convert_file(file, srcDir, tgtDir, extension=".jpg"):
         message(file, False)
         path = os.path.join(srcDir, file)
         im = Image.open(path)
+        if resolution:
+            width = calculate_image_dimension(im.width, resolution[0])
+            height = calculate_image_dimension(im.height, resolution[1])
+            im = im.resize((width, height))
         im.save(os.path.join(tgtDir, file.replace(ext, "") + extension), save_format)
         message(file, True)
     except:
@@ -64,9 +85,9 @@ def ai_2_pdf(file):
 
 
 # IT IS POINTLESS TO CONVERT WHAT IS ALREADY CONVERTED!!!!
-def image_not_exists(image, tgtDir,tgtExt):
+def image_not_exists(image, tgtDir, tgtExt):
     ext = image.split(".")[-1].lower()
-    target = os.path.join(tgtDir, image.replace(ext, tgtExt.replace(".","")))
+    target = os.path.join(tgtDir, image.replace(ext, tgtExt.replace(".", "")))
     if os.path.isfile(target):
         return False
     else:
@@ -111,3 +132,11 @@ def check_extension(file):
         return "NOT RAW"
     # check if an .ai exists and rename it to .pdf	!
     ai_2_pdf(file)
+
+
+def delete_directory(dir):
+    try:
+        shutil.rmtree(dir)
+        print(f"Removed source directory {dir}")
+    except OSError as o:
+        print(f"Error, {o.strerror}: {dir}")
diff --git a/requirements.txt b/requirements.txt
@@ -2,3 +2,4 @@ imageio==2.16.2
 Pillow==9.3.0
 rawpy==0.17.1
 numpy==1.22.3
+colorama==0.4.6
diff --git a/setup.py b/setup.py
@@ -10,7 +10,7 @@
 # This call to setup() does all the work
 setup(
     name="raw-image-converter",
-    version="1.0.5",
+    version="1.1.0",
     description="Batch conversions of raw images",
     long_description=README,
     long_description_content_type="text/markdown",
@@ -27,7 +27,7 @@
     keywords='cli, converter, raw, images',
     packages=["raw_image_converter"],
     install_requires=["numpy==1.22.3", "rawpy==0.17.1",
-                      "imageio==2.16.2", "Pillow==9.3.0"],
+                      "imageio==2.16.2", "Pillow==9.3.0", "colorama==0.4.6"],
     entry_points={
         "console_scripts": [
             "raw_image_converter=raw_image_converter.__main__:main",
diff --git a/tests/__init__.py b/tests/__init__.py
diff --git a/tests/test_utils_calculate_image_dimension.py b/tests/test_utils_calculate_image_dimension.py
@@ -0,0 +1,23 @@
+from raw_image_converter.utils import calculate_image_dimension
+
+
+class TestCalculateImageDimension:
+    # Case: resolution is a set number
+    def test_valid_integer_dimension_and_resolution(self):
+        dimension = 100
+        resolution = "200"
+        expected_result = 200
+
+        result = calculate_image_dimension(dimension, resolution)
+
+        assert result == expected_result
+
+    # Case: resolution is a percentage
+    def test_valid_integer_dimension_and_percentage_resolution(self):
+        dimension = 100
+        resolution = "50%"
+        expected_result = 50
+
+        result = calculate_image_dimension(dimension, resolution)
+
+        assert result == expected_result
diff --git a/tests/test_utils_message.py b/tests/test_utils_message.py
