Metadata-Version: 2.1
Name: n2w-it
Version: 1.0.1
Summary: Converts numbers to italian words.
Home-page: https://github.com/IlGalvo/N2W-IT
Author: Andrea Galvani
Author-email: Andrea.Galvani96@outlook.com
License: MIT license
Keywords: n2w-it,n2w_it,italian number words converter
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Natural Language :: Italian
Classifier: Environment :: Console
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development :: Internationalization
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Localization
Classifier: Topic :: Text Processing :: Linguistic
Requires-Python: >=3.5
Description-Content-Type: text/markdown

# N2W-IT
This library convert numbers to italian words.\
For example: `73` -> `settantatré`.

It currently only supports converting numbers to **singular male** words.

## Installation ##
  - The easy way is to install from PyPI: `pip install n2w-it`.
  - Otherwise, you can download source package e manually install with: `pip install .` (desirable way),\
    or with: `python setup.py install`.

## Test ##
  - You can run: `python setup.py test`.
  - Otherwise you can directly test with: `unittest`.

## Usage ##
  - ### Command line ###
    The easy way to use, is to launch directly from terminal:
    ```
    $ n2w-it 73
    settantatré
    ```

  - ### Import ###
    You can import the libray in your code:
    ```
    from n2w_it import N2W_IT
    instance = N2W_IT()
    try:
      result = instance.number_to_words("73")
      print(result) #settantatré
    except Exception as exception:
      print(exception)
    ```

## APIs ##
  - The library supports number conversion in italian from:
    - Integer to cardinal: `int_to_cardinal(73)` -> `settantatré`.
    - Float to cardinal: `float_to_cardinal(73.37)` -> `settantatré virgola trentasette`.
    - Integer to ordinal: `int_to_ordinal(73)` -> `settantatreesimo`.
    - Roman to ordinal: `roman_to_ordinal("LXXIII")` -> `settantatreesimo`.

  - And a heuristic version:\
  _(If the `argument` passed is `None or Empty`, or the number format\
  is not found or valid, an `Exception` is raised.)_
    - `number_to_words("73")` -> `settantatré`.
    - `number_to_words("73.37")` -> `settantatré virgola trentasette`.
    - `number_to_words("73°")`  -> `settantatreesimo`.
    - `number_to_words("LXXIII")` -> `settantatreesimo`.
    - `number_to_words("LXXIII°")` -> `settantatreesimo`.

# History

## 1.0.1 (2021-03-30) ##
  - Updated documentation.

## 1.0.0 (2021-03-30) ##
  - First release on PyPI.

