Python library for CJK (Chinese, Japanese, and Korean) language data
Clone or download

README.rst

cihai - Python library for CJK (chinese, japanese, korean) data

Python Package Documentation Status Build Status Code Coverage License

This project is under active development. Follow our progress and check back for updates!

Usage

API / Library (this repository)

$ pip install --user cihai
from cihai.core import Cihai

c = Cihai()

if not c.unihan.is_bootstrapped:  # download and install Unihan to db
    c.unihan.bootstrap(unihan_options)

query = c.unihan.lookup_char('')
glyph = query.first()
print("lookup for 好: %s" % glyph.kDefinition)
# lookup for 好: good, excellent, fine; well

query = c.unihan.reverse_char('good')
print('matches for "good": %s ' % ', '.join([glph.char for glph in query]))
# matches for "good": 㑘, 㑤, 㓛, 㘬, 㙉, 㚃, 㚒, 㚥, 㛦, 㜴, 㜺, 㝖, 㤛, 㦝, ...

See API documentation and /examples.

CLI (cihai-cli)

# stable
$ pip install --user cihai-cli

# pre-release
$ pip install --user --pre cihai[cli]
# character lookup
$ cihai info 好
char: 好
kCantonese: hou2 hou3
kDefinition: good, excellent, fine; well
kHangul: 호
kJapaneseOn: KOU
kKorean: HO
kMandarin: hǎo
kTang: '*xɑ̀u *xɑ̌u'
kTotalStrokes: '6'
kVietnamese: háo
ucn: U+597D

# reverse lookup
$ cihai reverse library
char: 圕
kCangjie: WLGA
kCantonese: syu1
kCihaiT: '308.302'
kDefinition: library
kMandarin: tú
kTotalStrokes: '13'
ucn: U+5715
--------

UNIHAN data

All datasets that cihai uses have stand-alone tools to export their data. No library required.

Quick links

Python support Python 2.7, >= 3.5, pypy
Source https://github.com/cihai/cihai
Docs https://cihai.git-pull.com
Changelog https://cihai.git-pull.com/en/latest/history.html
API https://cihai.git-pull.com/en/latest/api.html
Issues https://github.com/cihai/cihai/issues
Travis https://travis-ci.org/cihai/cihai
Test coverage https://codecov.io/gh/cihai/cihai
pypi https://pypi.python.org/pypi/cihai
OpenHub https://www.openhub.net/p/cihai
License MIT
git repo
$ git clone https://github.com/cihai/cihai.git
install stable
$ pip install cihai
install dev
$ git clone https://github.com/cihai/cihai.git cihai
$ cd ./cihai
$ virtualenv .env
$ source .env/bin/activate
$ pip install -e .
tests
$ python setup.py test