Metadata-Version: 2.1
Name: image2html
Version: 0.0.6
Summary: Display images with html file.
Home-page: https://github.com/ZQPei/image2html
Author: ZQPei
Author-email: peiziqiang@gmail.com
License: MIT
Description: # image2html
        
        For quick viewing images via html file.
        
        ![](https://img.shields.io/badge/python3-passing-brightgreen)
        
        ## Install
        
        You can install it from pip or source code.
        
        1. pip
        
            ```bash
            pip install image2html
            ```
        
        2. source code
        
            ```bash
            git clone https://github.com/ZQPei/image2html.git
            cd image2html
            python setup.py install # use sudo if necessary
            ```
        
        
        ## Usage
        
        1. make flist
        
            ```bash
            # Get all the path of images in dir and save them to output file.
            make_flist [dir] [output] --keyword keyword1, keyword2 --ext ('.png', '.jpg') --recursive
        
            # for example
            make_flist demo_img_folder1 img_flist1.txt --keyword cmp cmp --ext ('.png', '.jpg')
            ```
        
        2. image2html
        
            ```bash
            # Display all the images with specified extension in demo/iimg_folder1.
            image2html --dirs demo/img_folder1 --output demo/demo_single.html
        
            # Note that if there are multiple dirs, the number of images shall be equal in each directory.
            image2html --dirs demo/img_folder1 demo/img_floder2 --output demo/demo_multiple.html
        
            # Then you will get demo_single.html and demo_multiple.html in demo folder.
            ```
        
        3. Use a http server to view html file on browser.
            ```bash
            # First build a http server
            build_server --port 8000
        
            # Then open your browser with address http://your_ip_address:8000/home/pzq/github/image2html/demo/demo_multiple.html.
            ```
        
        
        
        ## Example
        
        ![demo1](demo/demo1.png)
        ![demo1](demo/demo2.png)
        
        
Platform: all
Description-Content-Type: text/markdown
