improve qownnotes compatibility

see pbek/QOwnNotes#3133

- allow for separate folders for images and other attachments
- allow generating front matter with space separated tags

Author: marph91

docs/import_instructions.md

@@ -31,9 +31,14 @@ Markdown files can be imported to Obsidian as described [on the website](https:/
 
 ## QOwnNotes
 
-1. Use the argument `--local-resource-folder media`. This is not required, but aligns with the internal structure of QOwnNotes.
-2. Copy the root folder to you note folder or open it as a new note folder.
-3. Enable subfolders by `Note -> Settings -> Use note subfolders`.
+1. Use the arguments `--local-resource-folder attachments --local-image-folder media`. This is not required, but aligns with the internal structure of QOwnNotes.
+2. Copy the root folder to your note folder or open it as a new note folder.
+3. If you have subfolders, enable `Note -> Settings -> Use note subfolders`.
+4. If you want to convert tags:
+    1. Use the argument `--frontmatter qownnotes`
+    2. Detect the front matter tags by installing the [epsilon-notes-tags](https://github.com/qownnotes/scripts/tree/master/epsilon-notes-tags) or [`yaml-nested-tags`](https://github.com/qownnotes/scripts/tree/master/yaml-nested-tags) plugin.
+
+A complete command could look like `jimmy-cli-linux takeout.zip --format google_keep --frontmatter qownnotes --local-resource-folder attachments --local-image-folder media`.
 
 ## Notion
 

src/importer.py

@@ -140,11 +140,18 @@ def __init__(self, progress_bars, config):
             if config.local_resource_folder == Path(".")
             else Path(safe_path(config.local_resource_folder))
         )
+        self.local_image_folder = (
+            None
+            if config.local_image_folder is None
+            else Path(safe_path(config.local_image_folder))
+        )
         # reference id - path (new id)
         self.note_id_map: dict[str, Path] = {}
         self.progress_bars = progress_bars
 
     def import_resources(self, note: imf.Note):
+        # pylint: disable=too-many-branches
+        # TODO
         assert note.path is not None
         assert self.root_path is not None
         for resource in note.resources:
@@ -153,12 +160,16 @@ def import_resources(self, note: imf.Note):
 
             # determine new resource path
             if self.global_resource_folder is None:
+                if self.local_image_folder is not None and resource.is_image:
+                    target_folder = self.local_image_folder
+                else:
+                    target_folder = self.local_resource_folder
                 # local resources (next to the markdown files)
-                resource_folder = note.path.parent / self.local_resource_folder
+                resource_folder = note.path.parent / target_folder
                 # TODO: done for each resource in each note
-                if self.local_resource_folder != Path("."):
+                if target_folder != Path("."):
                     resource_folder.mkdir(
-                        exist_ok=True, parents=len(self.local_resource_folder.parts) > 1
+                        exist_ok=True, parents=len(target_folder.parts) > 1
                     )
                 resource.path = resource_folder / safe_path(resource.filename.name)
             else:
@@ -255,6 +266,17 @@ def write_note(self, note: imf.Note):
                     frontmatter.dump(post, note.path)
                 else:
                     note.path.write_text(note.body, encoding="utf-8")
+            case "qownnotes":
+                # space separated tags, as supported by:
+                # - https://github.com/qownnotes/scripts/tree/master/epsilon-notes-tags
+                # - https://github.com/qownnotes/scripts/tree/master/yaml-nested-tags
+                if note.tags:
+                    post = frontmatter.Post(
+                        note.body, tags=" ".join([tag.title for tag in note.tags])
+                    )
+                    frontmatter.dump(post, note.path)
+                else:
+                    note.path.write_text(note.body, encoding="utf-8")
             case _:
                 note.path.write_text(note.body, encoding="utf-8")
 

src/jimmy_cli.py

@@ -12,7 +12,7 @@
 LOGGER = logging.getLogger("jimmy")
 
 
-def relative_path(path: str | Path) -> Path:
+def relative_path(path: str | Path | None) -> Path | None:
     """
     Checks if a path is relative.
 
@@ -31,6 +31,8 @@ def relative_path(path: str | Path) -> Path:
     >>> str(relative_path("./a"))
     'a'
     """
+    if path is None:
+        return None
     # https://stackoverflow.com/a/37472037
     path_to_check = Path(path)
     if path_to_check.is_absolute():
@@ -59,7 +61,7 @@ def main():
     parser.add_argument(
         "--frontmatter",
         default=None,
-        choices=(None, "all", "joplin", "obsidian"),
+        choices=(None, "all", "joplin", "obsidian", "qownnotes"),
         help="Frontmatter type.",
     )
     parser.add_argument(
@@ -80,6 +82,13 @@ def main():
         "Relative to the location of the corresponding note.",
         default=Path("."),  # next to the note
     )
+    parser.add_argument(
+        "--local-image-folder",
+        type=relative_path,
+        help="The folder for images. Works only together with "
+        "--local-resource-folder. "
+        "Relative to the location of the corresponding note.",
+    )
     parser.add_argument(
         "--print-tree",
         action="store_true",

test/data

@@ -30,6 +30,7 @@ def setUp(self):
             frontmatter=None,
             global_resource_folder=None,
             local_resource_folder=Path("."),
+            local_image_folder=None,
             print_tree=False,
             exclude_notes=None,
             exclude_notes_with_tags=None,
@@ -222,37 +223,48 @@ def test_frontmatter(self, frontmatter):
 
     @parameterized.expand(
         [
-            ["global_resource_folder", Path("images")],
-            ["global_resource_folder", Path("ima:ges")],  # forbidden char
-            ["global_resource_folder", Path("../images")],  # outside root dir
-            ["local_resource_folder", Path(".")],  # default
-            ["local_resource_folder", Path("images")],
-            ["local_resource_folder", Path("ima:ges")],  # forbidden char
+            ["global", {"global_resource_folder": Path("res")}],
+            [
+                "global_forbidden",
+                {"global_resource_folder": Path("r:es")},
+            ],
+            [
+                "global_outside",
+                {"global_resource_folder": Path("../res")},
+            ],
+            ["local_default", {"local_resource_folder": Path(".")}],  # default
+            ["local", {"local_resource_folder": Path("res")}],
+            [
+                "local_forbidden",
+                {"local_resource_folder": Path("re:s")},
+            ],
+            [
+                "local_splitted",
+                {
+                    "local_resource_folder": Path("attachments"),
+                    "local_image_folder": Path("media"),
+                },
+            ],
         ]
     )
-    def test_attachment_folder(self, folder_option, value):
+    def test_attachment_folder(self, name, folder_options):
         """Test the attachment folders."""
 
-        test_data = [Path("test/data/test_data/joplin/test_1/29_04_2024.jex")]
-        value_safe = str(value).replace("/", "_").replace(".", "_").replace(":", "_")
-        test_data_output = (
-            Path("tmp_output/attachment_folder") / f"{folder_option}_{value_safe}"
-        )
+        test_data = [Path("test/data/test_data/obsidian/test_1")]
+        test_data_output = Path(f"tmp_output/attachment_folder/{name}")
         shutil.rmtree(test_data_output, ignore_errors=True)
         # separate folder for each input
-        reference_data = (
-            Path("test/data/reference_data/attachment_folder")
-            / f"{folder_option}_{value_safe}"
-        )
+        reference_data = Path(f"test/data/reference_data/attachment_folder/{name}")
 
         self.config.input = test_data
-        self.config.format = "joplin"
+        self.config.format = "obsidian"
         self.config.output_folder = test_data_output
-        setattr(self.config, folder_option, value)
+        for option, value in folder_options.items():
+            setattr(self.config, option, value)
         jimmy.jimmy(self.config)
 
         self.assert_dir_trees_equal(test_data_output, reference_data)
-        if folder_option == "global_resource_folder" and str(value).startswith(".."):
+        if name == "global_outside":
             # outside root dir -> verify separately
             self.assert_dir_trees_equal(
                 test_data_output / value, reference_data / value