Dictionary

About

This project is a dictionary/language learner tool that will let you search for meaning/translation of words and it will save the results inside a file, making it easy to import inside a ANKI deck.

Special thanks to Free Dictionary API and OwlbotAPI for providing free APIs and then making this project possible.

Dependencies

• go

Install

Make sure that GOPATH is in your path and run the following command.

go install github.com/Oozaku/dict@latest

If you don't have the GOPATH, run go env | grep GOPATH and copy and paste the value inside double quotes to your PATH.

Before Usage

To use this program, you need to set the configuration file at ~/.config/dict/dict.json. The code snippet bellow shows an example:

{
  "anki-media-folder": "/home/oozaku/.local/share/Anki2/User 1/collection.media",
  "anki-csv-location": "/home/oozaku/Documents/anki/anki.csv",
  "dictionaries": ["owlbot", "dictionaryapi"],
  "owlbot": {
    "token": "<your token here>"
  }
}

The field anki-media-folder is where Anki saves all medias used in your decks and anki-csv-location is the file location that you will use later to import to Anki.

The Anki's media folder is a little trick to find, you have to find where collection.media is located. On Linux, it probably is at ~/.local/share/Anki2/<your_profile>/collection.media.

dictionaries specifies which dictionaries you want to use and the sequence given defines which dictionaries to look up first until find a result.

token inside owlbot holds the API token to Owlbot API and you can get here.

Usage

Run dict at your terminal and then you can search for expressions in the configured API. Anki's import file and all audios are saved automatically inside the configured locations.

To import the searched words into Anki, open Anki and go to File > Import..., select your import file and set the first field as front and the second field as back.

One important note is that when Anki finds two entries with same name, it overwrites the old one with the new one. So it's important that you import inside a new deck to avoid overwritting you existing cards.

TO DO

• Features
  • Integrate an API
  • Save textual results in a supported format to Anki
  • Download audios
  • Save audio results inside file to be imported in Anki
  • Define configuration file
  • Create interface to abstract each API client
  • Lookup in each API until find answer
  • Improve cli/tui
  • Lookup firstly at memory, if not found, search in API
• Documentation:
  • Improve README.md:
    • Add instructions on how to build/install
    • Add documentation about how it works
  • Code:
    • Add comments