Metadata-Version: 2.4
Name: spanum
Version: 0.0.2
Summary: Python module that converts numbers to Spanish numerals and vice versa.
Project-URL: Homepage, https://github.com/marydrobotun/spanum
Project-URL: Documentation, https://spanum.readthedocs.io/en/latest
Project-URL: Repository, https://github.com/marydrobotun/spanum
Author-email: Mary Drobotun <marydrobotun@gmail.com>
Maintainer-email: Mary Drobotun <marydrobotun@gmail.com>
License-Expression: MIT
Keywords: numbers,numerals,spanish
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Requires-Python: >=3.10
Description-Content-Type: text/markdown

# spanum
The `spanum` Python module converts numbers to Spanish numerals and vice versa.
## Installation
```
pip install spanum
```
## Functions

### `spanum.numbers_to_words.number_to_words(n: int) -> str`

-   **Description**: Converts a number to its Spanish word representation.

    
-   **Parameters**:
    
    -   `n` (int): Any number you want to convert.
        
-   **Returns**: The Spanish word for the provided number (str).


### `spanum.words_to_numbers.words_to_number(text: str) -> int`

-   **Description**: Converts a Spanish numeral to an integer.

    
-   **Parameters**:
    
    -   `text` (str):  Any Spanish numeral you want to convert.
        
-   **Returns**: The integer value corresponding to the provided Spanish numeral (int).

