diffa


Namediffa JSON
Version 0.0.4 PyPI version JSON
download
home_pageNone
SummaryA very simple python package for creating a HTML line diff between two files.
upload_time2025-01-05 19:07:45
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseMIT License Copyright (c) 2024 Tom Carter 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.
keywords sample setuptools development
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # diffa   
_A simple CLI tool for generating nice HTML diffs between two files._  

## 🌟 Features  
- Generates pretty colour-coded **HTML diffs**.  
- Supports both **unified view** and **side-by-side view**.  

## 📦 Installation  
Use pip to install diffa from PyPI:  
```bash
pip install diffa
```

## 🛠️ Usage
Run diffa from the command line to create a shiny HTML diff.

```bash
diffa file1.txt file2.txt output.html
````

### Options
`--side-by-side`: Adds a side-by-side comparison to the output.

## The Output
Open the generated HTML file in your browser to see:

- Lines added in green
- Lines removed in red
- Matching lines in white

## 💡 Ideas for Use
- Code Reviews: Quickly generate diffs for commits or branches.
- Document Comparison: Spot the differences between document revisions.
- Configuration Changes: Compare config files across environments.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "diffa",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "Tom Carter <tomcarter017@gmail.com>",
    "keywords": "sample, setuptools, development",
    "author": null,
    "author_email": "Tom Carter <tomcarter017@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/34/2d/93714abb43da54350036ca394075e6a14ad61bfcd72b29594635b7865e5d/diffa-0.0.4.tar.gz",
    "platform": null,
    "description": "# diffa   \n_A simple CLI tool for generating nice HTML diffs between two files._  \n\n## \ud83c\udf1f Features  \n- Generates pretty colour-coded **HTML diffs**.  \n- Supports both **unified view** and **side-by-side view**.  \n\n## \ud83d\udce6 Installation  \nUse pip to install diffa from PyPI:  \n```bash\npip install diffa\n```\n\n## \ud83d\udee0\ufe0f Usage\nRun diffa from the command line to create a shiny HTML diff.\n\n```bash\ndiffa file1.txt file2.txt output.html\n````\n\n### Options\n`--side-by-side`: Adds a side-by-side comparison to the output.\n\n## The Output\nOpen the generated HTML file in your browser to see:\n\n- Lines added in green\n- Lines removed in red\n- Matching lines in white\n\n## \ud83d\udca1 Ideas for Use\n- Code Reviews: Quickly generate diffs for commits or branches.\n- Document Comparison: Spot the differences between document revisions.\n- Configuration Changes: Compare config files across environments.\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2024 Tom Carter  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. ",
    "summary": "A very simple python package for creating a HTML line diff between two files.",
    "version": "0.0.4",
    "project_urls": {
        "Homepage": "https://github.com/tomcarter23/diffa",
        "Issues": "https://github.com/tomcarter23/diffa/issues"
    },
    "split_keywords": [
        "sample",
        " setuptools",
        " development"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1a269d096cddd423e4e0ed6ffacbcac1aec1b68141dcf09f1befe8337289f4ca",
                "md5": "5bef42138100b1839dceb95df42674e6",
                "sha256": "aececd457a6bd41e218b4d7573eba8a50d024707dba7294891cfd55e51a87950"
            },
            "downloads": -1,
            "filename": "diffa-0.0.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5bef42138100b1839dceb95df42674e6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 4751,
            "upload_time": "2025-01-05T19:07:44",
            "upload_time_iso_8601": "2025-01-05T19:07:44.671948Z",
            "url": "https://files.pythonhosted.org/packages/1a/26/9d096cddd423e4e0ed6ffacbcac1aec1b68141dcf09f1befe8337289f4ca/diffa-0.0.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "342d93714abb43da54350036ca394075e6a14ad61bfcd72b29594635b7865e5d",
                "md5": "6037bdb1fea822d100eebb32b33dce77",
                "sha256": "2911f9b6912ffeefe8ecc464087f54ab1974022306faa47f43d956c3a53f9c02"
            },
            "downloads": -1,
            "filename": "diffa-0.0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "6037bdb1fea822d100eebb32b33dce77",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 4197,
            "upload_time": "2025-01-05T19:07:45",
            "upload_time_iso_8601": "2025-01-05T19:07:45.662373Z",
            "url": "https://files.pythonhosted.org/packages/34/2d/93714abb43da54350036ca394075e6a14ad61bfcd72b29594635b7865e5d/diffa-0.0.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-05 19:07:45",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "tomcarter23",
    "github_project": "diffa",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "diffa"
}
        
Elapsed time: 0.83886s