Metadata-Version: 2.5
Name: gukhanmun-loanwords-cdb
Version: 0.4.0.dev331
Summary: NIKL loanword spelling examples CDB data for the gukhanmun Python package
Project-URL: Homepage, https://gukhanmun.org/
Project-URL: Repository, https://github.com/dahlia/gukhanmun
Project-URL: Issues, https://github.com/dahlia/gukhanmun/issues
Author-email: Hong Minhee <hong@minhee.org>
License-Expression: GPL-3.0-or-later AND LicenseRef-NIKL-Free-Use
License-File: ATTRIBUTION.md
License-File: LICENSE
Keywords: cdb,dictionary,hangul,hanja,korean
Classifier: Natural Language :: Korean
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Text Processing :: Linguistic
Requires-Python: >=3.11
Description-Content-Type: text/markdown

gukhanmun-loanwords-cdb
=======================

This distribution contains NIKL loanword spelling examples compiled into
Gukhanmun CDB dictionary binaries (*loanwords.cdb*) for the [gukhanmun] Python
package. It has no API of its own and does not depend on `gukhanmun`.

[gukhanmun]: https://github.com/dahlia/gukhanmun


Installation
------------

Install it through the matching extra of the core package:

~~~~ sh
pip install 'gukhanmun[loanwords-cdb]'
~~~~


Usage
-----

Installing the data does not change any converter. Add it explicitly:

~~~~ python
from gukhanmun import Converter, DictionaryFormat
from gukhanmun.dictionaries import loanwords

converter = Converter(dictionaries=[
    loanwords(format=DictionaryFormat.CDB),
])
~~~~

To read a resource directly, use `importlib.resources`:

~~~~ python
from importlib.resources import files

data = (files("gukhanmun_loanwords_cdb") / "loanwords.cdb").read_bytes()
~~~~


License
-------

`GPL-3.0-or-later AND LicenseRef-NIKL-Free-Use`. See *LICENSE* and
*ATTRIBUTION.md* for the code license and the data attribution.
*provenance.json* records the source snapshot and the hashes of the bundled
files.
