dupeguru-post-processor

dupeguru-post-processor is a Python script that can be used to compare a folder on your computer to a set of dupeGuru results. Specifically, it can be used to determine which files in the folder are not listed in the CSV file; effectively, identifying the files of which dupeGuru found no duplicates.

dupeGuru is a tool that can be used to identify duplicate files among two or more folders. The creation of this "post-processing" script was inspired by this GitHub issue.

Workflow

flowchart LR

    subgraph d [dupeGuru]
      d1[Perform filename or contents scan]-->d2[Export results as CSV file]
    end
    
    subgraph p [post-processor]
      p1[Specify folder]-->p2[Specify CSV file]
      p2-->p3[Run script]
      p3-->p4[See list of files]
    end
    
    d2-.->p1

Usage

Environment

This script was developed using Python version 3.10.5.

CLI

Note: You can use the CLI without installing any dependencies, since all dependencies used by the CLI are included in the Python standard library.

Display usage information:

$ python main.py --help

usage: main.py [-h] [--output_csv_file PATH] [--log_level LEVEL] folder csv_file

Compares a folder to a CSV file exported from dupeGuru. Displays the differences 
on the console (default) or writes them to a CSV file.

positional arguments:
  folder                path to the folder with which you want to compare the CSV
                        file exported from dupeGuru
  csv_file              path to the CSV file exported from dupeGuru

options:
  -h, --help            show this help message and exit
  --output_csv_file PATH
                        if you use this option, the script will generate a CSV file
                        at the path you specify; otherwise, the script will display
                        the results on the console
  --log_level LEVEL     specify a logging level for the script

Note: File and folder paths can be absolute paths and/or relative paths.

Examples

Here are some example invocations of the script:

Display results on console

$ python main.py /path/to/folder/ ./some/dupelist.csv

Save results to a CSV file and display debug information

$ python main.py /path/to/folder/ ./some/dupelist.csv --output_csv_file /temp/nondupes.csv --log_level DEBUG

GUI

The GUI was created as an "afterthought" to the CLI and is targeted at users who are already familiar with the CLI options, but don't want to type filesystem paths onto the command line.

Install dependencies:

$ python -m pip install -r requirements.txt

Open the GUI:

$ python gui.py

Here's what the GUI looks like as of version 1.2.2:

Testing

Run the unit tests:

$ python -m unittest