numutil
=======

numutil is a python package for converting strings to and from numbers.
For example,

    >>> from numutil import str2num, num2str
    >>> str2num('1.3 million')
    1300000
    >>> str2num('three and a half')
    Fraction(7, 2)
    >>> str2num('123,456.789')
    123456.789
    >>> str2num('four score and seven')
    87
    >>> num2str(1234567, style='newspaper')
    '1.23 million'
    >>> num2str(1234567, style='words')
    'one million, two hundred thirty four thousand, five hundred sixty seven'

It exposes two functions to the user: str2num and num2str, which do what you 
would think.

Installation
------------

You can install numutil from source with
    
    $ sudo python setup.py install

Testing
-------

numutil is reasonably well-tested. You can test numutil yourself with
    
    $ python test.py

In addition to testing numutil directly, test.py also tests the documentation
in numutil.py and this README with the doctest module, so all examples in the
documentation are guaranteed to be correct if the tests pass.

License
-------

numutil is BSD licensed. You can read the details in the LICENSE file.

TODO List, Wish List, and Known Bugs
------------------------

* implement printing and reading facebook style: ("54.2K")
* fix str2num("1,2,3") == 123 bug?
* test different python versions, esp. python3
* change to pep8 style
* prevent some of the recursions in num2str?
* test on 64bit machines, especially with floats
* get nosetests to work again
* maybe implement a number finder, extracting lists of numbers from strings?
* add a rounding option for completion, (eg for currencies)?
* implement printing floats as words?
* support locale-issues, (like commas vs decimal points)

Author and Maintainer
---------------------

Naftali Harris

www.naftaliharris.com