Comparable 1.0

Requirements

• Python 3.3+

Installation

Comparable can be installed with pip:

$ pip install comparable

or directly from the source code:

$ git clone https://github.com/jacebrowning/comparable.git
$ cd comparable
$ python setup.py install

Simple Comparables

Simple comparable types must override the equality and similarity methods to return bool and Similarity objects, respectively. See comparable.simple for examples.

Compound Comparables

Compound comparable types contain multiple simple comparable types. They must override the attributes property to define which attributes should be used for comparison. See comparable.compund for examples.

Requirements

• Make:

  • Windows: http://cygwin.com/install.html

  • Mac: https://developer.apple.com/xcode

  • Linux: http://www.gnu.org/software/make (likely already installed)

• virtualenv: https://pypi.python.org/pypi/virtualenv#installation

• Pandoc: http://johnmacfarlane.net/pandoc/installing.html

• Graphviz: http://www.graphviz.org/Download.php

Installation

Create a virtualenv:

$ make env

Run the tests:

$ make test
$ make tests  # includes integration tests

Build the documentation:

$ make doc

Run static analysis:

$ make pep8
$ make pep257
$ make pylint
$ make check  # includes all checks

Prepare a release:

$ make dist  # dry run
$ make upload

1.0 (2015/03/19)

• Freeze public API.

0.2.1 (2014/05/17)

• Added __bool__ to the base simple type.

0.2 (2014/05/12)

• Added similarity assertions to the TestCase class.

0.1.1 (2014/03/03)

• README cleanup.

0.1 (2014/03/03)

• Code cleanup.

0.0.3 (2013/10/13)

• Comparable.threshold is now an attribute (instead of property)

• Fixed package-level imports

0.0.2 (2013/10/04)

• Replaced Comparable.equality_list/similarity_dict with attributes

• Replaced Comparable.similarity_threshold with threshold

0.0.1 (2013/10/02)

• Initial release of Comparable.