Examples

Link to GitHub repo

Link to Documentation Homepage

Link to Input arguments or parameters

Config File Format

You can either pass the arguments directly from the command as in the examples below or you can pass it through a config file. Below is a sample of how a config file looks.

You can pass more than one record through a config file. The below sample consist of two set of records. The code will iterate through each of the record and download images based on arguments passed.

{
    "Records": [
        {
            "keywords": "apple",
            "limit": 5,
            "color": "green",
            "print_urls": true
        },
        {
            "keywords": "universe",
            "limit": 15,
            "size": "large",
            "print_urls": true
        }
    ]
}

Code sample - Importing the library

• If you are calling this library from another python file, below is the sample code

from google_images_download import google_images_download   #importing the library

response = google_images_download.googleimagesdownload()   #class instantiation

arguments = {"keywords":"Polar bears,baloons,Beaches","limit":20,"print_urls":True}   #creating list of arguments
paths = response.download(arguments)   #passing the arguments to the function
print(paths)   #printing absolute paths of the downloaded images

Command line examples

• If you are passing arguments from a config file, simply pass the config_file argument with name of your JSON file

$ googleimagesdownload -cf example.json

• Simple example of using keywords and limit arguments

$ googleimagesdownload --keywords "Polar bears, baloons, Beaches" --limit 20

• Using Suffix Keywords allows you to specify words after the main keywords. For example if the keyword = car and suffix keyword = 'red,blue' then it will first search for car red and then car blue

$ googleimagesdownload --k "car" -sk 'red,blue,white' -l 10

• To use the short hand command

$ googleimagesdownload -k "Polar bears, baloons, Beaches" -l 20

• To download images with specific image extension/format

$ googleimagesdownload --keywords "logo" --format svg

• To use color filters for the images

$ googleimagesdownload -k "playground" -l 20 -co red

• To use non-English keywords for image search

$ googleimagesdownload -k "北极熊" -l 5

• To download images from the google images link

$ googleimagesdownload -k "sample" -u <google images page URL>

• To save images in specific main directory (instead of in ‘downloads’)

$ googleimagesdownload -k "boat" -o "boat_new"

• To download one single image with the image URL

$ googleimagesdownload --keywords "baloons" --single_image <URL of the images>

• To download images with size and type constrains

$ googleimagesdownload --keywords "baloons" --size medium --type animated

• To download images with specific usage rights

$ googleimagesdownload --keywords "universe" --usage_rights labeled-for-reuse

• To download images with specific color type

$ googleimagesdownload --keywords "flowers" --color_type black-and-white

• To download images with specific aspect ratio

$ googleimagesdownload --keywords "universe" --aspect_ratio panoramic

• To download images which are similar to the image in the image URL that you provided (Reverse Image search).

$ googleimagesdownload -si <image url> -l 10

• To download images from specific website or domain name for a given keyword

$ googleimagesdownload --keywords "universe" --specific_site example.com

===> The images would be downloaded in their own sub-directories inside the main directory (either the one you provided or in ‘downloads’) in the same folder you are in.

Library extensions

The downloading algorithm does a good job of keeping out corrupt images. However it is not ideal. There are still some chances of getting one-off corrupt image that cannot be used for processing. Below script will help clean those corrupt image files. This script was ideated by @devajith in Issue 81.

import os
from PIL import Image

img_dir = r"path/to/downloads/directory"
for filename in os.listdir(img_dir):
    try :
        with Image.open(img_dir + "/" + filename) as im:
             print('ok')
    except :
        print(img_dir + "/" + filename)
        os.remove(img_dir + "/" + filename)