Skip to main content

A converter to romanize Japanese hiragana/katakana string

Project description

`romaji` is a converter library to romanize Japanese hiragana/katakana string by standard and IME typing style.
Even though `pykakasi <>`_ already has provided the same functions, and returns only one romanized string.
However, there exists several different romanization systems, so one hiragana/katakana string has so many romanize string.
For example, `"ちゃ"` can be romanized as `"cha"`, `"tya"`, `"chixya"`, `"tixya"`, `"chilya"`, or `"tilya"`.
`romaji` provides romanized strings as many as possible.

If an input string contained non hiragana/katakana characters (includes kanji), `romaji` return the characters as same as the input.
For example, `romaji` converts the input `"お茶の水"` to `"o茶no水"`.
If there is a need to romanize the whole string which includes kanji, `romaji` can romaize the readings in the tokens which `Janome <>`_ tokenizer provides.
`romaji` strongly recommends to use with `Janome`.

The mapping from hiragana/katakana to romaji is based on common IME's system to input Japanese.
Therefor, `romaji` does not directly implement the standard system like Hepburn, Nihon-shiki or Kunrei-shiki, but includes them.


.. code-block:: BashLexer

$ pip install romaji


.. code-block:: python

>>> import romaji
>>> romaji.transliterate('僕ドラえもん')
['僕doraemon', '僕doraemon\'', '僕doraemonn']
>>> romaji.transliterate('諸行無常')

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

romaji-0.0.2.tar.gz (9.6 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page