skip to navigation
skip to content

Not Logged In

romkan 0.2.1

A Romaji/Kana conversion library

Package Documentation

python-romkan

python-romkan is a Romaji/Kana conversion library for Python, which is used to convert a Japanese Romaji (ローマ字) string to a Japanese Kana (仮名) string or vice versa.

It is the Pythonic port of Ruby/Romkan, originally authored by Satoru Takabayashi and ported by Masato Hagiwara.

python-romkan works on Python 2 and Python 3 (fully tested on Python 2.6, 2.7, 3.2, 3.3 and PyPy). It handles both Katakana (片仮名) and Hiragana (平仮名) with the Hepburn (ヘボン式) romanization system, as well as the modern Kunrei-shiki (訓令式) romanization system.

Project homepage: http://www.soimort.org/python-romkan

Fork me on GitHub: https://github.com/soimort/python-romkan

https://api.travis-ci.org/soimort/python-romkan.png

Installation

  1. Install via Pip:

    $ pip install romkan
    
  2. Install via EasyInstall:

    $ easy_install romkan
    
  3. Install from Git:

    $ git clone git://github.com/soimort/python-romkan.git
    $ python setup.py install
    

Usage

Python 3.x:

$ python
>>> import romkan
>>> print(romkan.to_roma("にんじゃ"))
ninja
>>> print(romkan.to_hepburn("にんじゃ"))
ninja
>>> print(romkan.to_kunrei("にんじゃ"))
ninzya
>>> print(romkan.to_hiragana("ninja"))
にんじゃ
>>> print(romkan.to_katakana("ninja"))
ニンジャ

Python 2.x:

$ python2
>>> import romkan
>>> print romkan.to_roma(u"にんじゃ")
ninja
>>> print romkan.to_hepburn(u"にんじゃ")
ninja
>>> print romkan.to_kunrei(u"にんじゃ")
ninzya
>>> print romkan.to_hiragana("ninja")
にんじゃ
>>> print romkan.to_katakana("ninja")
ニンジャ

API Reference

  • to_katakana(string)

Convert a Romaji (ローマ字) to a Katakana (片仮名).

  • to_hiragana(string)

Convert a Romaji (ローマ字) to a Hiragana (平仮名).

  • to_kana(string)

Convert a Romaji (ローマ字) to a Katakana (片仮名). (same as to_katakana)

  • to_hepburn(string)

Convert a Kana (仮名) or a Kunrei-shiki Romaji (訓令式ローマ字) to a Hepburn Romaji (ヘボン式ローマ字).

  • to_kunrei(string)

Convert a Kana (仮名) or a Hepburn Romaji (ヘボン式ローマ字) to a Kunrei-shiki Romaji (訓令式ローマ字).

  • to_roma(string)

Convert a Kana (仮名) to a Hepburn Romaji (ヘボン式ローマ字).

License

python-romkan is licensed under the BSD license.

Changelog

0.2.1

Date: 2013-02-26

  • Improved Python compatibility (2.6, <=3.1).

0.2.0

Date: 2013-02-21

  • Fixed the explicit unicode literal issue on Python 3.2.
  • Tested on Travis CI for Python 2.7, 3.2, 3.3 and PyPy.

0.1.0

Date: 2013-02-12

0.0.2

Date: 2013-01-29

  • Fixed #1.

0.0.1

Date: 2012-12-06

  • Initial release.
 
File Type Py Version Uploaded on Size
romkan-0.2.1-py3.3.egg (md5) Python Egg 3.3 2013-02-26 14KB
romkan-0.2.1.tar.gz (md5) Source 2013-02-26 10KB
  • Downloads (All Versions):
  • 40 downloads in the last day
  • 259 downloads in the last week
  • 987 downloads in the last month