gryzus24 / anki-dodawacz

Console/curses English dictionary look-up tool with Anki integration

Ankidodawacz

•

A curses dictionary look-up tool with Anki integration.

Installation

Windows

1. install Python from the official website
   during installation tick the "Add Python to PATH" box
2. download and extract the zip archive
3. open the terminal (Win+R "cmd" or type "cmd" into the file manager's path box)
4. cd into the extracted directory (e.g. cd Downloads\anki-dodawacz-main)
5. install the required dependencies: pip install --no-deps -r requirements.txt windows-curses
6. run the program: python ankidodawacz.py
   if you are lucky it might even run without the python prefix!

You can also create a shortcut and run the program this way, however in case of an unexpected error the program will crash immediately.

Linux

Most GNU/Linux distributions come with Python preinstalled.

1. cd into the directory you want the source code downloaded into
2. download and extract the tar.gz archive, then download the dependencies and install the program into the /usr/local/bin directory:

curl -sL https://github.com/gryzus24/anki-dodawacz/archive/refs/heads/main.tar.gz | tar xfz -
cd anki-dodawacz-main
pip install --no-deps -r requirements.txt -t lib
sudo make install

Configuration

All the configuration and history files are saved into ~/.local/share/ankidodawacz on Linux and equivalent %USER%\Appdata\Local\Ankidodawacz on Windows.

The program has a quick Anki configuration wizard and a built-in configuration menu. No need to edit config files by hand.

Optional features

• mpv – for playing pronunciations (press a)
• xsel or xclip – for pasting the contents of the primary selection (Linux only).
  On Windows, pasting the contents of the clipboard should work out of the box

Anki notes

The program will try to guess where to put certain elements based on the names of the fields in your note.
Names it definitely understands are:

• Definition
• Synonyms
• Sentence
• Phrase
• Examples (usage)
• Parts of speech (pos)
• Etymology
• Audio

Custom note

The Anki configuration wizard adds a custom note that can serve as a base for your own customization.

The note in a copy-pastable form: https://pastebin.com/9ZfWMpNu

---

This is my first programming project, suggestions and contributions are welcome!

anki-dodawacz's Issues

W jaki sposób uzupełnić pola "Sentence" i "Synonyms" (na karcie gryzus-std) z poziomu anki-dodawacza ?

W poprzedniej wersji aplikacji była możliwość włączenia/wyłącznia synonimów i pojawiało się pytanie o przykładowe zdanie - w nowej wersji nie bardzo wiem jak zrobić użytek z tych dwóch pól.

Tak poza tym, to świetna robota! :)

[curses] garbled output in less on Windows

Commands that redirect their output to less do not display properly on any terminal on Windows.

Less barely manages to work in a clean terminal session on Windows, making it inherit the program's curses environment just asks for something to break. This is yet another reason to consider implementing a simpler pager that supports only scrolling and searching.

[curses] Tab completion in the search prompt

After using readline's tab completion in the normal Search prompt it's annoying to have to type the whole thing when using the curses prompt.

It would be cool to have this feature especially as in the future the whole program might be in curses. Then, tab completion would be cross-platform (assuming better curses experience on Windows in general)

[curses] less cannot determine the size of the window after resizing

Reproduction

• make the window small
• enter curses
• make the window bigger
• type "--help" or any other command that produces output big enough to redirect it to less

Cause
This is caused by readline which is imported in a completer.py file while running the program on Linux.
Less is being run in a subprocess which inherits all the environment variables like "COLS" and "LINES" which are set to None because of readline and that's probably why it has a problem with resizing.

I tried running less in a new shell instead of a subprocess, but then it has some problems with interpreting ANSI color characters. Explicitly setting these environment variables does not help and incurs other problems.

Python's readline API does not expose certain variables and functions responsible for readline's rampant behavior and makes it hard to reconcile many conflicting features in a curses context.

Possible solution
Write a simpler pager (only scrolling and searching) and not rely on less at all.

Pole karty "Parts of speach" się nie uzupełnia

Pomimo, że w wyniku wyszukiwania jest informacja, że to "noun"

Czy można wybrać pozycję spoza zakresu 1-20 wyniku?

Wcześnie można było ograniczyć liczbę pozycji w wyniku wybierając np. rzeczownik, ale w nowej wersji aplikacji chyba nie ma takiej możliwości :(. Nie łatwiej było by pozwolić przescrollować się po wszystkicg pozycjach i np. spacją wybrać te które nas interesują ?

Wyszukiwanie w słowniku Collins nie działa

Operacje wyszukiwania kończą się komunikatem np.: Collins 'car' not found

[curses] more advanced line editing in prompt

With the possibility of pasting selection/clipboard and the contents of the Phrase field more advanced editing features might sometimes come in handy like:

• Ctrl-Backspace to delete the whole word
• [Ctrl-T or ???] to delete everything except the word under the cursor

Wyniki wyszukiwania z wykorzystanie słownika WordNet nie są indeksowane

Wprawdzie można wybrać za pomocą cyfry interesujący nas wynik, ale same cyfry się nie pojawiają tak jak to było we wcześniejszej wersji.