https://github.com/mgedmin/imgdiff

Compare two images side-by-side
https://github.com/mgedmin/imgdiff

Last synced: 2 days ago
JSON representation

Compare two images side-by-side

• Host: GitHub
• URL: https://github.com/mgedmin/imgdiff
• Owner: mgedmin
• License: mit
• Created: 2013-08-09T09:14:19.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2024-10-10T12:41:00.000Z (3 months ago)
• Last Synced: 2024-12-15T20:15:48.444Z (9 days ago)
• Language: Python
• Homepage: https://pypi.python.org/pypi/imgdiff
• Size: 1.33 MB
• Stars: 49
• Watchers: 3
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
imgdiff

=======

.. image:: https://github.com/mgedmin/imgdiff/workflows/build/badge.svg?branch=master

    :target: https://github.com/mgedmin/imgdiff/actions

.. image:: https://coveralls.io/repos/mgedmin/imgdiff/badge.svg?branch=master

    :target: https://coveralls.io/r/mgedmin/imgdiff

A command-line tool that combines two pictures into a single, larger

one, and opens a GUI window (provided by the Python Imaging Library)

or an external image viewer.

You could use it with a version control tool, e.g. ::

  bzr diff *.png --using=imgdiff

or ::

  bzr diff *.png --using='imgdiff --eog -H'

Installation

------------

``pip install imgdiff`` or `download it from PyPI

`_.

Usage

-----

Run ``imgdiff --help`` to see this help message::

    Usage: imgdiff [options] image1 image2

    Compare two images side-by-side

    Options:

      -h, --help            show this help message and exit

      -o OUTFILE            write the combined image to a file

      --viewer=COMMAND      use an external image viewer (default: builtin)

      --eog                 use Eye of Gnome (same as --viewer eog)

      --grace=SECONDS       seconds to wait before removing temporary file when

                            using an external viewer (default: 1.0)

      -H, --highlight       highlight differences (EXPERIMENTAL)

      -S, --smart-highlight

                            highlight differences in a smarter way (EXPERIMENTAL)

      --opacity=OPACITY     minimum opacity for highlighting (default 64)

      --timeout=TIMEOUT     skip highlighting if it takes too long (default: 10

                            seconds)

      --auto                pick orientation automatically (default)

      --lr, --left-right    force orientation to left-and-right

      --tb, --top-bottom    force orientation to top-and-bottom

      --bgcolor=RGB         background color (default: fff)

      --sepcolor=RGB        separator line color (default: ccc)

      --spacing=N           spacing between images (default: 3 pixels)

      --border=N            border around images (default: 0 pixels)

Output Examples

---------------

First example::

    imgdiff set1/42.png set3/

.. figure:: example1.png

   :alt: example #1

Here the images are wide and short, so imgdiff decided to put them one above

the other.

Same example, with highlighting enabled::

    imgdiff set1/42.png set3/ -H

.. figure:: example2.png

   :alt: example #2

You can see that it doesn't work very well, although it can produce nice

results in simpler cases::

    imgdiff set1/42.png set2/ -H

.. figure:: example3.png

   :alt: example #3

Support and Development

-----------------------

The source code can be found in this Git repository:

https://github.com/mgedmin/imgdiff.

To check it out, use ``git clone https://github.com/mgedmin/imgdiff``.

Report bugs at https://github.com/mgedmin/imgdiff/issues.