Skip to main content

Duplicate Image Finder (difPy)

Tired of going through all images in a folder and comparing them manually to check if they are duplicates?

The Duplicate Image Finder (difPy) Python package automates this task for you!

Read more on how the algorithm of difPy works in my Medium article Finding Duplicate Images with Python.

For a detailed usage guide, please view the official difPy Usage Documentation.


Description

DifPy searches for images in one or more different folders, compares the images it found and checks whether these are duplicates. It then outputs the image files classified as duplicates as well as the images having the lowest resolutions, so you know which of the duplicate images are safe to be deleted. You can then either delete them manually, or let difPy delete them for you.

DifPy does not compare images based on their hashes. It compares them based on their tensors i. e. the image content - this allows difPy to not only search for duplicate images, but also for similar images.

Basic Usage

Use the following function to make difPy search for duplicates within one specific folder and its subfolders:

from difPy import dif
search = dif("C:/Path/to/Folder/")

To search for duplicates within mutliple folders and their subfolders:

from difPy import dif
search = dif(["C:/Path/to/Folder_A/", "C:/Path/to/Folder_B/", "C:/Path/to/Folder_C/", ... ])

Folder paths must be specified as standalone Python strings, or within a Python list.

Output

DifPy returns various types of output that you may use depending on your use case:

A JSON formatted collection of duplicates/similar images (i. e. match groups) that were found, where the keys are a randomly generated unique id for each image file:

search.result

> Output:
{20220819171549 : {"location" : "C:/Path/to/Image/image1.jpg",
                   "matches" : {30270813251529 : "location": "C:/Path/to/Image/matched_image1.jpg",
                                                 "mse": 0.0},
                               {72214282557852 : "location": "C:/Path/to/Image/matched_image2.jpg",
                                                 "mse": 0.0},
                   ... }
 ...
}

A list of duplicates/similar images that have the lowest quality among match groups:

search.lower_quality

> Output:
["C:/Path/to/Image/duplicate_image1.jpg", 
 "C:/Path/to/Image/duplicate_image2.jpg", ...]

A JSON formatted collection with statistics on the completed difPy process:

search.stats

> Output:
{"directory" : ("C:/Path/to/Folder_A/", "C:/Path/to/Folder_B/", ... ),
 "duration" : {"start_date": "2023-02-15",
               "start_time" : "18:44:19",
               "end_date" : "2023-02-15",
               "end_time" : "18:44:38",
               "seconds_elapsed" : 18.6113},
 "fast_search": True,
 "recursive" : True,
 "match_mse" : 200,
 "files_searched" : 1032,
 "matches_found" : 852,
 "invalid_files" : 4}

Additional Parameters

DifPy supports the following parameters:

dif(*directory, fast_search=True, recursive=True, similarity="normal", px_size=50, 
    show_progress=True, show_output=False, delete=False, silent_del=False)

CLI Usage

You can make use of difPy through a CLI interface by using the following commands:

python dif.py -D "C:/Path/to/Folder/"

python dif.py -D "C:/Path/to/Folder_A/" "C:/Path/to/Folder_B/" "C:/Path/to/Folder_C/"

It supports the following arguments:

dif.py [-h] -D DIRECTORY [-Z [OUTPUT_DIRECTORY]] [-f [FAST_SEARCH]]
       [-r [{True,False}]] [-s [{low,normal,high,int}]] [-px [PX_SIZE]] 
       [-p [{True,False}]] [-o [{True,False}]]
       [-d [{True,False}]] [-sd [{True,False}]]

The output of difPy is then written to files and saved in the working directory, where "xxx" in the output filesnames is a unique timestamp:

difPy_results_xxx.json
difPy_lower_quality_xxx.csv
difPy_stats_xxx.json

For a detailed usage guide, please view the official difPy Usage Documentation.

Metadata

Release files for difPy 3.0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for difPy 3.0.3
File Size Uploaded Provenance Actions
difPy-3.0.3.tar.gz 11.9 kB Without provenance Details for difPy-3.0.3.tar.gz

Release files / difPy-3.0.3.tar.gz

Download URL difPy-3.0.3.tar.gz
Size 11.9 kB
Tags Source
SHA-256 checksum
How to use checksums
09ff43289b44f4784992f0a77f04f592be87c6dafbe7de4a16a77f6730db7af2
BLAKE2b-256 checksum
How to use checksums
744101e2d49e17098d6d9097eadd6cc0504140ffc38bfa281dd4af9a28c7d5dd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.7.4

Security for difPy 3.0.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

3.0.3 This release

1 release file No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page