mirror of
https://github.com/bblaz/num2words.git
synced 2025-12-06 14:52:25 +00:00
182b82cf1f
Squashed commit of the following: commit 88b946ef72928e859d078f3febaf9c76ce0849b9 Merge: bca0277 79ab811 Author: Noah Santacruz <noahssantacruz@gmail.com> Date: Tue Nov 22 09:41:05 2016 +0200 merge commit bca0277424c074af217df5e86abfd2def3a30bc7 Author: Noah Santacruz <noahssantacruz@gmail.com> Date: Tue Nov 22 09:40:03 2016 +0200 removed out.txt commit 79ab811e97fd14bc5899174b198e86f5c6ba2c5f Author: Noah Santacruz <noahssantacruz@gmail.com> Date: Mon Nov 21 18:09:42 2016 +0200 Update README.rst commit 507e4d4cec5b5458b2546ebebe5e49d376b88646 Author: Noah Santacruz <noahssantacruz@gmail.com> Date: Mon Nov 21 18:08:39 2016 +0200 updated init commit 7d3aa5ab33d92b0b374ed1bfbf17807836e465bf Author: Noah Santacruz <noahssantacruz@gmail.com> Date: Mon Nov 21 16:05:06 2016 +0200 changed init commit 29b4c54047ff9ab84b4c95e9ff05ebcb12c15f49 Author: Noah Santacruz <noahssantacruz@gmail.com> Date: Mon Nov 21 16:01:17 2016 +0200 added Hebrew
80 lines
2.3 KiB
ReStructuredText
80 lines
2.3 KiB
ReStructuredText
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)
|
|
* ``no`` (Norwegian)
|
|
* ``pl`` (Polish)
|
|
* ``ru`` (Russian)
|
|
* ``dk`` (Danish)
|
|
* ``pt_BR`` (Brazilian Portuguese)
|
|
* ``he`` (Hebrew)
|
|
|
|
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
|