wordflow-cli 0.1.4__tar.gz → 0.1.6__tar.gz

{wordflow_cli-0.1.4 → wordflow_cli-0.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wordflow-cli
-Version: 0.1.4
+Version: 0.1.6
 Summary: Automate Anki flashcard creation and text translation directly from your clipboard.
 Author-email: Mathéo Tritschler <tritschler.matheo@gmail.com>
 License: MIT
@@ -19,15 +19,6 @@ Requires-Dist: requests>=2.28.0
 Requires-Dist: tomli-w>=1.0.0
 Dynamic: license-file
 
-$$\      $$\                           $$\       $$$$$$$$\ $$\                         
-$$ | $\  $$ |                          $$ |      $$  _____|$$ |                        
-$$ |$$$\ $$ | $$$$$$\   $$$$$$\   $$$$$$$ |      $$ |      $$ | $$$$$$\  $$\  $$\  $$\ 
-$$ $$ $$\$$ |$$  __$$\ $$  __$$\ $$  __$$ |      $$$$$\    $$ |$$  __$$\ $$ | $$ | $$ |
-$$$$  _$$$$ |$$ /  $$ |$$ |  \__|$$ /  $$ |      $$  __|   $$ |$$ /  $$ |$$ | $$ | $$ |
-$$$  / \$$$ |$$ |  $$ |$$ |      $$ |  $$ |      $$ |      $$ |$$ |  $$ |$$ | $$ | $$ |
-$$  /   \$$ |\$$$$$$  |$$ |      \$$$$$$$ |      $$ |      $$ |\$$$$$$  |\$$$$$\$$$$  |
-\__/     \__| \______/ \__|       \_______|      \__|      \__| \______/  \_____\____/ 
-
 # Wordflow
 
 A lightning-fast, dependency-free, keyboard-driven language acquisition tool for Linux.
@@ -163,12 +154,16 @@ Wordflow automatically routes audio to native speakers of the detected language.
 ## Instant Translation (-t)
 
   Highlight any text on your screen and trigger the wordflow --translate command. Wordflow detects the language, translates it, and sends a desktop notification. Clicking the notification copies the translation to your clipboard.
+
 ## Cloze Card Creation (-c)
 
   To create a flashcard, highlight the target word/sentence and trigger wordflow --cloze. Wordflow will parse all dictionary data, build the card according to your TOML layout, and push it directly to Anki.
 
 Use wordflow --help to list all command-line arguments.
 
+## Undo Last Card (-u / --undo)
+
+If you accidentally create a card with a typo or the wrong highlighted text, simply trigger the `wordflow --undo` command. Wordflow remembers the ID of the last flashcard it generated and will instantly delete it from your Anki database.
 # ⌨️ Creating Shortcuts
 
 Wordflow is designed to be bound to your window manager's shortcuts, allowing you to seamlessly translate and capture vocabulary without losing focus on your current task.
@@ -186,6 +181,11 @@ Wordflow is designed to be bound to your window manager's shortcuts, allowing yo
         hl.dispatch(hl.dsp.submap("reset"))
         hl.dispatch(hl.dsp.exec_cmd("wordflow -c"))
       end)
+      --u : Undo last card
+      hl.bind("U", function()
+        hl.dispatch(hl.dsp.submap("reset"))
+        hl.dispatch(hl.dsp.exec_cmd("wordflow -u"))
+      end)
 
       hl.bind("catchall", hl.dsp.submap("reset"))
     end)
@@ -193,3 +193,4 @@ Wordflow is designed to be bound to your window manager's shortcuts, allowing yo
 ## Sway / i3 Example
     bindsym Mod4+t exec "wordflow -t"
     bindsym Mod4+c exec "wordflow -c"
+    bindsym Mod4+u exec "wordflow -u"

{wordflow_cli-0.1.4 → wordflow_cli-0.1.6}/README.md

@@ -1,12 +1,3 @@
-$$\      $$\                           $$\       $$$$$$$$\ $$\                         
-$$ | $\  $$ |                          $$ |      $$  _____|$$ |                        
-$$ |$$$\ $$ | $$$$$$\   $$$$$$\   $$$$$$$ |      $$ |      $$ | $$$$$$\  $$\  $$\  $$\ 
-$$ $$ $$\$$ |$$  __$$\ $$  __$$\ $$  __$$ |      $$$$$\    $$ |$$  __$$\ $$ | $$ | $$ |
-$$$$  _$$$$ |$$ /  $$ |$$ |  \__|$$ /  $$ |      $$  __|   $$ |$$ /  $$ |$$ | $$ | $$ |
-$$$  / \$$$ |$$ |  $$ |$$ |      $$ |  $$ |      $$ |      $$ |$$ |  $$ |$$ | $$ | $$ |
-$$  /   \$$ |\$$$$$$  |$$ |      \$$$$$$$ |      $$ |      $$ |\$$$$$$  |\$$$$$\$$$$  |
-\__/     \__| \______/ \__|       \_______|      \__|      \__| \______/  \_____\____/ 
-
 # Wordflow
 
 A lightning-fast, dependency-free, keyboard-driven language acquisition tool for Linux.
