jiten 0.2.0

File        : README.md
Maintainer  : Felix C. Stegerman <flx@obfusk.net>
Date        : 2020-07-20

Copyright   : Copyright (C) 2020  Felix C. Stegerman
Version     : v0.2.0
License     : AGPLv3+

Description

jiten - japanese cli&web dictionary based on jmdict/kanjidic

→ https://jiten.obfusk.dev

Features

• Fine-grained search using regexes (regular expressions)
• JMDict multilingual japanese dictionary
  • kanji, readings, meanings (eng, dut, ger) & more
  • by frequency
  • random entry
• Kanji dictionary
  • readings, meanings (eng) & more
  • search using SKIP codes
  • by frequency/level
• Stroke order
• Web interface
  • can be run on your own computer or android phone
  • light/dark mode
• Command-line interface

CLI

JMDict

$ jiten -v jmdict --max 1 --word cat
$ jiten -v jmdict --max 1 --word kat --lang dut
$ jiten -v jmdict --max 1 --exact 誤魔化す

Kanji

$ jiten -v kanji --max 1 --word cat
$ jiten -v kanji --max 1 --exact cat
$ jiten -v kanji --max 1 --word 日

Web Interface

$ jiten -v serve

Help

$ jiten --help

Requirements

Python >= 3.5 + Flask + click.

To build the (not yet optional) SQLite PCRE C extension: a C compiler (e.g. gcc/clang) and the sqlite3 & pcre libraries & headers.

Debian/Ubuntu

$ apt install python3-dev build-essential libsqlite3-dev libpcre3-dev
$ apt install python3-flask   # optional: Flask & click w/o pip

Installing

Using pip

$ pip install jiten

From git

NB: this installs the latest development version, not the latest release.

$ git clone https://github.com/obfusk/jiten.git
$ cd jiten
$ pip install -e .

NB: you may need to add e.g. ~/.local/bin to your $PATH in order to run jiten.

Android

There's no app (yet?), but you can run the web interface locally (& off-line) on your android phone. First, install termux, then run:

$ apt install clang python
$ pip install jiten

You can then run the web interface with:

$ jiten serve

and open http://localhost:5000 in your browser.

The web interface will keep running until you close termux or reboot.

Miscellaneous

Generating the DB

$ jiten setup

Forcing HTTPS

$ export JITEN_HTTPS=force

Forcing Domain Name

$ export JITEN_DOMAIN=jiten.obfusk.dev

License

Code

© Felix C. Stegerman

JMDict & KanjiDic

© James William BREEN and The Electronic Dictionary Research and Development Group