Metadata-Version: 2.1
Name: diff-tool
Version: 2.1.0
Summary: Display a diff between two files in HTML.
Home-page: http://github.com/justintime50/diff-tool
Author: Justintime50
License: MIT
Description: <div align="center">
        
        # Diff Tool
        
        Display a diff between two files in HTML.
        
        [![Build Status](https://github.com/Justintime50/diff-tool/workflows/build/badge.svg)](https://github.com/Justintime50/diff-tool/actions)
        [![Coverage Status](https://coveralls.io/repos/github/Justintime50/diff-tool/badge.svg?branch=main)](https://coveralls.io/github/Justintime50/diff-tool?branch=main)
        [![PyPi](https://img.shields.io/pypi/v/diff-tool)](https://pypi.org/project/diff-tool)
        [![Licence](https://img.shields.io/github/license/justintime50/diff-tool)](https://opensource.org/licenses/mit-license.php)
        
        <img src="assets/showcase.png" alt="Showcase">
        
        </div>
        
        Running this tool requires two files to compare. It will output the **diff**erence to an HTML file which can be viewed in a browser to see what changed between files.
        
        ## Install
        
        ```bash
        # Install tool
        pip3 install diff-tool
        
        # Install locally
        make install
        
        # Get Makefile help
        make help
        ```
        
        ## Usage
        
        ```
        Usage:
            diff-tool -f1 /path/to/file1.txt -f2 /path/to/file2.txt -o path/to/diff.html
        
        Options:
            -h, --help            show this help message and exit
            -f1 FILE1, --file1 FILE1
                                    The path to the base file to compare a second file to.
            -f2 FILE2, --file2 FILE2
                                    The path to the second file compared to the base file.
            -o OUTPUT, --output OUTPUT
                                    The path to the output file including filename..
        ```
        
        ## Development
        
        ```bash
        # Lint the project
        make lint
        
        # Run tests
        make test
        
        # Run the tool locally
        venv/bin/python diff_tool/diff_files.py --help
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: dev
