Merge pull request #53 from Pseudonium/develop

Automation update

Author: Pseudonium

README.md

@@ -50,7 +50,8 @@ The script needs to be able to:
 
 ## Usage
 
-**Apart from editing the config file, all operations of the script require Anki to be running.**
+**Apart from editing the config file, all operations of the script require Anki to be running.**  
+New in v2.7.0 - if you supply Anki Path and Anki Profile, the script will automatically attempt to open Anki if it isn't already running.  
 
 The GUI of the script looks like this:  
 ![GUI](Images/GUI.png)
@@ -91,6 +92,8 @@ Allows you to change the default deck and tag of the script.
 New in v2.2.2 - allows you to enable/disable the 'CurlyCloze' option, which is explained in [Cloze formatting](#cloze-formatting)  
 New in v2.4.0 - allows you to enable/disable the GUI of the script - see [Command line usage](#command-line-usage).  
 New in v2.5.0 - allows you to enable/disable IDs being embedded in HTML comments. The script can read IDs whether or not they are in a HTML comment.  
+New in v2.5.0 - allows you to have regex mode on by default.  
+New in v2.7.0 - Anki Path and Anki Profile. If you supply both the absolute path to the Anki executable, and your profile on Anki, the script will attempt to open Anki when run if it's not already running. Useful for automation - see [Technical](#technical)
 
 ### Syntax
 Note that START, END, TARGET DECK, FILE TAGS and DELETE all require an **exact match** on the line - you cannot have spaces afterwards.
@@ -364,3 +367,15 @@ You may also want to prepend the following shebang to the start of the file:
 `#!/usr/bin/env python`
 
 For more information, see [this pull request](https://github.com/Pseudonium/Obsidian_to_Anki/pull/13).
+
+New in v2.7.0 - the script can now automatically open Anki if Anki Path and Anki Profile are supplied. This would allow you to schedule the script to run at a certain time without needing to worry about whether Anki was open at that time.
+
+Note that the script will never close Anki by itself, so you may find Anki open when you return to your computer!
+
+### Scheduling
+
+On Windows, check out [Task Scheduler](https://www.windowscentral.com/how-create-automated-task-using-task-scheduler-windows-10).
+
+On macOS/Linux, check out Corey Schafer's excellent tutorial on [cron](https://www.windowscentral.com/how-create-automated-task-using-task-scheduler-windows-10).
+
+As an example, you could schedule the script to run recursively over your top-level notes folder, at midnight every day.

obsidian_to_anki.py

@@ -11,6 +11,9 @@
 import base64
 import argparse
 import html
+import time
+import socket
+import subprocess
 try:
     import gooey
     GOOEY = True
@@ -52,6 +55,8 @@
     extensions=['extra', 'nl2br', 'sane_lists']
 )
 
+ANKI_PORT = 8765
+
 
 def write_safe(filename, contents):
     """
@@ -118,6 +123,66 @@ def findignore(pattern, string, ignore_spans):
     )
 
 
+def wait_for_port(port, host='localhost', timeout=5.0):
+    """Wait until a port starts accepting TCP connections.
+    Args:
+        port (int): Port number.
+        host (str): Host address on which the port should exist.
+        timeout (float): In seconds. How long to wait before raising errors.
+    Raises:
+        TimeoutError: The port isn't accepting connection after time specified
+        in `timeout`.
+    """
+    start_time = time.perf_counter()
+    while True:
+        try:
+            with socket.create_connection((host, port), timeout=timeout):
+                break
+        except OSError as ex:
+            time.sleep(0.01)
+            if time.perf_counter() - start_time >= timeout:
+                raise TimeoutError(
+                    'Waited too long for the port {} on host {} to'
+                    'start accepting connections.'.format(port, host)
+                ) from ex
+
+
+def load_anki():
+    """Attempt to load anki in the correct profile."""
+    try:
+        Config.load_config()
+    except Exception as e:
+        print("Error when loading config:", e)
+        print("Please open Anki before running script again.")
+        return False
+    if CONFIG_DATA["Path"] and CONFIG_DATA["Profile"]:
+        print("Anki Path and Anki Profile provided.")
+        print("Attempting to open Anki in selected profile...")
+        subprocess.Popen(
+            [CONFIG_DATA["Path"], "-p", CONFIG_DATA["Profile"]]
+        )
+        try:
+            wait_for_port(ANKI_PORT)
+        except TimeoutError:
+            print("Opened Anki, but can't connect! Is AnkiConnect working?")
+            return False
+        else:
+            print("Opened and connected to Anki successfully!")
+            return True
+    else:
+        print(
+            "Must provide both Anki Path and Anki Profile",
+            "in order to open Anki automatically"
+        )
+
+
+def main():
+    """Main functionality of script."""
+    if not os.path.exists(CONFIG_PATH):
+        Config.update_config()
+    App()
+
+
 class AnkiConnect:
     """Namespace for AnkiConnect functions."""
 
@@ -626,6 +691,12 @@ def update_config():
         config["Defaults"].setdefault(
             "ID Comments", "True"
         )
+        config["Defaults"].setdefault(
+            "Anki Path", ""
+        )
+        config["Defaults"].setdefault(
+            "Anki Profile", ""
+        )
         # Setting up Custom Regexps
         config.setdefault("Custom Regexps", dict())
         for note in note_types:
@@ -693,6 +764,8 @@ def load_config():
         CONFIG_DATA["Comment"] = config.getboolean(
             "Defaults", "ID Comments"
         )
+        CONFIG_DATA["Path"] = config["Defaults"]["Anki Path"]
+        CONFIG_DATA["Profile"] = config["Defaults"]["Anki Profile"]
         Config.config = config  # Can access later if need be
         print("Loaded successfully!")
 
@@ -1408,6 +1481,13 @@ def requests_2(self):
 
 
 if __name__ == "__main__":
-    if not os.path.exists(CONFIG_PATH):
-        Config.update_config()
-    App()
+    print("Attempting to connect to Anki...")
+    try:
+        wait_for_port(ANKI_PORT)
+    except TimeoutError:
+        print("Couldn't connect to Anki, attempting to open Anki...")
+        if load_anki():
+            main()
+    else:
+        print("Connected!")
+        main()

obsidian_to_anki_config.ini

@@ -42,6 +42,8 @@ CurlyCloze = False
 GUI = True
 Regex = False
 ID Comments = True
+Anki Path =
+Anki Profile = 
 
 [Custom Regexps]
 Basic = ^Q: ((?:[^\n][\n]?)+)\n+A: ((?:[^\n][\n]?)+)