Metadata-Version: 2.1
Name: jiten
Version: 0.3.0
Summary: japanese cli&web dictionary based on jmdict/kanjidic
Home-page: https://github.com/obfusk/jiten
Author: Felix C. Stegerman
Author-email: flx@obfusk.net
License: AGPLv3+
Description: <!-- {{{1 -->
        
            File        : README.md
            Maintainer  : Felix C. Stegerman <flx@obfusk.net>
            Date        : 2020-08-12
        
            Copyright   : Copyright (C) 2020  Felix C. Stegerman
            Version     : v0.3.0
            License     : AGPLv3+
        
        <!-- }}}1 -->
        
        [![GitHub Release](https://img.shields.io/github/release/obfusk/jiten.svg?logo=github)](https://github.com/obfusk/jiten/releases)
        [![PyPI Version](https://img.shields.io/pypi/v/jiten.svg)](https://pypi.python.org/pypi/jiten)
        [![Python Versions](https://img.shields.io/pypi/pyversions/jiten.svg)](https://pypi.python.org/pypi/jiten)
        [![CI](https://github.com/obfusk/jiten/workflows/CI/badge.svg)](https://github.com/obfusk/jiten/actions?query=workflow%3ACI)
        [![Android Build](https://github.com/obfusk/jiten/workflows/Android/badge.svg)](https://github.com/obfusk/jiten/actions?query=workflow%3AAndroid)
        [![AGPLv3+](https://img.shields.io/badge/license-AGPLv3+-blue.svg)](https://www.gnu.org/licenses/agpl-3.0.html)
        [![Sponsor](https://img.shields.io/badge/%E2%99%A5-support-violet.svg)](https://ko-fi.com/obfusk)
        
        <!--
        [![F-Droid Version](https://img.shields.io/f-droid/v/dev.obfusk.jiten.svg)](https://f-droid.org/app/dev.obfusk.jiten)
        -->
        
        ## Description
        
        jiten - japanese cli&web dictionary based on jmdict/kanjidic
        
        → https://jiten.obfusk.dev
        
        [<img src="badges/google-play.png" alt="Get it on Google Play" height="60">](https://play.google.com/store/apps/details?id=dev.obfusk.jiten)
        <!--
        [<img src="badges/fdroid.png" alt="Get it on F-Droid" height="60">](https://f-droid.org/app/dev.obfusk.jiten)
        -->
        
        ![CLI screenshot](screenshot-cli.png)
        
        ![app screenshot](screenshot-app.png)
        
        ## Features
        
        * Fine-grained search using
          [regexes](https://docs.python.org/3/library/re.html#regular-expression-syntax)
          (regular expressions)
        * JMDict multilingual japanese dictionary
          - kanji, readings, meanings (english, dutch, german) & more
          - pitch accent (from Wadoku)
          - by frequency
          - random entry
        * Kanji dictionary
          - readings, meanings (english), jmdict entries, radicals & more
          - search using
            [SKIP codes](https://en.wikipedia.org/wiki/Kodansha_Kanji_Learner%27s_Dictionary#SKIP)
          - search by radical
          - by frequency/level
        * Example sentences (from Tatoeba)
          - with english, dutch and/or german translation
          - some with audio
        * Stroke order
        * Web interface
          - can be run on your own computer or android phone
          - light/dark mode
        * Command-line interface
        
        ## CLI
        
        ### JMDict
        
        ```bash
        $ jiten -v jmdict --max 1 --word cat
        $ jiten -v jmdict --max 1 --word kat --lang dut
        $ jiten -v jmdict --max 1 --exact 誤魔化す
        $ jiten -v jmdict +random   # random entry
        ```
        
        ### Kanji
        
        ```bash
        $ jiten -v kanji --max 1 --word cat
        $ jiten -v kanji --max 1 --exact cat
        $ jiten -v kanji --max 1 --word 日
        ```
        
        ## Web Interface
        
        ```bash
        $ jiten -v serve
        ```
        
        ## Help
        
        ```bash
        $ 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
        
        ```bash
        $ apt install python3-dev build-essential libsqlite3-dev libpcre3-dev
        $ apt install python3-flask   # optional: Flask & click w/o pip
        ```
        
        ## Installing
        
        ### Using pip
        
        ```bash
        $ pip install jiten
        ```
        
        ### From git
        
        NB: this installs the latest development version, not the latest
        release.
        
        ```bash
        $ 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`.
        
        ## Miscellaneous
        
        ### Web Interface on Android
        
        You can also run the web interface locally (& offline) on your android
        phone.  First, install [termux](https://termux.com/), then run:
        
        ```bash
        $ apt install clang python
        $ pip install jiten
        ```
        
        You can then run the web interface with:
        
        ```bash
        $ jiten serve
        ```
        
        and open http://localhost:5000 in your browser.
        
        The web interface will keep running until you close termux or reboot.
        
        ### Generating the DB
        
        ```bash
        $ jiten setup
        ```
        
        ### Forcing HTTPS
        
        ```bash
        $ export JITEN_HTTPS=force
        ```
        
        ### Forcing Domain Name
        
        ```bash
        $ export JITEN_DOMAIN=jiten.obfusk.dev
        ```
        
        ## License
        
        ### Code
        
        © Felix C. Stegerman
        
        [![AGPLv3+](https://www.gnu.org/graphics/agplv3-155x51.png)](https://www.gnu.org/licenses/agpl-3.0.html)
        
        ### JMDict & KanjiDic
        
        © James William BREEN and The Electronic Dictionary Research and
        Development Group
        
        [![CC-BY-SA](https://licensebuttons.net/l/by-sa/2.0/88x31.png)](https://www.edrdg.org/edrdg/licence.html)
        
        ### Wadoku (pitch)
        
        © Ulrich Apel & Wadoku.de contributors
        
        [Non-commercial](https://www.wadoku.de/wiki/display/WAD/Wadoku.de-Daten+Lizenz)
        
        ### Tatoeba (sentences & audio)
        
        © Tatoeba contributors
        
        [![CC-BY](https://licensebuttons.net/l/by/2.0/88x31.png)](https://tatoeba.org/eng/downloads)
        
        Audio by huizi99, Mizu & yomi (CC BY-NC 4.0).
        
        ### KanjiVG (radicals)
        
        © Ulrich Apel
        
        [![CC-BY-SA](https://licensebuttons.net/l/by-sa/3.0/88x31.png)](https://github.com/KanjiVG/kanjivg/blob/master/COPYING)
        
        ### Stroke Order Font
        
        © Ulrich Apel, the AAAA project and the Wadoku project
        
        [BSD-3-Clause](https://www.nihilist.org.uk)
        
        ### Kana Tables
        
        © Wikipedia contributors
        
        [![CC-BY-SA](https://licensebuttons.net/l/by-sa/3.0/88x31.png)](https://en.wikipedia.org/wiki/File:Table_hiragana.svg)
        [![CC-BY-SA](https://licensebuttons.net/l/by-sa/3.0/88x31.png)](https://en.wikipedia.org/wiki/File:Table_katakana.svg)
        
        <!-- vim: set tw=70 sw=2 sts=2 et fdm=marker : -->
        
Keywords: japanese kanji dictionary cli web jmdict kanjidic
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Natural Language :: Dutch
Classifier: Natural Language :: English
Classifier: Natural Language :: German
Classifier: Natural Language :: Japanese
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Education
Classifier: Topic :: Utilities
Requires-Python: >=3.5
Description-Content-Type: text/markdown
