jardiff

Name	jardiff JSON
Version	0.2.0 JSON
	download
home_page	None
Summary	Compare JAR libraries between two directories. Maven-aware, classifier-aware, resilient.
upload_time	2025-08-21 03:29:39
maintainer	None
docs_url	None
author	Mohamed Sadok Aounallah
requires_python	>=3.8
license	MIT License Copyright (c) 2025 Sadok Aounallah 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	dependencies diff jar java maven
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # jardiff

`jardiff` is a command-line tool for comparing two directories of Java
archive (JAR) files.  It attempts to identify matching libraries by
examining Maven metadata (`pom.properties` inside the JAR), manifest
attributes, and heuristics based on the filename.  Versions are parsed
robustly, including common qualifiers such as `SNAPSHOT` or `alpha`, and
classifier suffixes like `sources` or `tests` are accounted for when
present.

The tool can output human-readable text summaries or structured JSON/XML
reports.  It optionally computes cryptographic hashes of the JAR files
to detect content changes even when the version string remains the same.

## Installation

The package is available on PyPI.  The recommended way to install
command-line utilities is with [`pipx`](https://pypi.org/project/pipx/):

```bash
pipx install jardiff
```

Alternatively, you can use `pip` directly:

```bash
pip install jardiff
```

## Usage

To compare two directories of JAR files:

```bash
jardiff diff path/to/libA path/to/libB
```

Key options include:

| Option           | Description                                              |
|------------------|----------------------------------------------------------|
| `-r`, `--recurse`| Scan subdirectories recursively                         |
| `--packages`     | Compare Java package sets to detect API differences      |
| `--hash`         | Compute file hashes (`sha1`, `sha256`, `md5`)            |
| `--format`       | Output format: `text` (default), `json`, or `xml`        |
| `--output`       | Write the output to the specified file instead of stdout |

For example, to produce a JSON report of the differences:

```bash
jardiff diff --format json --output report.json /opt/app/lib_old /opt/app/lib_new
```

See the command-line help for more details:

```bash
jardiff diff --help
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "jardiff",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "dependencies, diff, jar, java, maven",
    "author": "Mohamed Sadok Aounallah",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/3c/ef/c8377aa0a169a9b6ddf6787d823b47ffd6b1343380c2fd448b9c798b4aab/jardiff-0.2.0.tar.gz",
    "platform": null,
    "description": "# jardiff\n\n`jardiff` is a command-line tool for comparing two directories of Java\narchive (JAR) files.  It attempts to identify matching libraries by\nexamining Maven metadata (`pom.properties` inside the JAR), manifest\nattributes, and heuristics based on the filename.  Versions are parsed\nrobustly, including common qualifiers such as `SNAPSHOT` or `alpha`, and\nclassifier suffixes like `sources` or `tests` are accounted for when\npresent.\n\nThe tool can output human-readable text summaries or structured JSON/XML\nreports.  It optionally computes cryptographic hashes of the JAR files\nto detect content changes even when the version string remains the same.\n\n## Installation\n\nThe package is available on PyPI.  The recommended way to install\ncommand-line utilities is with [`pipx`](https://pypi.org/project/pipx/):\n\n```bash\npipx install jardiff\n```\n\nAlternatively, you can use `pip` directly:\n\n```bash\npip install jardiff\n```\n\n## Usage\n\nTo compare two directories of JAR files:\n\n```bash\njardiff diff path/to/libA path/to/libB\n```\n\nKey options include:\n\n| Option           | Description                                              |\n|------------------|----------------------------------------------------------|\n| `-r`, `--recurse`| Scan subdirectories recursively                         |\n| `--packages`     | Compare Java package sets to detect API differences      |\n| `--hash`         | Compute file hashes (`sha1`, `sha256`, `md5`)            |\n| `--format`       | Output format: `text` (default), `json`, or `xml`        |\n| `--output`       | Write the output to the specified file instead of stdout |\n\nFor example, to produce a JSON report of the differences:\n\n```bash\njardiff diff --format json --output report.json /opt/app/lib_old /opt/app/lib_new\n```\n\nSee the command-line help for more details:\n\n```bash\njardiff diff --help\n```\n",
    "bugtrack_url": null,
    "license": "MIT License\n        \n        Copyright (c) 2025 Sadok Aounallah\n        \n        Permission is hereby granted, free of charge, to any person obtaining a copy\n        of this software and associated documentation files (the \"Software\"), to deal\n        in the Software without restriction, including without limitation the rights\n        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n        copies of the Software, and to permit persons to whom the Software is\n        furnished to do so, subject to the following conditions:\n        \n        The above copyright notice and this permission notice shall be included in all\n        copies or substantial portions of the Software.\n        \n        THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n        SOFTWARE.",
    "summary": "Compare JAR libraries between two directories. Maven-aware, classifier-aware, resilient.",
    "version": "0.2.0",
    "project_urls": null,
    "split_keywords": [
        "dependencies",
        " diff",
        " jar",
        " java",
        " maven"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "567acdbe3f6e5ace5952dbebeb7dd2e732149dee0c6f4877a9801cb37bb08f3e",
                "md5": "14fc0faa2f270b76934b1981328b3bf4",
                "sha256": "5b5a2feacd2b1656813f4d7764720dbca3a8a46582cb7b5b65157a4ddcbaa23c"
            },
            "downloads": -1,
            "filename": "jardiff-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "14fc0faa2f270b76934b1981328b3bf4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 13280,
            "upload_time": "2025-08-21T03:29:38",
            "upload_time_iso_8601": "2025-08-21T03:29:38.372634Z",
            "url": "https://files.pythonhosted.org/packages/56/7a/cdbe3f6e5ace5952dbebeb7dd2e732149dee0c6f4877a9801cb37bb08f3e/jardiff-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "3cefc8377aa0a169a9b6ddf6787d823b47ffd6b1343380c2fd448b9c798b4aab",
                "md5": "c5b9b4184c8348ebf5d07b691716507b",
                "sha256": "36fd2f7208c8962de0e6e4d87bab79566caffdc28e2ac8e18c7bc50b2e612f60"
            },
            "downloads": -1,
            "filename": "jardiff-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "c5b9b4184c8348ebf5d07b691716507b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 17743,
            "upload_time": "2025-08-21T03:29:39",
            "upload_time_iso_8601": "2025-08-21T03:29:39.260690Z",
            "url": "https://files.pythonhosted.org/packages/3c/ef/c8377aa0a169a9b6ddf6787d823b47ffd6b1343380c2fd448b9c798b4aab/jardiff-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-21 03:29:39",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "jardiff"
}