PyPI - diff2html - Versions diffs - 1.0__tar.gz - Mend

diff2html 1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (13) hide show

diff2html-1.0/LICENSE.md +21 -0
diff2html-1.0/PKG-INFO +39 -0
diff2html-1.0/README.md +24 -0
diff2html-1.0/diff2html/diff2html.py +180 -0
diff2html-1.0/diff2html.egg-info/PKG-INFO +39 -0
diff2html-1.0/diff2html.egg-info/SOURCES.txt +11 -0
diff2html-1.0/diff2html.egg-info/dependency_links.txt +1 -0
diff2html-1.0/diff2html.egg-info/entry_points.txt +2 -0
diff2html-1.0/diff2html.egg-info/requires.txt +4 -0
diff2html-1.0/diff2html.egg-info/top_level.txt +1 -0
diff2html-1.0/pyproject.toml +24 -0
diff2html-1.0/setup.cfg +4 -0
diff2html-1.0/test/test_e2e.py +38 -0

diff2html-1.0/LICENSE.md ADDED Viewed

@@ -0,0 +1,21 @@
+MIT License
+Copyright (c) 2026 Tim Pillinger
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

diff2html-1.0/PKG-INFO ADDED Viewed

@@ -0,0 +1,39 @@
+Metadata-Version: 2.4
+Name: diff2html
+Version: 1.0
+Summary: CLI wrapper for Pythons Difflib builtin
+Author-email: "tim.pillinger" <tim.pillinger@metoffice.gov.uk>
+License-Expression: MIT
+Keywords: diff,html,difftool,difflib,cli
+Classifier: Programming Language :: Python
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: flake8; extra == "test"
+Dynamic: license-file
+# Diff2HTML
+Python's difflib is a great standard library feature.
+But I wanted a command line version.
+## Installation
+```
+pip install diff2html
+```
+## Usage
+```
+diff2html fileA fileB --output diff.html
+firefox diff.html
+```
+for advanced usage see:
+```
+diff2html --help
+```

diff2html-1.0/README.md ADDED Viewed

@@ -0,0 +1,24 @@
+# Diff2HTML
+Python's difflib is a great standard library feature.
+But I wanted a command line version.
+## Installation
+```
+pip install diff2html
+```
+## Usage
+```
+diff2html fileA fileB --output diff.html
+firefox diff.html
+```
+for advanced usage see:
+```
+diff2html --help
+```

diff2html-1.0/diff2html/diff2html.py ADDED Viewed

@@ -0,0 +1,180 @@
+#!/usr/bin/env python
+"""Compare two files and produce a well formatted diff in an HTML file.
+A command line wrapper for Python's difftool.
+"""
+import argparse
+from difflib import HtmlDiff
+from pathlib import Path
+import re
+from typing import Optional
+class DiffDoc:
+    """A container to keep HTML bric-a-brac tidy. Provides a single
+    class methods convert a diff to an HTML page.
+    """
+    # Create an additional explanation of the webpage:
+    BACKBUTTON = '<br><button onclick="history.back()">Go Back</button><br>'
+    HEAD1 = '<h1>{}</h1>'
+    HEAD3 = '<h3>{}</h3>'
+    HEAD = """
+    <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+            "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+    <html>
+    <head>
+        <meta http-equiv="Content-Type"
+            content="text/html; charset=utf-8" />
+        <title></title>
+        <style type="text/css">
+            h1, h2, h3 {
+                font-family: Consolas, Sans, sans-serif
+            }
+            #code {
+                font-family: 'Jetbrains Mono', consolas, 'Courier New', monospace;
+            }
+            table {
+                font-family: 'Jetbrains Mono', consolas, 'Courier New', monospace;
+                border-style: solid;
+                border-width: 2px;
+                margin-top: 5px;
+            }
+            .legend,
+            .legend th,
+            .legend td {
+                border-style: none;
+            }
+            td.diff_header {
+                text-align:right;
+            }
+            .diff_next {
+                border-left-style: solid;
+                border-left-color: black;
+                border-left-width: 3px;
+            }
+            .diff_add {background-color:#aaffaa}
+            .diff_chg {background-color:#ffff77}
+            .diff_sub {background-color:#ffaaaa}
+        </style>
+    </head>
+    """
+    KEYTABLE = """
+        <table class="diff" summary="Legends" id="legend">
+            <tr> <th colspan="2"> Legends </th> </tr>
+            <tr> <td> <table border="" summary="Colors">
+                        <tr><th> Colors </th> </tr>
+                        <tr><td class="diff_add">&nbsp;Added&nbsp;</td></tr>
+                        <tr><td class="diff_chg">Changed</td> </tr>
+                        <tr><td class="diff_sub">Deleted</td> </tr>
+                    </table></td>
+                <td> <table border="" summary="Links">
+                        <tr><th colspan="2"> Links </th> </tr>
+                        <tr><td>(f)irst change</td> </tr>
+                        <tr><td>(n)ext change</td> </tr>
+                        <tr><td>(t)op</td> </tr>
+                    </table></td> </tr>
+        </table>
+    """
+    TAIL = """
+            </body>
+        </html>
+    """
+    @classmethod
+    def diff_to_html(
+        cls, left, right, title, left_title, right_title, subtitle
+    ):
+        # Carry out comparison:
+        htmldiff = HtmlDiff()
+        html_data = htmldiff.make_table(
+            left,
+            right,
+            fromdesc=left_title,
+            todesc=right_title
+        )
+        output = (
+            cls.HEAD
+            + cls.BACKBUTTON
+            + cls.HEAD1.format(title)
+            + f'{cls.HEAD3.format(subtitle) if subtitle else ""}'
+            + html_data
+            + cls.BACKBUTTON
+            + cls.KEYTABLE
+            + cls.TAIL
+        )
+        return output
+def parse_args():
+    parser = argparse.ArgumentParser(__doc__)
+    parser.add_argument('left', help='The first file to compare.')
+    parser.add_argument('right', help='The second file to compare.')
+    parser.add_argument(
+        '-l', '--left-strip',
+        help='Regex expression acting on the left hand side of the diff',
+        dest='strip_left'
+    )
+    parser.add_argument(
+        '-r', '--right-strip',
+        help='Regex expression acting on the right hand side of the diff',
+        dest='strip_right'
+    )
+    parser.add_argument(
+        '-t', '--title',
+        help=(
+            'Add a title to the page, other than the names of the files'
+            ' being compared. If set the names of the files being compared'
+            ' will be added as a subtitle.'
+        )
+    )
+    parser.add_argument(
+        '-n', '--notes',
+        help='Additional notes to be added below the title and subtitle.'
+    )
+    parser.add_argument(
+        '-o', '--output',
+        help='Output file path. If unset output will be printed to stdout.',
+        dest='output'
+    )
+    return parser.parse_args()
+def read_file(filepath: Path, sub: Optional[str] = None) -> list[str]:
+    """Read file and carry out substutions on lines.
+    Returns a list of strings.
+    """
+    lines = Path(filepath).read_text().split('\n')
+    if sub:
+        lines = [re.sub(sub, '', line) for line in lines]
+    return lines
+def main():
+    # Parse command line args and environment variables:
+    opts = parse_args()
+    parsed_html = DiffDoc.diff_to_html(
+        read_file(opts.left, opts.strip_left),
+        read_file(opts.right, opts.strip_right),
+        opts.title or f'{opts.left} vs {opts.right}',
+        opts.left,
+        opts.right,
+        f'{opts.left} vs {opts.right}' if opts.title else None
+    )
+    if opts.output:
+        # Write html file
+        Path(opts.output).write_text(parsed_html)
+    else:
+        print(parsed_html)
+if __name__ == '__main__':
+    main()

