uroman - Universal Romanizer

Warnings

• breaking Version 1.3.1 marked a complete rewrite of the library from Perl to Python. Code written for previous versions (pre-1.3.1) is incompatible and will not work with the Python version.
  Fix: Users migrating from Perl versions must entirely rewrite their integration code, as the API, dependencies, and execution environment have fundamentally changed. Refer to the Python examples in the official documentation.
• gotcha The uroman Python library (v1.3.1 and later) requires Python 3.10 or newer. Attempting to install or run it with older Python versions will result in installation failures or runtime errors.
  Fix: Ensure your Python environment is version 3.10 or higher before installing `uroman`. Upgrade your Python interpreter or use a virtual environment with the correct version.

Install

• pip install uroman Install latest version

Imports

• romanize

  import uroman
  romanized_text = uroman.romanize("...")

Quickstart

Demonstrates how to import the uroman library and use the main `romanize` function to convert text from various scripts to the Latin alphabet.

import uroman

text_in_any_script = "你好世界"
romanized_text = uroman.romanize(text_in_any_script)

print(f"Original: {text_in_any_script}")
print(f"Romanized: {romanized_text}")

# Example with another script
text_arabic = "مرحبا بالعالم"
print(f"Arabic: {text_arabic} -> {uroman.romanize(text_arabic)}")