@@ -142,12 +133,16 @@ Wordflow automatically routes audio to native speakers of the detected language.
 ## Instant Translation (-t)
 
   Highlight any text on your screen and trigger the wordflow --translate command. Wordflow detects the language, translates it, and sends a desktop notification. Clicking the notification copies the translation to your clipboard.
+
 ## Cloze Card Creation (-c)
 
   To create a flashcard, highlight the target word/sentence and trigger wordflow --cloze. Wordflow will parse all dictionary data, build the card according to your TOML layout, and push it directly to Anki.
 
 Use wordflow --help to list all command-line arguments.
 
+## Undo Last Card (-u / --undo)
+
+If you accidentally create a card with a typo or the wrong highlighted text, simply trigger the `wordflow --undo` command. Wordflow remembers the ID of the last flashcard it generated and will instantly delete it from your Anki database.
 # ⌨️ Creating Shortcuts
 
 Wordflow is designed to be bound to your window manager's shortcuts, allowing you to seamlessly translate and capture vocabulary without losing focus on your current task.
@@ -165,6 +160,11 @@ Wordflow is designed to be bound to your window manager's shortcuts, allowing yo
         hl.dispatch(hl.dsp.submap("reset"))
         hl.dispatch(hl.dsp.exec_cmd("wordflow -c"))
       end)
+      --u : Undo last card
+      hl.bind("U", function()
+        hl.dispatch(hl.dsp.submap("reset"))
+        hl.dispatch(hl.dsp.exec_cmd("wordflow -u"))
+      end)
 
       hl.bind("catchall", hl.dsp.submap("reset"))
     end)
@@ -172,3 +172,4 @@ Wordflow is designed to be bound to your window manager's shortcuts, allowing yo
 ## Sway / i3 Example
     bindsym Mod4+t exec "wordflow -t"
     bindsym Mod4+c exec "wordflow -c"
+    bindsym Mod4+u exec "wordflow -u"

{wordflow_cli-0.1.4 → wordflow_cli-0.1.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "wordflow-cli"
-version = "0.1.4"
+version = "0.1.6"
 description = "Automate Anki flashcard creation and text translation directly from your clipboard."
 readme = "README.md"
 requires-python = ">=3.11"

{wordflow_cli-0.1.4 → wordflow_cli-0.1.6}/src/wordflow/anki_flashcard.py

@@ -111,9 +111,10 @@ def setup_anki_model(url: str, model_name: str, fields: dict):
 
 def make_cloze(
     anki_config: AnkiConfig, sentence_data: TranslationData, word_data: TranslationData
-):
+) -> str:
     """
     makes a cloze flashcard and sends it to anki through AnkiConnect
+    returns the id of the created card
     """
     # before doing anything, checks that the word is in the sentence
     if word_data.source_data.lower() not in sentence_data.source_data.lower():
@@ -142,14 +143,14 @@ def make_cloze(
     }
 
     try:
-        invoke(anki_config.url, "addNote", note=note)
+        note_id = invoke(anki_config.url, "addNote", note=note)
     except AnkiConnectError as e:
         if "duplicate" in str(e).lower():
             raise DuplicateNoteError(
                 f"A note for '{word_data.source_data}' already exists."
             )
-        raise e
-    return True
+        raise AnkiConnectError(e)
+    return note_id
 
 
 def add_audio_to_anki(url: str, text: str, lang_code: str, accent: str):
@@ -281,3 +282,8 @@ def process_fields(
 
     print("fields sent to anki: ", formatted_anki_fields)
     return formatted_anki_fields
+
+
+def delete_note(anki_url: str, note_id: int):
+    invoke(anki_url, "deleteNotes", notes=[note_id])
+    return True

{wordflow_cli-0.1.4 → wordflow_cli-0.1.6}/src/wordflow/cli.py

@@ -4,7 +4,7 @@ import traceback
 
 # local modules
 from .configuration import create_config, load_config, print_config
-from .workflows import translate_workflow, cloze_workflow
+from .workflows import translate_workflow, cloze_workflow, undo_workflow
 from .wizard import launch_wizard
 from .my_classes import GlobalConfig, AnkiConfig
 from .notifications import notify
@@ -36,6 +36,9 @@ def get_parser():
         action="store_true",
         help="Launch the interactive configuration wizard.",
     )
