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.13.0.tar.gz (30.2 kB view details)

Uploaded Source

Built Distribution

cihai-0.13.0-py3-none-any.whl (22.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for cihai-0.13.0.tar.gz
Algorithm Hash digest
SHA256 7bc79fadf2eb32e9a6f9dbb851b3a25f17fb82e60d0e188adfffd2dcf14e42ec
MD5 e6cca850ec9cf428893eb3cbcd8aa737
BLAKE2b-256 b48b3b0bc92ed8d4df86c6498dd92188500c45c17987c142001dddaa26d5b2e0

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: cihai-0.13.0-py3-none-any.whl
  • Upload date:
  • Size: 22.2 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.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 27146d653d6411a825d32acebdc6b324023b26aeb7dc12485dee8536609c3ba2
MD5 3950fbec867a5b13731193f3cfc6a994
BLAKE2b-256 5c569627aa642f9310dcf9cc124d14f0e756395b40de601342effd2989bd59b7

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