https://github.com/moritree/jisho-nomikomi
A command line tool for generating Anki cards with information scraped from jisho (an online Japanese dictionary).
https://github.com/moritree/jisho-nomikomi
anki cli japanese
Last synced: 4 months ago
JSON representation
A command line tool for generating Anki cards with information scraped from jisho (an online Japanese dictionary).
- Host: GitHub
- URL: https://github.com/moritree/jisho-nomikomi
- Owner: moritree
- Created: 2024-06-05T06:33:06.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-16T00:56:00.000Z (almost 2 years ago)
- Last Synced: 2025-12-04T05:20:47.787Z (7 months ago)
- Topics: anki, cli, japanese
- Language: Python
- Homepage:
- Size: 144 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# jisho-nomikomi 👹 辞書・飲み込み
A command line tool for generating [Anki](https://apps.ankiweb.net/) cards
with information from [jisho.org](https://jisho.org/) (an online Japanese dictionary).
> **辞書・飲み込み → jisho nomikomi → dictionary swallowing**
>
> I wanted a cute name that's fun to say in my head.
> I like to imagine this program greedily scraping up data like a dubious little creature,
> and crunch-crunching it into a tidy little format.
# Usage ⚙️ 使い方
## Installation
To use the CLI, you can make a new virtualenv and then install the package. From a terminal within the project folder:
```
python -m venv .venv
. .venv/bin/activate
pip install --editable .
```
## Commands
You can run any command with the option `--help` for documentation.
### generation
- `token [OPTIONS] [TEXT]...` – identify the tokens in a Japanese text, and cache information for those you select.
- `word [OPTIONS] [WORDS]...` – generate and cache information for each of the given words
### library
- `library export [OPTIONS]` – export the cached library to a csv file,
according to the format described in the config file
- `library delete [WORDS]...` – delete specified words from the library
- `library example [OPTIONS] [WORDS]...` – generate examples for specified words; can select from a list of options
- `library view` – view the current cached library of generated cards
### config
- `config header` – configuring fields to be written in the
[Anki header file](https://docs.ankiweb.net/importing/text-files.html#file-headers) on export. \
All fields have the flag option `-rm` to remove the field from the header entirely, instead of updating values.
- `config header columns [OPTIONS] [ORDER_FORMAT]...` – what each exported .csv column corresponds to
- The option `-v` displays a list of all valid column field types.
- Will regenerate library cache data with updated fields.
- `config header deck [TITLE]` – presets the deck to import into, if it exists
- `config header tags [ALL_TAGS]...` – list of tags, separated by spaces, to be applied to every card on import
- `config senses` – configure the (maximum) number of senses of a word to include in a card
- `config view` – view the current config settings.