diff2html-1.0/diff2html.egg-info/PKG-INFO ADDED Viewed

@@ -0,0 +1,39 @@
+Metadata-Version: 2.4
+Name: diff2html
+Version: 1.0
+Summary: CLI wrapper for Pythons Difflib builtin
+Author-email: "tim.pillinger" <tim.pillinger@metoffice.gov.uk>
+License-Expression: MIT
+Keywords: diff,html,difftool,difflib,cli
+Classifier: Programming Language :: Python
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: flake8; extra == "test"
+Dynamic: license-file
+# Diff2HTML
+Python's difflib is a great standard library feature.
+But I wanted a command line version.
+## Installation
+```
+pip install diff2html
+```
+## Usage
+```
+diff2html fileA fileB --output diff.html
+firefox diff.html
+```
+for advanced usage see:
+```
+diff2html --help
+```

diff2html-1.0/diff2html.egg-info/SOURCES.txt ADDED Viewed

@@ -0,0 +1,11 @@
+LICENSE.md
+README.md
+pyproject.toml
+diff2html/diff2html.py
+diff2html.egg-info/PKG-INFO
+diff2html.egg-info/SOURCES.txt
+diff2html.egg-info/dependency_links.txt
+diff2html.egg-info/entry_points.txt
+diff2html.egg-info/requires.txt
+diff2html.egg-info/top_level.txt
+test/test_e2e.py

diff2html-1.0/diff2html.egg-info/dependency_links.txt ADDED Viewed

	@@ -0,0 +1 @@
1	+

diff2html-1.0/diff2html.egg-info/entry_points.txt ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ [console_scripts]
2	+ diff2html = diff2html.diff2html:main

diff2html-1.0/diff2html.egg-info/requires.txt ADDED Viewed

@@ -0,0 +1,4 @@
+[test]
+pytest
+flake8

diff2html-1.0/diff2html.egg-info/top_level.txt ADDED Viewed

	@@ -0,0 +1 @@
1	+ diff2html

diff2html-1.0/pyproject.toml ADDED Viewed

@@ -0,0 +1,24 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+[project]
+name = 'diff2html'
+version = '1.0'
+authors = [
+    {'name' = 'tim.pillinger', 'email' = 'tim.pillinger@metoffice.gov.uk'}
+]
+description = "CLI wrapper for Pythons Difflib builtin"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICEN[CS]E.*"]
+keywords = ['diff', 'html', 'difftool', 'difflib', 'cli']
+classifiers = [
+  "Programming Language :: Python"
+]
+[project.optional-dependencies]
+test = ['pytest', 'flake8']
+[project.scripts]
+diff2html = "diff2html.diff2html:main"

diff2html-1.0/setup.cfg ADDED Viewed

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build =
+tag_date = 0

diff2html-1.0/test/test_e2e.py ADDED Viewed

@@ -0,0 +1,38 @@
+from pathlib import Path
+from shlex import split
+from subprocess import run
+REPO = Path(__file__).parent.parent
+KGO = REPO / 'test/example/example.html'
+COMMAND = split("""./diff_to_html \
+                test/example/foo1 \
+                test/example/foo2 \
+                --left-strip /some/very/long/path/to/a/ \
+                --right-strip /another/very/long/path/to/a/ \
+                --title "My Diff"
+""")
+def test_example():
+    f"""Test example output against KGO
+    Runs, from home of repo:
+    {COMMAND}
+    To update test, copy and add:
+    --output test/example/example.html \
+    """
+    result = run(COMMAND, capture_output=True, cwd=str(REPO))
+    assert result.returncode == 0
+    for res, kgo in zip(
+        result.stdout.decode().split('\n'),
+        (KGO).read_text().split('\n')
+    ):
+        assert res == kgo, f'{res} != {kgo}'