+    group.add_argument(
+        "-u", "--undo", action="store_true", help="cancel last created card"
+    )
 
     group.add_argument(
         "--print_config",
@@ -77,8 +80,8 @@ def main():
 
     args = parser.parse_args()
 
+    # handle correct operation
     try:
-        # 2. Handle config and wizard
         if args.wizard:
             config = launch_wizard()
             create_config(config)
@@ -87,17 +90,23 @@ def main():
             print_config()
             sys.exit(0)
 
-        # 3. loads configuration
+        # loads configuration
         global_config, raw_anki_data = load_config(
             args.source_language, args.target_language, args.notify
         )
 
-        # 4. trigger workflow
         if args.translate:
             translate_workflow(global_config)
+            sys.exit(0)
 
-        elif args.cloze:
+        if args.cloze:
             cloze_workflow(global_config, raw_anki_data)
+            sys.exit(0)
+
+        if args.undo:
+            url = raw_anki_data.get("default", {}).get("url", "http://localhost:8765")
+            undo_workflow(url, global_config.enable_notifications)
+            sys.exit(0)
 
     except KeyboardInterrupt:
         notify(

{wordflow_cli-0.1.4 → wordflow_cli-0.1.6}/src/wordflow/configuration.py

@@ -138,7 +138,7 @@ def resolve_anki_config(
     anki_override_fields = anki_override.get("fields", {})
 
     anki_config = AnkiConfig(
-        url=anki_override.get("url", anki_defaults.get("url")),
+        url=anki_override.get("url", anki_defaults.get("url", "http://localhost:8765")),
         deck=anki_override.get(
             "deck", anki_defaults.get("deck", "Wordflow::{source_language}")
         ).replace("{source_language}", str(active_language)),

{wordflow_cli-0.1.4 → wordflow_cli-0.1.6}/src/wordflow/translator.py

@@ -93,8 +93,8 @@ def translate(
                 examples=data.get("examples"),
             )
             # DEBUG
-            print("json data: ", response.json())
-            print("translation data: ", translation_data)
+            # print("json data: ", response.json())
+            # print("translation data: ", translation_data)
             return translation_data
 
         except requests.RequestException as e:

{wordflow_cli-0.1.4 → wordflow_cli-0.1.6}/src/wordflow/workflows.py

@@ -1,11 +1,41 @@
+import os
+import tempfile
+
 from .clipboard import get_text, ClipboardError, TimeOutError
 from .translator import translate, TranslationError
 from .notifications import notify
-from .anki_flashcard import AnkiConnectError, DuplicateNoteError, make_cloze
+from .anki_flashcard import (
+    AnkiConnectError,
+    DuplicateNoteError,
+    make_cloze,
+    delete_note,
+)
 from .my_classes import TranslationData, AnkiConfig, GlobalConfig
 from .configuration import resolve_anki_config
 
 
+CACHE_FILE = os.path.join(tempfile.gettempdir(), "wordflow_last_note.txt")
+
+
+def undo_workflow(anki_url, enable_notifications):
+    """tries to delete the last card created using wordflow"""
+    try:
+        with open(CACHE_FILE, "r") as f:
+            last_id = int(f.read().strip())
+            delete_note(anki_url, last_id)
+
+        # Clear the cache
+        os.remove(CACHE_FILE)
+        notify(
+            "Undo OK",
+            f"Successfully deleted the last created flashcard (ID: {last_id}).",
+            enable_notifications=enable_notifications,
+        )
+
+    except (FileNotFoundError, ValueError):
+        print("No recent flashcard found to undo.")
+
+
 def translate_workflow(global_config: GlobalConfig):
     """translates a word or sentence and outputs it in a clickable notification"""
     try:
@@ -59,7 +89,10 @@ def cloze_workflow(
     global_config: GlobalConfig,
     raw_anki_data: dict,
 ):
-    """creates an anki cloze flashcard from clipboard, automatically detecting correct language settings"""
+    """
+    creates an anki cloze flashcard from clipboard, automatically detecting correct language settings
+    writes the id of the resulting card in a temp file
+    """
     try:
         # 1. Get sentence
         original_sentence = get_text()
@@ -88,14 +121,19 @@ def cloze_workflow(
         resolved_anki_config = resolve_anki_config(
             raw_anki_data, sentence_translation_data.source_language
         )
-        #
+
         # 5. Make the cloze card and send it to anki
-        make_cloze(
+        note_id = make_cloze(
             anki_config=resolved_anki_config,
             sentence_data=sentence_translation_data,
             word_data=word_translation_data,
         )
-        # 5. Notify success
+
+        # 6. write note id in temp file (for potential undo)
+        with open(CACHE_FILE, "w") as f:
+            f.write(str(note_id))
+
+        # 7. Notify success
         notify(
             "Anki Success",
             f"Cloze card created for: '{word_to_cloze}' in {resolved_anki_config.deck}",

{wordflow_cli-0.1.4 → wordflow_cli-0.1.6}/src/wordflow_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wordflow-cli
-Version: 0.1.4
+Version: 0.1.6
 Summary: Automate Anki flashcard creation and text translation directly from your clipboard.
 Author-email: Mathéo Tritschler <tritschler.matheo@gmail.com>
 License: MIT
@@ -19,15 +19,6 @@ Requires-Dist: requests>=2.28.0
 Requires-Dist: tomli-w>=1.0.0
 Dynamic: license-file
 
-$$\      $$\                           $$\       $$$$$$$$\ $$\                         
-$$ | $\  $$ |                          $$ |      $$  _____|$$ |                        
-$$ |$$$\ $$ | $$$$$$\   $$$$$$\   $$$$$$$ |      $$ |      $$ | $$$$$$\  $$\  $$\  $$\ 
-$$ $$ $$\$$ |$$  __$$\ $$  __$$\ $$  __$$ |      $$$$$\    $$ |$$  __$$\ $$ | $$ | $$ |
-$$$$  _$$$$ |$$ /  $$ |$$ |  \__|$$ /  $$ |      $$  __|   $$ |$$ /  $$ |$$ | $$ | $$ |
-$$$  / \$$$ |$$ |  $$ |$$ |      $$ |  $$ |      $$ |      $$ |$$ |  $$ |$$ | $$ | $$ |
-$$  /   \$$ |\$$$$$$  |$$ |      \$$$$$$$ |      $$ |      $$ |\$$$$$$  |\$$$$$\$$$$  |
-\__/     \__| \______/ \__|       \_______|      \__|      \__| \______/  \_____\____/ 
-
 # Wordflow
 
 A lightning-fast, dependency-free, keyboard-driven language acquisition tool for Linux.
@@ -163,12 +154,16 @@ Wordflow automatically routes audio to native speakers of the detected language.
 ## Instant Translation (-t)
 
   Highlight any text on your screen and trigger the wordflow --translate command. Wordflow detects the language, translates it, and sends a desktop notification. Clicking the notification copies the translation to your clipboard.
+
 ## Cloze Card Creation (-c)
 
   To create a flashcard, highlight the target word/sentence and trigger wordflow --cloze. Wordflow will parse all dictionary data, build the card according to your TOML layout, and push it directly to Anki.
 
 Use wordflow --help to list all command-line arguments.
 
+## Undo Last Card (-u / --undo)
+
+If you accidentally create a card with a typo or the wrong highlighted text, simply trigger the `wordflow --undo` command. Wordflow remembers the ID of the last flashcard it generated and will instantly delete it from your Anki database.
 # ⌨️ Creating Shortcuts
 
 Wordflow is designed to be bound to your window manager's shortcuts, allowing you to seamlessly translate and capture vocabulary without losing focus on your current task.
@@ -186,6 +181,11 @@ Wordflow is designed to be bound to your window manager's shortcuts, allowing yo
         hl.dispatch(hl.dsp.submap("reset"))
         hl.dispatch(hl.dsp.exec_cmd("wordflow -c"))
       end)
+      --u : Undo last card
+      hl.bind("U", function()
+        hl.dispatch(hl.dsp.submap("reset"))
+        hl.dispatch(hl.dsp.exec_cmd("wordflow -u"))
+      end)
 
       hl.bind("catchall", hl.dsp.submap("reset"))
     end)
@@ -193,3 +193,4 @@ Wordflow is designed to be bound to your window manager's shortcuts, allowing yo
 ## Sway / i3 Example
     bindsym Mod4+t exec "wordflow -t"
     bindsym Mod4+c exec "wordflow -c"
+    bindsym Mod4+u exec "wordflow -u"