Metadata-Version: 2.4
Name: aksharam
Version: 0.1.1
Summary: Transliterate Malayalam text into English-style Manglish with a small set of fixes on top of ml2en
Author: Ajish K B
License-Expression: MIT
Project-URL: Homepage, https://github.com/Ajishkbn/aksharam
Project-URL: Repository, https://github.com/Ajishkbn/aksharam
Project-URL: Issues, https://github.com/Ajishkbn/aksharam/issues
Keywords: malayalam,transliteration,manglish,ml2en,linguistics
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Text Processing :: Linguistic
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: ml2en
Provides-Extra: dev
Requires-Dist: pytest>=8.0; extra == "dev"
Requires-Dist: build>=1.2.0; extra == "dev"
Requires-Dist: twine>=5.0.0; extra == "dev"
Dynamic: license-file

# aksharam

aksharam is a Python library for transliterating Malayalam text into English-style Manglish with a small set of compatibility fixes built on top of ml2en.

It provides a simple API for converting Malayalam words and phrases into Romanized Manglish output while preserving common transliteration nuances such as anusvaram handling, retroflex voicing, and compound-letter fixes.

## Installation

```bash
pip install aksharam
```

## Usage

```python
from aksharam import transliterate

print(transliterate("കൈ"))
# Kai
```

You can also transliterate multiple items at once:

```python
from aksharam import transliterate_text

print(transliterate_text(["കൈ", "ജ്ഞാനം", "ഓടുക"]))
```

## CLI

```bash
aksharam "കൈ"
```

## License and dependency notice

This package is distributed under the MIT License for the original work in this repository.
However, it depends on ml2en, which is licensed under GPLv2. If you redistribute or bundle this package in a way that includes or adapts ml2en code, the GPLv2 terms of that dependency should be considered.

## Author

Ajish K B

