Metadata-Version: 2.1
Name: numtofi
Version: 0.3
Summary: A package to convert numbers to Finnish textual representation
Home-page: https://github.com/markomanninen/numtofi
Author: Marko T. Manninen
Author-email: elonmedia@gmail.com
Description-Content-Type: text/markdown
License-File: LICENSE

# `numtofi` - Convert numbers to Finnish textual representation

`numtofi` is a Python module that offers functionality to convert integers into their Finnish textual representation. This module also comes with a command-line interface (CLI) tool to quickly get the Finnish representation for any number from the command line.

## Installation

```bash
pip install numtofi
```

## Usage

### As a Python Module

```python
from numtofi import number_to_word

print(number_to_word(45))  # Outputs "neljÃ¤kymmentÃ¤viisi"
```

### Command-Line Interface (CLI)

After installation, you can use the `numtofi` command directly from your terminal:

```bash
$ numtofi 45
neljÃ¤kymmentÃ¤viisi

$ numtofi 5000000
viisi miljoonaa

$ numtofi 5000000 --nospace
viisimiljoonaa
```

## Parameters

- `number_to_word(n, space=False)`:
  - `n (int)`: The number to convert.
  - `space (bool)`: If `False`, removes spaces between words. Default is `True`.

## Testing

Tests are provided in the `tests` directory. To run the tests:

1. Navigate to the project root directory.
2. Run:

```bash
python -m unittest discover tests
```

## Update PYPI package

```bash
python setup.py sdist bdist_wheel
```

```bash
python -m twine upload dist/*
```

## Contributing

Contributions are welcome! Please make sure to update tests as appropriate when proposing changes.

## License

[MIT](LICENSE)
