1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
<!-- {{{1
File : README.md
Maintainer : Felix C. Stegerman <flx@obfusk.net>
Date : 2021-05-19
Copyright : Copyright (C) 2021 Felix C. Stegerman
Version : v0.2.3
License : AGPLv3+
}}}1 -->
[](https://github.com/obfusk/kanjidraw/releases)
[](https://pypi.python.org/pypi/kanjidraw)
[](https://pypi.python.org/pypi/kanjidraw)
[](https://github.com/obfusk/kanjidraw/actions?query=workflow%3ACI)
[](https://www.gnu.org/licenses/agpl-3.0.html)
[](https://ko-fi.com/obfusk)
## kanjidraw - handwritten kanji recognition
`kanjidraw` is a simple Python library + GUI for matching (the strokes
of a) handwritten kanji against its database.
You can use the GUI to draw and subsequently select a kanji from the
list of probable matches, which will then be copied to the clipboard.
The database is based on KanjiVG and the algorithms are based on the
[Kanji draw](https://github.com/onitake/kanjirecog) Android app.
## Demo
[Jiten Japanese Dictionary](https://jiten.obfusk.dev)
uses `kanjidraw` with a
[JavaScript frontend](https://github.com/obfusk/jiten/blob/master/jiten/static/kanjidraw.js).
## Requirements
* Python >= 3.5 (w/ Tk support for the GUI).
### Debian/Ubuntu
```bash
$ apt install python3-tk
```
## Installing
### Using pip
```bash
$ pip install kanjidraw
```
NB: depending on your system you may need to use e.g. `pip3 --user`
instead of just `pip`.
### From git
NB: this installs the latest development version, not the latest
release.
```bash
$ git clone https://github.com/obfusk/kanjidraw.git
$ cd kanjidraw
$ pip install -e .
```
NB: you may need to add e.g. `~/.local/bin` to your `$PATH` in order
to run `kanjidraw`.
To update to the latest development version:
```bash
$ cd kanjidraw
$ git pull --rebase
```
## Examples
### Kanji Input on Linux
#### kanjidraw-paste
Opens `kanjidraw` to select one (`--oneshot`) or multiple
(`--multiple`) kanji, and afterwards pastes the selected kanji in the
active window. Requires `xclip` and `xdotool`.
```bash
#!/bin/bash
set -e
pid="$( xdotool getactivewindow getwindowpid )"
pids() { xdotool search --classname "$1" getwindowpid %@; }
if pids urxvt | grep -q "^$pid$"; then
key=ctrl+alt+v
elif pids terminal | grep -q "^$pid$"; then
key=ctrl+shift+v
else
key=ctrl+v
fi
kanjidraw -s "$@" | tr -d '\n' | xclip -i -selection clipboard
xdotool key --delay 250 "$key"
```
#### i3 config
Keybindings for i3. Creating custom keybindings for `kanjidraw-paste
--oneshot` and/or `kanjidraw-paste --multiple` should work similarly
with other window managers and desktop environments.
```
for_window [title="Kanji Draw"] floating enable
bindsym $mod+Control+k exec --no-startup-id kanjidraw-paste --oneshot
bindsym $mod+Control+m exec --no-startup-id kanjidraw-paste --multiple
```
## Miscellaneous
### GUI Options
```bash
$ kanjidraw --help
usage: kanjidraw [-h] [-s] [-o | -m] [-d] [--version]
optional arguments:
-h, --help show this help message and exit
-s, --stdout print kanji to stdout instead of copying to clipboard
-o, --oneshot quit after one kanji
-m, --multiple queue kanji and copy/print after pressing 'c' or quitting
-d, --dark use dark theme
--version show program's version number and exit
```
Additional keybindings: `q` to quit, `<esc>` to go back.
### Enabling Dark Mode
```bash
$ export KANJIDRAW_DARK=1
```
### Disabling the Grid
```bash
$ export KANJIDRAW_NOGRID=1
```
## License
### Code
© Felix C. Stegerman
[](https://www.gnu.org/licenses/agpl-3.0.html)
### KanjiVG (stroke data)
© Ulrich Apel
[](https://github.com/KanjiVG/kanjivg/blob/master/COPYING)
<!-- vim: set tw=70 sw=2 sts=2 et fdm=marker : -->
|
