Metadata-Version: 2.4
Name: mkd-tools
Version: 0.10.0
Summary: Read, search, and create Monokakido dictionaries
License-Expression: GPL-3.0-only
License-File: LICENSE
License-File: python/THIRD_PARTY_NOTICES.txt
License-File: src/platform/macos/bindings/LICENSE-APACHE-2.0.txt
License-File: third_party/glaze/LICENSE
License-File: third_party/pugixml/LICENSE.md
License-File: third_party/stb/LICENSE
License-File: third_party/utf8proc/LICENSE.md
License-File: third_party/zlib/LICENSE
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: C++
Classifier: Typing :: Typed
Project-URL: Documentation, https://kiwakiwaa.github.io/mkd-tools/
Project-URL: Source, https://github.com/kiwakiwaa/mkd-tools
Project-URL: Issues, https://github.com/kiwakiwaa/mkd-tools/issues
Requires-Python: >=3.10
Description-Content-Type: text/markdown

# mkd-tools

A C++23 library for reading, searching and creating 物書堂 dictionaries, with Python bindings and a CLI.

[Library documentation](https://kiwakiwaa.github.io/mkd-tools/) · C++ and Python guides

## Installation

Python library:

```sh
python -m pip install mkd-tools
```

Import the library as `mkd`.

CLI on macOS, with [Homebrew](https://brew.sh/):

```sh
brew install kiwakiwaa/tap/mkd-tools
```

## Acknowledgements

Dictionary-format research used [Hopper](https://www.hopperapp.com/) and [Frida](https://frida.re/).
Python bindings use [nanobind](https://github.com/wjakob/nanobind).
Some macOS bindings are adapted from Apple's
[metal-cpp](https://developer.apple.com/metal/cpp/).

## Notice

An independent project based on reverse engineering, not affiliated with
Monokakido. Use it only with dictionaries and content you are authorised to use.
