Metadata-Version: 2.1
Name: pip-wheel-diff
Version: 0.9
Summary: Download or build two wheels and launch a diff tool to compare them
Project-URL: Documentation, https://github.com/sbidoul/pip-wheel-diff#readme
Project-URL: Issues, https://github.com/sbidoul/pip-wheel-diff/issues
Project-URL: Source, https://github.com/sbidoul/pip-wheel-diff
Author-email: Stéphane Bidoul <stephane.bidoul@gmail.com>
License-Expression: MIT
License-File: LICENSE.txt
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.7
Requires-Dist: pip
Description-Content-Type: text/markdown

# pip-wheel-diff

[![PyPI - Version](https://img.shields.io/pypi/v/pip-wheel-diff.svg)](https://pypi.org/project/pip-wheel-diff)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pip-wheel-diff.svg)](https://pypi.org/project/pip-wheel-diff)

-----

**Table of Contents**

- [Installation](#installation)
- [License](#license)

## Installation

```console
pipx install "pip-wheel-diff @ https://github.com/sbidoul/pip-wheel-diff"
```

## Usage

Imagine you have to review a pull request with a diff like this in `requirements.txt`.

![A diff in requirements.txt](docs/diff.png)

How do you verify the change is what you expect?

To answer this question, you can run `pip-wheel-diff` with two pip requirements as
arguments. It will download or build the wheels, unzip them, clean them up a little bit
for comparability and run a diff tool to compare them.

Example:

```console
pip-wheel-diff \
  "odoo-addon-stock-release-channel @ git+https://github.com/acsone/wms.git@ede1d6f9aa16cae535d650da3191bb6a6d86f793#subdirectory=setup/stock_release_channel" \
  "odoo-addon-stock-release-channel==16.0.2.6.5"
```

It tries to find a diff tool in the following order:
- `meld`
- `diff -r`

## License

`pip-wheel-diff` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
