Skip to content

Commit

Permalink
0.1.1-rc.1
Browse files Browse the repository at this point in the history
  • Loading branch information
jacebrowning committed Mar 4, 2014
1 parent d4d2f74 commit aebeedd
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 15 deletions.
6 changes: 6 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
Changelog
=========

0.1.1 (2014/03/03)
------------------

- README cleanup.


0.1 (2014/03/03)
----------------

Expand Down
19 changes: 5 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,7 @@ Comparable
[![Coverage Status](https://coveralls.io/repos/jacebrowning/comparable/badge.png?branch=master)](https://coveralls.io/r/jacebrowning/comparable?branch=master)
[![PyPI Version](https://badge.fury.io/py/Comparable.png)](http://badge.fury.io/py/Comparable)

Comparable is a library providing abstract base classes that enable
subclasses to be compared for "equality" and "similarity" based on their
attributes.
Comparable is a library providing abstract base classes that enable subclasses to be compared for "equality" and "similarity" based on their attributes.



Expand Down Expand Up @@ -38,33 +36,26 @@ Or directly from the source code:
Basic Usage
===========

After installation, abstract base classes can be imported from the
package:
After installation, abstract base classes can be imported from the package:

python
>>> import comparable
comparable.__version__
>>> from comparable import SimpleComparable, CompoundComparable

Comparable classes use `==` as the operation for "equality" and `%`
as the operation for "similarity". They may also override a `threshold`
attribute to set the "similarity" ratio.
Comparable classes use `==` as the operation for "equality" and `%` as the operation for "similarity". They may also override a `threshold` attribute to set the "similarity" ratio.


Simple Comparables
------------------

Simple comparable types must override the `equality` and `similarity`
methods to return bool and Similarity objects, respectively. See
`comparable.simple` for examples.
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.
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.



Expand Down
2 changes: 1 addition & 1 deletion comparable/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"""Package for Comparable."""

__project__ = 'Comparable'
__version__ = '0.1'
__version__ = '0.1.1-rc.1'

VERSION = __project__ + '-' + __version__

Expand Down

0 comments on commit aebeedd

Please sign in to comment.