Metadata-Version: 2.1
Name: pidiff
Version: 0.3.0
Summary: Python interface diff
Home-page: https://github.com/rohanpm/pidiff
Author: Rohan McGovern
Author-email: rohan@mcgovern.id.au
License: GNU General Public License
Platform: UNKNOWN
Description-Content-Type: text/markdown
Requires-Dist: jsonschema
Requires-Dist: virtualenv-api
Requires-Dist: semver

# pidiff

`pidiff` - the Python interface diffing tool

[![Build Status](https://circleci.com/gh/rohanpm/pidiff/tree/master.svg?style=svg)](https://circleci.com/gh/rohanpm/pidiff/tree/master)
[![Coverage Status](https://coveralls.io/repos/github/rohanpm/pidiff/badge.svg?branch=master)](https://coveralls.io/github/rohanpm/pidiff?branch=master)
[![Maintainability](https://api.codeclimate.com/v1/badges/64347682bb124ea1e1fb/maintainability)](https://codeclimate.com/github/rohanpm/pidiff/maintainability)

**This project is alpha quality and is not yet recommended for use**

`pidiff` is a tool to detect and report on API changes between multiple versions
of a Python module. It can be used as a testing tool to help a project follow
the [Semantic Versioning](https://semver.org/) spec.

## Examples

The `pidiff` command can install old and new package versions from PyPI and diff a
module between versions, failing if SemVer is not used appropriately.

Here's an example of a diff finding some problems:

````
$ pidiff more-executors==1.15.0 more-executors==1.16.0
more_executors/_executors.py:49: D200 object added: more_executors.Executors.flat_bind
more_executors/retry.py:46: D100 object removed: more_executors.retry.ExceptionRetryPolicy.new_default
more_executors/retry.py:133: D100 object removed: more_executors.retry.RetryExecutor.new_default

---------------------------------------------------------------------
Major API changes were found; inappropriate for 1.15.0 => 1.16.0
New version should be equal or greater than 2.0.0
````

Public API was removed without a major bump of the package version;
pidiff considers this an error and suggests the new minimum version
number which should be set to accept these changes.

Here's an example of a diff reporting a successful result:

````
$ pidiff more-executors==1.11.0 more-executors==1.12.0
more_executors/flat_map.py:0: D200 module added: more_executors.flat_map
more_executors/_executors.py:84: D200 object added: more_executors.Executors.with_flat_map

---------------------------------------------------------------------
Minor API changes were found; appropriate for 1.11.0 => 1.12.0
````

Public API was added; since there was a minor bump of the package version,
this is OK.

## License

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.


