README example raise ValueError

[Aluriak]

Example found in README (reproduced below) raise a ValueError due to non-valid unpacking, since aligner('AAAAAAAAAAAAACCTGCGCCCCAAAAAAAAAAAAAAAAAAAA', 'CCTGCGCACCCC', method='global_cfe') does not returns a 2-unpackable value.

Python 2.7.13 (default, Jan 13 2017, 10:15:16) 
[GCC 6.3.1 20161221 (Red Hat 6.3.1-1)] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> from align.matrix import DNAFULL
>>> from align import aligner
>>> aligner('WW','WEW', method= 'global')
[AlignmentResult(seq1='W-W', seq2='WEW', start1=0, start2=0, end1=2, end2=3, n_gaps1=1, n_gaps2=0, n_mismatches=0, score=15.0)]
>>> aligner('WW','WEWWEW', method= 'glocal')
[AlignmentResult(seq1='WW', seq2='WW', start1=0, start2=2, end1=2, end2=4, n_gaps1=0, n_gaps2=0, n_mismatches=0, score=22.0)]
>>> aligner('TAATTC', 'TAAT', method='global', matrix=DNAFULL, gap_open=-10, gap_extend=-1)
[AlignmentResult(seq1='TAATTC', seq2='TAAT--', start1=0, start2=0, end1=6, end2=4, n_gaps1=0, n_gaps2=1, n_mismatches=0, score=9.0)]
>>> aligner('PYNCHAN', 'YNCH', method='local')
[AlignmentResult(seq1='YNCH', seq2='YNCH', start1=1, start2=0, end1=5, end2=4, n_gaps1=0, n_gaps2=0, n_mismatches=0, score=30.0)]
>>> a, b = aligner('AAAAAAAAAAAAACCTGCGCCCCAAAAAAAAAAAAAAAAAAAA', 'CCTGCGCACCCC', method='global_cfe')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ValueError: need more than 1 value to unpack
>>> aligner('AAAAAAAAAAAAACCTGCGCCCCAAAAAAAAAAAAAAAAAAAA', 'CCTGCGCACCCC', method='global_cfe')
[AlignmentResult(seq1='AAAAAAAAAAAAACCTGCGC-CCCAAAAAAAAAAAAAAAAAAAA', seq2='-------------CCTGCGCACCCC-------------------', start1=0, start2=0, end1=43, end2=12, n_gaps1=1, n_gaps2=2, n_mismatches=1, score=73.0)]

[bow]

Hi @Aluriak (& @brentp),

The README has not been updated for the latest changes made to the code due to my PR, I gather. This looks like a simple enough change (?), but maybe this can be done while also updating other parts of the README?

Anyway, since this was due to the code I added earlier, let me know if anyone prefers that I open anew PR to address this.

[Aluriak]

This probably should be fixed ; it is a detail that have its importance when someone is discovering the project. Copy-pastable working example is IMHO the most important feature.

Also, i agree that the README should provides more information, notabily about installation and python versions compatibility (a big effort was made for both dinopython and python compliancy, but nothing is said about it, included in the trove classifiers).

bf27516a0514a85a561f76da97 implements some of these remarks in the README.

[dburkhardt]

I would appreciate a more in-depth readme or documentation on usage, features, and kinds of output.