Welcome to Dragon Mapper’s documentation!

Dragon Mapper is a Python library that provides identification and conversion functions for Chinese text processing:

  • Identify a string as Traditional or Simplified Chinese, Pinyin, or Zhuyin.
  • Convert between Chinese characters, Pinyin, Zhuyin, and the International Phonetic Alphabet.
>>> import dragonmapper.hanzi
>>> s = '我是一个美国人。'
>>> dragonmapper.hanzi.is_simplified(s)
>>> dragonmapper.hanzi.to_pinyin(s)
>>> dragonmapper.hanzi.to_pinyin(s, all_readings=True)
>>> import dragonmapper.transcriptions
>>> s = 'Wǒ shì yīgè měiguórén.'
>>> dragonmapper.transcriptions.is_pinyin(s)
>>> dragonmapper.transcriptions.pinyin_to_zhuyin(s)
'ㄨㄛˇ ㄕˋ ㄧ ㄍㄜˋ ㄇㄟˇ ㄍㄨㄛˊ ㄖㄣˊ.'
>>> dragonmapper.transcriptions.pinyin_to_ipa(s)
'wɔ˧˩˧ ʂɨ˥˩ i˥ kɤ˥˩ meɪ˧˩˧ kwɔ˧˥ ʐən˧˥.'

If this is your first time using Dragon Mapper, check out the Installation. Then, read the Tutorial.

If you want a more in-depth view of Dragon Mapper, check out the API.

If you’re looking to help out, read Contributing.


If you encounter a bug, have a feature request, or need help using Dragon Mapper, then use Dragon Mapper’s GitHub Issues page to send feedback.