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()

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: 
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.18.3.tar.gz (29.9 kB view details)

Uploaded Source

Built Distribution

cihai-0.18.3-py3-none-any.whl (21.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for cihai-0.18.3.tar.gz
Algorithm Hash digest
SHA256 162ac943102f1008dc960e36c39d92ab8291a3b02f2027f61d7a7d86aebeece4
MD5 5b0747fed37825ad1be255d162d4db62
BLAKE2b-256 10ef3f28765e1f75db08b2d9681325b9457ccf0eb32b6baf3bffeb541a43d500

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for cihai-0.18.3-py3-none-any.whl
Algorithm Hash digest
SHA256 93cfcc57c2de12c56338604bff90d41008f26d2828f5cef5ee9899376d280d0f
MD5 573f2fa08c62a461ced8c70cbdc994d8
BLAKE2b-256 d8504b91aa8b4a4a4fe07bbbcf40c80326bba86a73074d899d302ddc33b2320a

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