Skip to main content

Library for CJK (chinese, japanese, korean) language data.

Project description

cihai · Python Package License Code Coverage

Python library for CJK (chinese, japanese, korean) data.

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

Quickstart

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)

$ pip install --user '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.

Developing

$ git clone https://github.com/cihai/cihai.git`
$ cd cihai/

Bootstrap your environment and learn more about contributing. We use the same conventions / tools across all cihai projects: pytest, sphinx, flake8, mypy, black, isort, tmuxp, and file watcher helpers (e.g. entr(1)).

Quick links

Docs Build Status

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

cihai-0.14.0.tar.gz (29.1 kB view details)

Uploaded Source

Built Distribution

cihai-0.14.0-py3-none-any.whl (20.8 kB view details)

Uploaded Python 3

File details

Details for the file cihai-0.14.0.tar.gz.

File metadata

  • Download URL: cihai-0.14.0.tar.gz
  • Upload date:
  • Size: 29.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for cihai-0.14.0.tar.gz
Algorithm Hash digest
SHA256 a74e38e041bc907960370d1f36c119b1c7a90f9fc7d1b7aace16540d1bdd11dd
MD5 1677e7f3ada326eb35647035dbf494bb
BLAKE2b-256 a4854cb57b4e1155be5adf79c867699cc960e2d7b6edf3e99dad14a982b7dc85

See more details on using hashes here.

Provenance

File details

Details for the file cihai-0.14.0-py3-none-any.whl.

File metadata

  • Download URL: cihai-0.14.0-py3-none-any.whl
  • Upload date:
  • Size: 20.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for cihai-0.14.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c5c8b767142a72f22bd2727d0bd6050dae2c7dd8c9ac425fedd674d7f1c00cca
MD5 c81781dadd6b5b925791c2d0fffe00bf
BLAKE2b-256 5bd36160b6f61e576c29db24e3b69e78e20dcf4dd1601249b0d5c8acebd5d35e

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page