Metadata-Version: 1.0
Name: num2words
Version: 0.5.3
Summary: Modules to convert numbers to words. Easily extensible.
Home-page: https://github.com/savoirfairelinux/num2words
Author: Savoir-faire Linux inc.
Author-email: virgil.dupras@savoirfairelinux.com
License: LGPL
Description: num2words - Convert numbers to words in multiple languages
        ==========================================================
        
        ``num2words`` is a library that converts numbers like ``42`` to words like ``forty-two``. It
        supports multiple languages (English, French, Spanish, German and Lithuanian) and can even generate
        ordinal numbers like ``forty-second`` (altough this last feature is a bit buggy at the moment).
        
        The project is hosted on https://github.com/savoirfairelinux/num2words
        
        Installation
        ------------
        
        The easiest way to install ``num2words`` is to use pip::
        
            pip install num2words
        
        Otherwise, you can download the source package and then execute::
        
            python setup.py install
        
        The test suite in this library new, so it's rather thin, but it can be ran with::
        
            python setup.py test
        
        Usage
        -----
        
        There's only one function to use::
        
            >>> from num2words import num2words
            >>> num2words(42)
            forty-two
            >>> num2words(42, ordinal=True)
            forty-second
            >>> num2words(42, lang='fr')
            quarante-deux
        
        Besides the numerical argument, there's two optional arguments.
        
        **ordinal:** A boolean flag indicating to return an ordinal number instead of a cardinal one.
        
        **lang:** The language in which to convert the number. Supported values are:
        
        * ``en`` (English, default)
        * ``fr`` (French)
        * ``de`` (German)
        * ``es`` (Spanish)
        * ``lt`` (Lithuanian)
        * ``lv`` (Latvian)
        * ``en_GB`` (British English)
        * ``en_IN`` (Indian English)
        
        You can supply values like ``fr_FR``, the code will be
        correctly interpreted. If you supply an unsupported language, ``NotImplementedError`` is raised.
        Therefore, if you want to call ``num2words`` with a fallback, you can do::
        
            try:
                return num2words(42, lang=mylang)
            except NotImplementedError:
                return num2words(42, lang='en')
        
        History
        -------
        
        ``num2words`` is based on an old library , ``pynum2word`` created by Taro Ogawa in 2003.
        Unfortunately, the library stopped being maintained and the author can't be reached. There was
        another developer, Marius Grigaitis, who in 2011 added Lithuanian support, but didn't take over
        maintenance of the project.
        
        I am thus basing myself on Marius Grigaitis' improvements and re-publishing ``pynum2word`` as
        ``num2words``.
        
        Virgil Dupras, Savoir-faire Linux
        
        
        Changelog
        =========
        
        Version 0.5.3 -- 2015/06/09
        ---------------------------
        
        * Fix packaging issues. (#21, #22)
        
        Version 0.5.2 -- 2015/01/23
        ---------------------------
        
        * Added Latvian localization. (#9)
        * Improved Spanish localization. (#10, #13, #14)
        * Improved Lithuanian localization. (#12)
        
        Version 0.5.1 -- 2014/03/14
        ---------------------------
        
        * Added Python 3 support with 2to3. (#3)
        * Fixed big numbers in spanish. (#2)
        * Fixed bugs in tanslation from 30 to 40 in spanish. (#4)
        * Fixed word joining in english. (#8)
        
        Version 0.5.0 -- 2013/05/28
        ---------------------------
        
        * Created ``num2words`` based on the old ``pynum2word`` project.
        
Keywords: number word numbers words convert conversion i18n localisation localization internationalisation internationalization
Platform: UNKNOWN
