Metadata-Version: 1.0
Name: imgutil
Version: 0.1.4
Summary: Image operation utilities.
Home-page: https://github.com/yu-liang-kono/imgutil
Author: yuliang
Author-email: yu.liang@thekono.com
License: UNKNOWN
Description: imgutil
        =======
        Image operation utility
        
        
        Installation
        ------------
        
        Installation using pip
        
        .. code-block:: bash 
        
            $ pip install imgutil
        
        
        Prerequesite
        ------------
        
        * jpegtran
        * pngcrush
        
        Command line utilities
        ----------------------
        
        imgoptimize
        ~~~~~~~~~~~
        
        .. code-block:: bash
        
            $ imgoptimize [-h] [-o OUTPUT] src_img
        
        * Optimize image to reduce file size.
        * Should install ``jpegtran`` and ``pngcrush``.
        
        Usage
        `````
        * ``-o``: (Optional) Specifiy the output image.
        * ``src_img``: Specify the input image.
        
        imgresize
        ~~~~~~~~~
        
        .. code-block:: bash
        
            $ imgresize [-h] [-o OUTPUT] [-W WIDTH] [-H HEIGHT] src_img
        
        * Resize image by specifying width or height.
        
        Usage
        `````
        
        * ``-o``: (Optional) Specifiy the output image.
        * ``-W`` or ``--width``: (Optional) Specify the desired image width. If only width is specified, height will be determined by the aspect ratio of image.
        * ``-H`` or ``--height``: (Optional) Specify the desired image height. If only height is specified, width will be determined by the aspect ratio of image.
        * ``src_img``: Specify the input image.
        
        
        Usage
        -----
        
        imgoptimize
        ~~~~~~~~~~~
        
        .. code-block:: python
        
            imgoptimize(input_filename, output_filename=None)
        
        * Should install ``jpegtran`` and ``pngcrush``.
        * It reduces jpeg/png file size.
        * It converts CMYK to RGB.
        
        **quick example**
        
        .. code-block:: python
        
            import os
            from imgutil import imgoptimize
        
            test_img = '/tmp/test.jpg'
            os.stat(test_img).st_size              # 81073
            imgoptimize(test_img, '/tmp/opt.jpg')  # output to /tmp/opt.jpg
            os.stat('/tmp/opt.jpg').st_size        # 81026
            imgoptimize(test_img)                  # optimize the original file
            os.stat(test_img).st_size              # 81026
        
        imgresize
        ~~~~~~~~~
        
        .. code-block:: python
        
            imgresize(input_filename, width=None, height=None, output_filename=None)
        
        * It can resize image and preserve aspect ratio.
        * It can resize image to specified dimension.
        
        **quick example**
        
        .. code-block:: python
        
            from imgutil import imgresize
        
            test_img = '/tmp/test.jpg'    # It is a 1024x768 image
            imgresize(test_img, width=600, output_filename='/tmp/resize.jpg') # /tmp/resize.jpg is 600x450
            imgresize(test_img, height=600, output_filename='/tmp/resize.jpg') # /tmp/resize.jpg is 800x600
            imgresize(test_img, width=100, height=100, output_filename='/tmp/resize.jpg') # /tmp/resize.jpg is 100x100
            imgresize(test_img, width=200, height=400) # /tmp/test.jpg is 200x400 now
        
Platform: UNKNOWN
